oracle.oci.oci_bastion_session – Manage a Session resource in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.10.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install oracle.oci.

To use it in a playbook, specify: oracle.oci.oci_bastion_session.

New in version 2.9.0: of oracle.oci

Synopsis

  • This module allows the user to create, update and delete a Session resource in Oracle Cloud Infrastructure

  • For state=present, creates a new session in a bastion. A bastion session lets authorized users connect to a target resource for a predetermined amount of time. The Bastion service recognizes two types of sessions, managed SSH sessions and SSH port forwarding sessions. Managed SSH sessions require that the target resource has an OpenSSH server and the Oracle Cloud Agent both running.

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_ID 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_purpose
string
    Choices:
  • service_principal
The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
auth_type
string
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
  • resource_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.
bastion_id
string
The unique identifier (OCID) of the bastion on which to create this session.
Required for create using state=present.
Required for update when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
Required for delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
cert_bundle
string
The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used.
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.
display_name
string
The name of the session.
Required for create, update, delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
This parameter is updatable when OCI_USE_NAME_AS_IDENTIFIER is not set.

aliases: name
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.
key_by
list / elements=string
The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource.
key_details
dictionary
Required for create using state=present.
public_key_content
string / required
The public key in OpenSSH format of the SSH key pair for the session. When you connect to the session, you must provide the private key of the same SSH key pair.
key_type
string
    Choices:
  • PUB
The type of the key used to connect to the session. PUB is a standard public key in OpenSSH format.
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.
session_id
string
The unique identifier (OCID) of the session.
Required for update using state=present when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.
Required for delete using state=absent when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.

aliases: id
session_ttl_in_seconds
integer
The amount of time the session can remain active.
state
string
    Choices:
  • present ←
  • absent
The state of the Session.
Use state=present to create or update a Session.
Use state=absent to delete a Session.
target_resource_details
dictionary
Required for create using state=present.
session_type
string / required
    Choices:
  • MANAGED_SSH
  • DYNAMIC_PORT_FORWARDING
  • PORT_FORWARDING
The session type.
target_resource_fqdn
string
The Fully Qualified Domain Name of the target resource that the session connects to.
Applicable when session_type is 'PORT_FORWARDING'
target_resource_id
string
The unique identifier (OCID) of the target resource (a Compute instance, for example) that the session connects to.
Applicable when session_type is 'PORT_FORWARDING'
Required when session_type is 'MANAGED_SSH'
target_resource_operating_system_user_name
string
The name of the user on the target resource operating system that the session uses for the connection.
Required when session_type is 'MANAGED_SSH'
target_resource_port
integer
The port number to connect to on the target resource.
Applicable when session_type is one of ['MANAGED_SSH', 'PORT_FORWARDING']
target_resource_private_ip_address
string
The private IP address of the target resource that the session connects to.
Applicable when session_type is one of ['MANAGED_SSH', 'PORT_FORWARDING']
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
Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.

Examples

- name: Create session
  oci_bastion_session:
    # required
    bastion_id: "ocid1.bastion.oc1..xxxxxxEXAMPLExxxxxx"
    target_resource_details:
      # required
      target_resource_operating_system_user_name: target_resource_operating_system_user_name_example
      session_type: MANAGED_SSH
      target_resource_id: "ocid1.targetresource.oc1..xxxxxxEXAMPLExxxxxx"

      # optional
      target_resource_private_ip_address: target_resource_private_ip_address_example
      target_resource_port: 56
    key_details:
      # required
      public_key_content: public_key_content_example

    # optional
    key_type: PUB
    session_ttl_in_seconds: 56
    display_name: display_name_example

- name: Update session
  oci_bastion_session:
    # required
    session_id: "ocid1.session.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    display_name: display_name_example

- name: Update session using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_bastion_session:
    # required
    bastion_id: "ocid1.bastion.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example

- name: Delete session
  oci_bastion_session:
    # required
    session_id: "ocid1.session.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

- name: Delete session using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_bastion_session:
    # required
    bastion_id: "ocid1.bastion.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example
    state: absent

Return Values

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

