ConsoleConnectionSummary¶

class oci.database.models.ConsoleConnectionSummary(**kwargs)¶

Bases: object

The InstanceConsoleConnection API provides you with console access to dbnode enabling you to troubleshoot malfunctioning dbnode.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a ConsoleConnectionSummary.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a ConsoleConnectionSummary.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a ConsoleConnectionSummary.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a ConsoleConnectionSummary.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a ConsoleConnectionSummary.
`compartment_id`	[Required] Gets the compartment_id of this ConsoleConnectionSummary.
`connection_string`	[Required] Gets the connection_string of this ConsoleConnectionSummary.
`db_node_id`	[Required] Gets the db_node_id of this ConsoleConnectionSummary.
`defined_tags`	Gets the defined_tags of this ConsoleConnectionSummary.
`fingerprint`	[Required] Gets the fingerprint of this ConsoleConnectionSummary.
`freeform_tags`	Gets the freeform_tags of this ConsoleConnectionSummary.
`id`	[Required] Gets the id of this ConsoleConnectionSummary.
`lifecycle_details`	Gets the lifecycle_details of this ConsoleConnectionSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this ConsoleConnectionSummary.
`service_host_key_fingerprint`	Gets the service_host_key_fingerprint of this ConsoleConnectionSummary.

Methods

__init__(**kwargs) Initializes a new ConsoleConnectionSummary object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a ConsoleConnectionSummary. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a ConsoleConnectionSummary. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a ConsoleConnectionSummary. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a ConsoleConnectionSummary. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a ConsoleConnectionSummary. This constant has a value of “FAILED”

__init__(**kwargs)¶

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

Parameters:

id (str) – The value to assign to the id property of this ConsoleConnectionSummary.
compartment_id (str) – The value to assign to the compartment_id property of this ConsoleConnectionSummary.
db_node_id (str) – The value to assign to the db_node_id property of this ConsoleConnectionSummary.
connection_string (str) – The value to assign to the connection_string property of this ConsoleConnectionSummary.
fingerprint (str) – The value to assign to the fingerprint property of this ConsoleConnectionSummary.
service_host_key_fingerprint (str) – The value to assign to the service_host_key_fingerprint property of this ConsoleConnectionSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ConsoleConnectionSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ConsoleConnectionSummary.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this ConsoleConnectionSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this ConsoleConnectionSummary. 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’.

compartment_id¶

[Required] Gets the compartment_id of this ConsoleConnectionSummary. The OCID of the compartment to contain the console connection.

Returns:	The compartment_id of this ConsoleConnectionSummary.
Return type:	str

connection_string¶

[Required] Gets the connection_string of this ConsoleConnectionSummary. The SSH connection string for the console connection.

Returns:	The connection_string of this ConsoleConnectionSummary.
Return type:	str

db_node_id¶

[Required] Gets the db_node_id of this ConsoleConnectionSummary. The OCID of the database node.

Returns:	The db_node_id of this ConsoleConnectionSummary.
Return type:	str

defined_tags¶

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

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

fingerprint¶

[Required] Gets the fingerprint of this ConsoleConnectionSummary. The SSH public key fingerprint for the console connection.

Returns:	The fingerprint of this ConsoleConnectionSummary.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this ConsoleConnectionSummary. 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 ConsoleConnectionSummary.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this ConsoleConnectionSummary. The OCID of the console connection.

Returns:	The id of this ConsoleConnectionSummary.
Return type:	str

lifecycle_details¶

Gets the lifecycle_details of this ConsoleConnectionSummary. Information about the current lifecycle state.

Returns:	The lifecycle_details of this ConsoleConnectionSummary.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this ConsoleConnectionSummary. 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 ConsoleConnectionSummary.
Return type:	str

service_host_key_fingerprint¶

Gets the service_host_key_fingerprint of this ConsoleConnectionSummary. The SSH public key’s fingerprint for the console connection service host.

Returns:	The service_host_key_fingerprint of this ConsoleConnectionSummary.
Return type:	str