oci_instance_console_connection – Manage Instance Console Connections in OCI¶

New in version 2.5.

Synopsis
Requirements
Parameters
Notes
Examples
Return Values
Status

Synopsis ¶

This module allows the user to create and delete an Instance Console Connection in OCI.

Requirements ¶

The below requirements are needed on the host that executes this module.

python >= 2.7
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io

Parameters ¶

Parameter	Choices/Defaults	Comments
api_user string		The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_OCID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See `config_file_location`). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_fingerprint string		Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See `config_file_location`). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_key_file string		Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See `config_file_location`). If the key is encrypted with a pass-phrase, the `api_user_key_pass_phrase` option must also be provided.
api_user_key_pass_phrase string		Passphrase used by the key referenced in `api_user_key_file`, if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See `config_file_location`).
auth_type string	Choices: api_key ← instance_principal	The type of authentication to use for making API requests. By default `auth_type="api_key"` based authentication is performed and the API key (see api_user_key_file) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use `auth_type="instance_principal"` to use instance principal based authentication when running ansible playbooks within an OCI compute instance.
config_file_location string		Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config.
config_profile_name string		The profile to load from the config file referenced by `config_file_location`. If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in `config_file_location`.
defined_tags dictionary		Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm.
force_create boolean	Choices: no ← yes	Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with key_by.
freeform_tags dictionary		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 https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm.
instance_console_connection_id -		The OCID of the instance console connection. Required to delete an instance console connection. aliases: id
instance_id -		The OCID of the instance to create the console connection to. Required to create an instance console connection.
key_by list		The list of comma-separated attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource except freeform_tags are used to uniquely identify a resource.
public_key -		The SSH public key used to authenticate the console connection. Required to create an instance console connection.
region string		The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See `config_file_location`). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions.
state -	Choices: present ← absent	Create an instance console connection with state=present. Use state=absent to delete an instance console connection.
tenancy string		OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See `config_file_location`). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm
wait boolean	Choices: no yes ←	Whether to wait for create or delete operation to complete.
wait_timeout integer	Default: 1200	Time, in seconds, to wait when wait=yes.
wait_until string		The lifecycle state to wait for the resource to transition into when wait=yes. By default, when wait=yes, we wait for the resource to get into ACTIVE/ATTACHED/AVAILABLE/PROVISIONED/ RUNNING applicable lifecycle state during create operation & to get into DELETED/DETACHED/ TERMINATED lifecycle state during delete operation.

Notes ¶

Note

For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html

Examples ¶

- name: Create an instance console connection
  oci_instance_console_connection:
    instance_id: ocid1.instance.oc1.phx.xxxxxEXAMPLExxxxx...lxiggdq
    public_key: "/tmp/id_rsa.pub"

- name: Delete an instance console connection
  oci_instance_console_connection:
    id: ocid1.instanceconsoleconnection.oc1.phx.xxxxxEXAMPLExxxxx...rz3fhq
    state: absent

Return Values ¶

Common return values are documented here, the following are the fields unique to this module:

Key		Returned	Description
instance_console_connection complex		On successful create, delete operations on instance console connections	Information about the Instance Console Connection Sample: {'lifecycle-state': 'ACTIVE', 'compartment_id': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx', 'defined-tags': {}, 'vnc-connection-string': "ssh -o ProxyCommand='ssh -W %h:%p -p 443 ocid1.instanceconsoleconnection.oc1.iad.xxxxxEXAMPLExxxxx...z3fhq@ instance-console.us-ashburn-1.oraclecloud.com' -N -L localhost:5900: ocid1.instance.oc1.iad.xxxxxEXAMPLExxxxx...whsma:5900 ocid1.instance.oc1.iad.xxxxxEXAMPLExxxxx...whsma", 'fingerprint': 'SHA256:DlBfSLjZMvFPlOKOfN403dSSn/ywiW905oKfZvpD37Q', 'freeform-tags': {}, 'connection-string': "ssh -o ProxyCommand='ssh -W %h:%p -p 443 ocid1.instanceconsoleconnection.oc1.iad.xxxxxEXAMPLExxxxx...3fhq@ instance-console.us-ashburn-1.oraclecloud.com' ocid1.instance.oc1.iad.xxxxxEXAMPLExxxxx...whsma", 'id': 'ocid1.instanceconsoleconnection.oc1.iad.xxxxxEXAMPLExxxxx...3fhq', 'instance-id': 'ocid1.instance.oc1.iad.xxxxxEXAMPLExxxxx...hsma'}
	compartment_id string	always	The OCID of the compartment to contain the console connection. Sample: ocid1.compartment.oc1..xxxxxEXAMPLExxxxx
	connection_string string	always	The SSH connection string for the console connection. Sample: ssh -o ProxyCommand='ssh -W %h:%p -p 443 ocid1.instanceconsoleconnection.oc1.iad.xxxxxEXAMPLExxxxxxenxq@ instance-console.us-ashburn-1.oraclecloud.com' ocid1.instance.oc1.iad.xxxxxEXAMPLExxxxxx...2ema
	fingerprint string	always	The SSH public key fingerprint for the console connection. Sample: d2:ac:ff:31:9c:23:79:9c:41:ba:a7:ab:e2:a6:8e:76
	id string	always	The OCID of the console connection. Sample: ocid1.instanceconsoleconnection.oc1.phx.xxxxxEXAMPLExxxxx...rz3fhq
	instance_id string	always	The OCID of the instance the console connection connects to. Sample: ocid1.instance.oc1.phx.xxxxxEXAMPLExxxxx...lxiggdq
	lifecycle_state string	always	The current state of the console connection. Sample: ACTIVE
	vnc_connection_string string	always	The SSH connection string for the SSH tunnel used to connect to the console connection over VNC. Sample: ssh -o ProxyCommand='ssh -W %h:%p -p 443 ocid1.instanceconsoleconnection.oc1.iad.xxxxxEXAMPLExxxxx...iwenxq@ instance-console.us-ashburn-1.oraclecloud.com' -N -L localhost:5900:ocid1.instance.oc1.iad.xxxxxEXAMPLExxxxx...2ema:5900 ocid1.instance.oc1.iad.xxxxxEXAMPLExxxxx...2ema

Status ¶

This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by the Ansible Community. [community]

Authors¶

Sivakumar Thyagarajan (@sivakumart)

Hint

If you notice any issues in this documentation you can edit this document to improve it.

oci_instance_console_connection – Manage Instance Console Connections in OCI¶

Synopsis¶

Requirements¶

Parameters¶

Notes¶

Examples¶

Return Values¶

Status¶