Key Returned Description
session
complex
on success
Details of the Session resource acted upon by the current operation

Sample:
{'bastion_id': 'ocid1.bastion.oc1..xxxxxxEXAMPLExxxxxx', 'bastion_name': 'bastion_name_example', 'bastion_public_host_key_info': 'bastion_public_host_key_info_example', 'bastion_user_name': 'bastion_user_name_example', 'display_name': 'display_name_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'key_details': {'public_key_content': 'public_key_content_example'}, 'key_type': 'PUB', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'session_ttl_in_seconds': 56, 'ssh_metadata': {}, 'target_resource_details': {'session_type': 'MANAGED_SSH', 'target_resource_display_name': 'target_resource_display_name_example', 'target_resource_fqdn': 'target_resource_fqdn_example', 'target_resource_id': 'ocid1.targetresource.oc1..xxxxxxEXAMPLExxxxxx', 'target_resource_operating_system_user_name': 'target_resource_operating_system_user_name_example', 'target_resource_port': 56, 'target_resource_private_ip_address': 'target_resource_private_ip_address_example'}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00'}
 
bastion_id
string
on success
The unique identifier (OCID) of the bastion that is hosting this session.

Sample:
ocid1.bastion.oc1..xxxxxxEXAMPLExxxxxx
 
bastion_name
string
on success
The name of the bastion that is hosting this session.

Sample:
bastion_name_example
 
bastion_public_host_key_info
string
on success
The public key of the bastion host. You can use this to verify that you're connecting to the correct bastion.

Sample:
bastion_public_host_key_info_example
 
bastion_user_name
string
on success
The username that the session uses to connect to the target resource.

Sample:
bastion_user_name_example
 
display_name
string
on success
The name of the session.

Sample:
display_name_example
 
id
string
on success
The unique identifier (OCID) of the session, which can't be changed after creation.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
key_details
complex
on success

   
public_key_content
string
on success
The public key in OpenSSH format of the SSH key pair for the session. When you connect to the session, you must provide the private key of the same SSH key pair.

Sample:
public_key_content_example
 
key_type
string
on success
The type of the key used to connect to the session. PUB is a standard public key in OpenSSH format.

Sample:
PUB
 
lifecycle_details
string
on success
A message describing the current session state in more detail.

Sample:
lifecycle_details_example
 
lifecycle_state
string
on success
The current state of the session.

Sample:
CREATING
 
session_ttl_in_seconds
integer
on success
The amount of time the session can remain active.

Sample:
56
 
ssh_metadata
dictionary
on success
The connection message for the session.

 
target_resource_details
complex
on success

   
session_type
string
on success
The Bastion service recognizes three types of sessions, managed SSH sessions, SSH port forwarding sessions, and Dynamic SSH port forwarding sessions. Managed SSH sessions require that the target resource has an OpenSSH server and the Oracle Cloud Agent both running.

Sample:
MANAGED_SSH
   
target_resource_display_name
string
on success
The display name of the target Compute instance that the session connects to.

Sample:
target_resource_display_name_example
   
target_resource_fqdn
string
on success
The Fully Qualified Domain Name of the target resource that the session connects to.

Sample:
target_resource_fqdn_example
   
target_resource_id
string
on success
The unique identifier (OCID) of the target resource (a Compute instance, for example) that the session connects to.

Sample:
ocid1.targetresource.oc1..xxxxxxEXAMPLExxxxxx
   
target_resource_operating_system_user_name
string
on success
The name of the user on the target resource operating system that the session uses for the connection.

Sample:
target_resource_operating_system_user_name_example
   
target_resource_port
integer
on success
The port number to connect to on the target resource.

Sample:
56
   
target_resource_private_ip_address
string
on success
The private IP address of the target resource that the session connects to.

Sample:
target_resource_private_ip_address_example
 
time_created
string
on success
The time the session was created. Format is defined by RFC3339. Example: `2020-01-25T21:10:29.600Z`

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
The time the session was updated. Format is defined by RFC3339. Example: `2020-01-25T21:10:29.600Z`

Sample:
2013-10-20T19:20:30+01:00


Authors

  • Oracle (@oracle)