oracle.oci.oci_bastion_facts – Fetches details about one or multiple Bastion resources in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

  • Fetches details about one or multiple Bastion resources in Oracle Cloud Infrastructure

  • Retrieves a list of BastionSummary objects in a compartment. Bastions provide secured, public access to target resources in the cloud that you cannot otherwise reach from the internet.

  • If bastion_id is specified, the details of a single Bastion will be returned.

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.
Required to get a specific bastion.

aliases: id
bastion_lifecycle_state
string
    Choices:
  • CREATING
  • UPDATING
  • ACTIVE
  • DELETING
  • DELETED
  • FAILED
A filter to return only resources their lifecycleState matches the given lifecycleState.
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.
compartment_id
string
The unique identifier (OCID) of the compartment in which to list resources.
Required to list multiple bastions.
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.
name
string
A filter to return only resources that match the entire name given.
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.
sort_by
string
    Choices:
  • timeCreated
  • name
The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for name is ascending. If no value is specified timeCreated is default.
sort_order
string
    Choices:
  • ASC
  • DESC
The sort order to use, either 'asc' or 'desc'.
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 specific bastion
  oci_bastion_facts:
    # required
    bastion_id: "ocid1.bastion.oc1..xxxxxxEXAMPLExxxxxx"

- name: List bastions
  oci_bastion_facts:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    bastion_lifecycle_state: CREATING
    bastion_id: "ocid1.bastion.oc1..xxxxxxEXAMPLExxxxxx"
    name: name_example
    sort_order: ASC
    sort_by: timeCreated

Return Values

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

Key Returned Description
bastions
complex
on success
List of Bastion resources

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.
Returned for get operation

 
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.
Returned for get operation

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

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.
Returned for get operation

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

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.
Returned for get operation

 
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)