oracle.oci.oci_bastion – Manage a Bastion resource in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 5.3.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.

New in version 2.9.0: of oracle.oci

Synopsis

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

  • For state=present, creates a new bastion. A bastion provides secured, public access to target resources in the cloud that you cannot otherwise reach from the internet. A bastion resides in a public subnet and establishes the network infrastructure needed to connect a user to a target resource in a private subnet.

  • This resource has the following action operations in the oracle.oci.oci_bastion_actions module: change_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_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
  • security_token
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.
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
bastion_type
string
The type of bastion. Use `standard`.
Required for create using state=present.
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.
client_cidr_block_allow_list
list / elements=string
A list of address ranges in CIDR notation that you want to allow to connect to sessions hosted by this bastion.
This parameter is updatable.
compartment_id
string
The unique identifier (OCID) of the compartment where the bastion is located.
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.
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. Example: `{"foo-namespace": {"bar-key": "value"}}`
This parameter is updatable.
dns_proxy_status
string
    Choices:
  • DISABLED
  • ENABLED
The desired dns proxy status of the bastion.
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
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`
This parameter is updatable.
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.
max_session_ttl_in_seconds
integer
The maximum amount of time that any session on the bastion can remain active.
This parameter is updatable.
name
string
The name of the bastion, which can't be changed after creation.
Required for create, update, delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
phone_book_entry
string
The phonebook entry of the customer's team, which can't be changed after creation. Not applicable to `standard` bastions.
realm_specific_endpoint_template_enabled
boolean
    Choices:
  • no
  • yes
Enable/Disable realm specific endpoint template for service client. By Default, realm specific endpoint template is disabled. If not set, then the value of the OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used.
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
string
    Choices:
  • present ←
  • absent
The state of the Bastion.
Use state=present to create or update a Bastion.
Use state=absent to delete a Bastion.
static_jump_host_ip_addresses
list / elements=string
A list of IP addresses of the hosts that the bastion has access to. Not applicable to `standard` bastions.
This parameter is updatable.
target_subnet_id
string
The unique identifier (OCID) of the subnet that the bastion connects to.
Required for create using state=present.
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 bastion
  oci_bastion:
    # required
    bastion_type: bastion_type_example
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    target_subnet_id: "ocid1.targetsubnet.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    name: name_example
    phone_book_entry: phone_book_entry_example
    dns_proxy_status: DISABLED
    max_session_ttl_in_seconds: 56
    static_jump_host_ip_addresses: [ "static_jump_host_ip_addresses_example" ]
    client_cidr_block_allow_list: [ "client_cidr_block_allow_list_example" ]
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update bastion
  oci_bastion:
    # required
    bastion_id: "ocid1.bastion.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    max_session_ttl_in_seconds: 56
    static_jump_host_ip_addresses: [ "static_jump_host_ip_addresses_example" ]
    client_cidr_block_allow_list: [ "client_cidr_block_allow_list_example" ]
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update bastion using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_bastion:
    # required
    name: name_example
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    max_session_ttl_in_seconds: 56
    static_jump_host_ip_addresses: [ "static_jump_host_ip_addresses_example" ]
    client_cidr_block_allow_list: [ "client_cidr_block_allow_list_example" ]
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Delete bastion
  oci_bastion:
    # required
    bastion_id: "ocid1.bastion.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

- name: Delete bastion using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_bastion:
    # required
    name: name_example
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

Return Values

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

Key Returned Description
bastion
complex
on success
Details of the Bastion resource acted upon by the current operation

Sample:
{'bastion_type': 'bastion_type_example', 'client_cidr_block_allow_list': [], 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'dns_proxy_status': 'DISABLED', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'max_session_ttl_in_seconds': 56, 'max_sessions_allowed': 56, 'name': 'name_example', 'phone_book_entry': 'phone_book_entry_example', 'private_endpoint_ip_address': 'private_endpoint_ip_address_example', 'static_jump_host_ip_addresses': [], 'system_tags': {}, 'target_subnet_id': 'ocid1.targetsubnet.oc1..xxxxxxEXAMPLExxxxxx', 'target_vcn_id': 'ocid1.targetvcn.oc1..xxxxxxEXAMPLExxxxxx', 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00'}
 
bastion_type
string
on success
The type of bastion.

Sample:
bastion_type_example
 
client_cidr_block_allow_list
list / elements=string
on success
A list of address ranges in CIDR notation that you want to allow to connect to sessions hosted by this bastion.
 
compartment_id
string
on success
The unique identifier (OCID) of the compartment where the bastion is located.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
defined_tags
dictionary
on success
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`

Sample:
{'Operations': {'CostCenter': 'US'}}
 
dns_proxy_status
string
on success
The current dns proxy status of the bastion.

Sample:
DISABLED
 
freeform_tags
dictionary
on success
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`

Sample:
{'Department': 'Finance'}
 
id
string
on success
The unique identifier (OCID) of the bastion, which can't be changed after creation.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
lifecycle_details
string
on success
A message describing the current state in more detail.

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

Sample:
CREATING
 
max_session_ttl_in_seconds
integer
on success
The maximum amount of time that any session on the bastion can remain active.

Sample:
56
 
max_sessions_allowed
integer
on success
The maximum number of active sessions allowed on the bastion.

Sample:
56
 
name
string
on success
The name of the bastion, which can't be changed after creation.

Sample:
name_example
 
phone_book_entry
string
on success
The phonebook entry of the customer's team, which can't be changed after creation. Not applicable to `standard` bastions.

Sample:
phone_book_entry_example
 
private_endpoint_ip_address
string
on success
The private IP address of the created private endpoint.

Sample:
private_endpoint_ip_address_example
 
static_jump_host_ip_addresses
list / elements=string
on success
A list of IP addresses of the hosts that the bastion has access to. Not applicable to `standard` bastions.
 
system_tags
dictionary
on success
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
 
target_subnet_id
string
on success
The unique identifier (OCID) of the subnet that the bastion connects to.

Sample:
ocid1.targetsubnet.oc1..xxxxxxEXAMPLExxxxxx
 
target_vcn_id
string
on success
The unique identifier (OCID) of the virtual cloud network (VCN) that the bastion connects to.

Sample:
ocid1.targetvcn.oc1..xxxxxxEXAMPLExxxxxx
 
time_created
string
on success
The time the bastion 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 bastion 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)