oci_local_peering_gateway_facts - Retrieve facts of Local Peering Gateways(LPGs)

New in version 2.5.

Synopsis

  • This module retrieves information of the specified local peering gateway(LPG) or lists the local peering gateways (LPGs) for the specified VCN and compartment (the LPG’s compartment).

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter Choices/Defaults Comments
api_user
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
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
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
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
    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 LPGs in the specified VCN and compartment (the LPG's compartment).
config_file_location
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
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
Use display_name along with the other options to return only resources that match the given display name exactly.
local_peering_gateway_id
The OCID of the LPG. local_peering_gateway_id is required to get a specific LPG's information.

aliases: id
region
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.
tenancy
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
vcn_id
The OCID of the VCN. vcn_id is required to get all the LPGs in the specified VCN and compartment (the LPG's compartment).

Examples

- name: Get all the LPGs in a compartment
  oci_local_peering_gateway_facts:
    compartment_id: 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx'
    vcn_id: 'ocid1.vcn.oc1..xxxxxEXAMPLExxxxx'

- name: Get a specific LPG using its OCID
  oci_local_peering_gateway_facts:
    local_peering_gateway_id: ocid1.localpeeringgateway.oc1.phx.xxxxxEXAMPLExxxxx

Return Values

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

Key Returned Description
local_peering_gateways
complex
always
List of LPG details

Sample:
[{'peering_status_details': 'Connected to a peer.', 'lifecycle_state': 'AVAILABLE', 'display_name': 'ansible_local_peering_gateway', 'compartment_id': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx', 'vcn_id': 'ocid1.vcn.oc1.phx.xxxxxEXAMPLExxxxx', 'defined_tags': {}, 'is_cross_tenancy_peering': False, 'time_created': '2018-09-24T06:51:59.491000+00:00', 'freeform_tags': {}, 'peering_status': 'PEERED', 'id': 'ocid1.localpeeringgateway.oc1.phx.xxxxxEXAMPLExxxxx', 'peer_advertised_cidr': '172.16.1.0/30'}]
  peering_status_details
string
always
Additional information regarding the peering status, if applicable.

Sample:
Connected to a peer.
  lifecycle_state
string
always
Current state of the LPG.

Sample:
AVAILABLE
  display_name
string
always
Name of the LPG.

Sample:
ansible_local_peering_gateway
  compartment_id
string
always
The OCID of the compartment containing the LPG.

Sample:
ocid1.compartment.oc1..xxxxxEXAMPLExxxxx
  vcn_id
string
always
The OCID of the VCN the LPG belongs to.

Sample:
ocid1.vcn.oc1.phx.xxxxxEXAMPLExxxxx
  defined_tags
string
always
Defined tags for this resource. Each key is predefined and scoped to a namespace.

Sample:
{'Operations': {'CostCenter': '42'}}
  is_cross_tenancy_peering
bool
always
Whether the VCN at the other end of the peering is in a different tenancy.

  time_created
string
always
The date and time the LPG was created, in the format defined by RFC3339.

Sample:
2017-11-13 20:22:40.626000
  freeform_tags
string
always
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.

Sample:
{'Department': 'Finance'}
  peering_status
string
always
Whether the LPG is peered with another LPG. NEW means the LPG has not yet been peered. PENDING means the peering is being established. REVOKED means the LPG at the other end of the peering has been deleted.

Sample:
PEERED
  id
string
always
OCID of the LPG.

Sample:
ocid1.localpeeringgateway.oc1.phx.xxxxxEXAMPLExxxxx
  peer_advertised_cidr
string
always
The range of IP addresses available on the VCN at the other end of the peering from this LPG. The value is null if the LPG is not peered. You can use this as the destination CIDR for a route rule to route a subnet's traffic to this LPG.

Sample:
172.16.1.0/30


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author

  • Rohit Chaware (@rohitChaware)

Hint

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