InstanceConsoleConnection

class oci.core.models.InstanceConsoleConnection(**kwargs)

Bases: object

The InstanceConsoleConnection API provides you with console access to virtual machine (VM) instances, enabling you to troubleshoot malfunctioning instances remotely.

For more information about console access, see Accessing the Console.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a InstanceConsoleConnection. This constant has a value of "ACTIVE"

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a InstanceConsoleConnection. This constant has a value of "CREATING"

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a InstanceConsoleConnection. This constant has a value of "DELETED"

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a InstanceConsoleConnection. This constant has a value of "DELETING"

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a InstanceConsoleConnection. This constant has a value of "FAILED"

__init__(**kwargs)

Initializes a new InstanceConsoleConnection object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:
  • compartment_id (str) -- The value to assign to the compartment_id property of this InstanceConsoleConnection.
  • connection_string (str) -- The value to assign to the connection_string property of this InstanceConsoleConnection.
  • defined_tags (dict(str, dict(str, object))) -- The value to assign to the defined_tags property of this InstanceConsoleConnection.
  • fingerprint (str) -- The value to assign to the fingerprint property of this InstanceConsoleConnection.
  • freeform_tags (dict(str, str)) -- The value to assign to the freeform_tags property of this InstanceConsoleConnection.
  • id (str) -- The value to assign to the id property of this InstanceConsoleConnection.
  • instance_id (str) -- The value to assign to the instance_id property of this InstanceConsoleConnection.
  • lifecycle_state (str) -- The value to assign to the lifecycle_state property of this InstanceConsoleConnection. Allowed values for this property are: "ACTIVE", "CREATING", "DELETED", "DELETING", "FAILED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
  • vnc_connection_string (str) -- The value to assign to the vnc_connection_string property of this InstanceConsoleConnection.
compartment_id

Gets the compartment_id of this InstanceConsoleConnection. The OCID of the compartment to contain the console connection.

Returns:The compartment_id of this InstanceConsoleConnection.
Return type:str
connection_string

Gets the connection_string of this InstanceConsoleConnection. The SSH connection string for the console connection.

Returns:The connection_string of this InstanceConsoleConnection.
Return type:str
defined_tags

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

Example: {"Operations": {"CostCenter": "42"}}

Returns:The defined_tags of this InstanceConsoleConnection.
Return type:dict(str, dict(str, object))
fingerprint

Gets the fingerprint of this InstanceConsoleConnection. The SSH public key fingerprint for the console connection.

Returns:The fingerprint of this InstanceConsoleConnection.
Return type:str
freeform_tags

Gets the freeform_tags of this InstanceConsoleConnection. 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: {"Department": "Finance"}

Returns:The freeform_tags of this InstanceConsoleConnection.
Return type:dict(str, str)
id

Gets the id of this InstanceConsoleConnection. The OCID of the console connection.

Returns:The id of this InstanceConsoleConnection.
Return type:str
instance_id

Gets the instance_id of this InstanceConsoleConnection. The OCID of the instance the console connection connects to.

Returns:The instance_id of this InstanceConsoleConnection.
Return type:str
lifecycle_state

Gets the lifecycle_state of this InstanceConsoleConnection. The current state of the console connection.

Allowed values for this property are: "ACTIVE", "CREATING", "DELETED", "DELETING", "FAILED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.

Returns:The lifecycle_state of this InstanceConsoleConnection.
Return type:str
vnc_connection_string

Gets the vnc_connection_string of this InstanceConsoleConnection. The SSH connection string for the SSH tunnel used to connect to the console connection over VNC.

Returns:The vnc_connection_string of this InstanceConsoleConnection.
Return type:str