oci_remote_peering_connection – Manage remote peering connections in OCI

New in version 2.5.

Synopsis

  • This module allows the user to create, delete, update a remote peering connection(RPC) and connect one RPC to another one in a different region in OCI.

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_type
string
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
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 containing the RPC. Required when creating a RPC with state=present.
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
-
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

aliases: name
drg_id
-
The OCID of the DRG the RPC belongs to. Required when creating a RPC with state=present.
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
The list of comma-separated attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource except freeform_tags are used to uniquely identify a resource.
peer_id
-
The OCID of the RPC you want to peer with. Required to connect remote_peering_connection_id to another RPC in different region.
peer_region_name
-
The name of the region that contains the RPC you want to peer with. Required to connect remote_peering_connection_id to another RPC in different region.
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 remote peering connection (RPC). Required when deleting a RPC with state=absent or updating a RPC with state=present or for connecting RPCs.

aliases: id
state
-
    Choices:
  • present ←
  • absent
Create or update a RPC with state=present. Use state=absent to delete a RPC.
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
Default:
2000
Time, in seconds, to wait when wait=yes.
wait_until
string
The lifecycle state to wait for the resource to transition into when wait=yes. By default, when wait=yes, we wait for the resource to get into ACTIVE/ATTACHED/AVAILABLE/PROVISIONED/ RUNNING applicable lifecycle state during create operation & to get into DELETED/DETACHED/ TERMINATED lifecycle state during delete operation.

Examples

- name: Create a RPC
  oci_remote_peering_connection:
    compartment_id: 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx'
    display_name: my_remote_peering_connection
    drg_id: ocid1.drg.oc1.phx.xxxxxEXAMPLExxxxx

- name: Update the specified RPC's display name
  oci_remote_peering_connection:
    remote_peering_connection_id: ocid1.remotepeeringconnection.oc1.phx.xxxxxEXAMPLExxxxx
    display_name: ansible_remote_peering_connection

- name: Connect a RPC to another RPC in different region
  oci_remote_peering_connection:
    remote_peering_connection_id: ocid1.remotepeeringconnection.oc1.phx.xxxxxEXAMPLExxxxx
    peer_id: ocid1.remotepeeringconnection.oc1.iad.xxxxxEXAMPLExxxxx
    peer_region_name: us-ashburn-1

- name: Delete the specified RPC
  oci_remote_peering_connection:
    id: ocid1.remotepeeringconnection.oc1.phx.xxxxxEXAMPLExxxxx
    state: absent

Return Values

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

Key Returned Description
remote_peering_connection
dictionary
 On successful operation
Information about the RPC

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


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.