console_connections

Creates, updates, deletes, gets or lists a console_connections resource.

Overview

Name	console_connections
Type	Resource
Id	oci.database.console_connections

Fields

The following fields are returned by SELECT queries:

get

The console connection information was retrieved.

Name	Datatype	Description
id	string	The OCID of the console connection.
compartmentId	string	The OCID of the compartment to contain the console connection.
connectionString	string	The SSH connection string for the console connection.
dbNodeId	string	The OCID of the database node.
fingerprint	string	The SSH public key fingerprint for the console connection.
lifecycleState	string	The current state of the console connection. (ACTIVE, CREATING, DELETED, DELETING, FAILED)

list

The InstanceConsoleConnection API provides you with console access to dbnode<br />enabling you to troubleshoot malfunctioning dbnode.<br />

Name	Datatype	Description
id	string	The OCID of the console connection.
compartmentId	string	The OCID of the compartment to contain the console connection.
connectionString	string	The SSH connection string for the console connection.
dbNodeId	string	The OCID of the database node.
fingerprint	string	The SSH public key fingerprint for the console connection.
lifecycleState	string	The current state of the console connection. (ACTIVE, CREATING, DELETED, DELETING, FAILED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	dbNodeId, consoleConnectionId, region		Gets the specified database node console connection's information.
list	select	dbNodeId, region		Lists the console connections for the specified database node.<br />
create	insert	dbNodeId, region, publicKey	opc-retry-token	Creates a new console connection to the specified database node.<br />After the console connection has been created and is available,<br />you connect to the console using SSH.<br />
delete	delete	dbNodeId, consoleConnectionId, region	if-match	Deletes the specified database node console connection.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
consoleConnectionId	string	The OCID of the console connection.
dbNodeId	string	The database node [OCID](/Content/General/Concepts/identifiers.htm).
region	string	OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION)
if-match	string	For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
opc-retry-token	string	A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

SELECT examples

get

Gets the specified database node console connection's information.

SELECT
id,
compartmentId,
connectionString,
dbNodeId,
fingerprint,
lifecycleState
FROM oci.database.console_connections
WHERE dbNodeId = '{{ dbNodeId }}' -- required
AND consoleConnectionId = '{{ consoleConnectionId }}' -- required
AND region = '{{ region }}' -- required
;

list

Lists the console connections for the specified database node.<br />

SELECT
id,
compartmentId,
connectionString,
dbNodeId,
fingerprint,
lifecycleState
FROM oci.database.console_connections
WHERE dbNodeId = '{{ dbNodeId }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples

create

Creates a new console connection to the specified database node.<br />After the console connection has been created and is available,<br />you connect to the console using SSH.<br />

INSERT INTO oci.database.console_connections (
publicKey,
dbNodeId,
region,
opc-retry-token
)
SELECT 
'{{ publicKey }}' /* required */,
'{{ dbNodeId }}',
'{{ region }}',
'{{ opc-retry-token }}'
RETURNING
id,
compartmentId,
connectionString,
dbNodeId,
fingerprint,
lifecycleState
;

Manifest

# Description fields are for documentation purposes
- name: console_connections
props:
  - name: dbNodeId
    value: "{{ dbNodeId }}"
    description: Required parameter for the console_connections resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the console_connections resource.
  - name: publicKey
    value: "{{ publicKey }}"
    description: |
      The SSH public key used to authenticate the console connection.
  - name: opc-retry-token
    value: "{{ opc-retry-token }}"
    description: A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). 
    description: A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). 

DELETE examples

delete

Deletes the specified database node console connection.

DELETE FROM oci.database.console_connections
WHERE dbNodeId = '{{ dbNodeId }}' --required
AND consoleConnectionId = '{{ consoleConnectionId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match }}'
;