oci_instance_console_connection_facts – Retrieve facts of instance_console_connections in Oracle Cloud Infrastructure

New in version 2.5.

Synopsis

  • This module retrieves information of a specified instance console connection or all instance console connections in the specified compartment.

Requirements

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

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.
compartment_id
-
The OCID of the compartment the resource belongs to. Use instance_console_connection_id to retrieve a specific instance console connection.
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.
instance_console_connection_id
-
OCID of the target instance console connection.

aliases: id
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.
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

Examples

- name: Get a list of instance_console_connections in the specified compartment
  oci_instance_console_connection_facts:
    compartment_id: ocid1.compartment.oc1..xxxxxEXAMPLExxxxx...abcd

- name: Gets details of a specific instance console connection using its OCID
  oci_instance_console_connection_facts:
    instance_console_connection_id: ocid1.instanceconsoleconnection.oc1.iad.xxxxxEXAMPLExxxxx...3fhq

Return Values

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

Key Returned Description
instance_console_connections
complex
always
List of instance console connection details

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...abcd
  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.xxxxxEXAMPLExxxxx...enxq@ instance-console.us-ashburn-1.oraclecloud.com' ocid1.instance.oc1.iad.xxxxxEXAMPLExxxxx...2ema
  fingerprint
list
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.