oci_remote_peering_connection_facts – Retrieve facts of Remote Peering Connections(RPCs)

New in version 2.5.

Synopsis

  • This module retrieves information of the specified remote peering connection(RPC) or lists the RPCs for the specified DRG and compartment (the RPC’s 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. compartment_id is required to get all the RPCs in the specified compartment (the RPC's compartment).
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
Use display_name along with the other options to return only resources that match the given display name exactly.
drg_id
-
The OCID of the DRG. drg_id is required to get all the RPCs for the specified DRG and compartment (the RPC's compartment).
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.
remote_peering_connection_id
-
The OCID of the RPC. remote_peering_connection_id is required to get a specific RPC's information.

aliases: id
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 all the RPCs in a compartment
  oci_remote_peering_connection_facts:
    compartment_id: 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx'

- name: Get a specific RPC using its OCID
  oci_remote_peering_connection_facts:
    remote_peering_connection_id: ocid1.remotepeeringconnection.oc1.phx.xxxxxEXAMPLExxxxx

Return Values

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

Key Returned Description
remote_peering_connections
complex
always
List of RPC details

Sample:
[{'lifecycle_state': 'AVAILABLE', 'peer_region_name': 'us-ashburn-1', 'display_name': 'ansible_remote_peering_connection', 'compartment_id': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx', 'is_cross_tenancy_peering': False, 'time_created': '2018-09-24T06:51:59.491000+00:00', 'peering_status': 'PEERED', 'peer_tenancy_id': 'ocid1.tenancy.oc1..xxxxxEXAMPLExxxxx', 'drg_id': 'ocid1.drg.oc1.phx.xxxxxEXAMPLExxxxx', 'peer_id': 'ocid1.remotepeeringconnection.oc1.iad.xxxxxEXAMPLExxxxx', 'id': 'ocid1.remotepeeringconnection.oc1.phx.xxxxxEXAMPLExxxxx'}]
  compartment_id
string
always
The OCID of the compartment containing the RPC.

Sample:
ocid1.compartment.oc1..xxxxxEXAMPLExxxxx
  display_name
string
always
Name of the RPC.

Sample:
ansible_remote_peering_connection
  drg_id
string
always
The OCID of the DRG that this RPC belongs to.

Sample:
ocid1.drg.oc1.phx.xxxxxEXAMPLExxxxx
  id
string
always
OCID of the RPC.

Sample:
ocid1.remotepeeringconnection.oc1.phx.xxxxxEXAMPLExxxxx
  is_cross_tenancy_peering
boolean
always
Whether the VCN at the other end of the peering is in a different tenancy.

  lifecycle_state
string
always
Current state of the RPC.

Sample:
AVAILABLE
  peer_id
string
always
If this RPC is peered, this value is the OCID of the other RPC.

Sample:
ocid1.remotepeeringconnection.oc1.iad.xxxxxEXAMPLExxxxx
  peer_tenancy_id
string
always
If this RPC is peered, this value is the OCID of the other RPC's tenancy.

Sample:
ocid1.tenancy.oc1..xxxxxEXAMPLExxxxx
  peering_region_name
string
always
If this RPC is peered, this value is the region that contains the other RPC.

Sample:
us-ashburn-1
  peering_status
string
always
Whether the RPC is peered with another RPC. NEW means the RPC has not yet been peered. PENDING means the peering is being established. REVOKED means the RPC at the other end of the peering has been deleted.

Sample:
PEERED
  time_created
string
always
The date and time the RPC was created, in the format defined by RFC3339.

Sample:
2017-11-13 20:22:40.626000


Status

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

Authors

  • Rohit Chaware (@rohitChaware)

Hint

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