oci_internet_gateway_facts - Fetches details of the OCI Internet Gateway under a Virtual Cloud Network

New in version 2.5.

Synopsis

  • Fetches details of the OCI Internet Gateway under a Virtual Cloud Network.

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
Identifier of the compartment in which this Internet Gateway exists
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 Default:
DEFAULT
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.
ig_id
Identifier of the Internet Gateway. Required if any specific Internet Gateway details needs to be fetched. Mutually exclusive with compartment_id and vcn_id.

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
Identifier of the Virtual Cloud Network to which the Internet Gateway is attached.

Examples

#Fetch Internet Gateway
- name: List Internet Gateway
  oci_internet_gateway_facts:
      compartment_id: 'ocid1.compartment..xcds'
      vcn_id: 'ocid1.vcn..dfxs'

#Fetch specific Internet Gateway
- name: List a specific Internet Gateway
  oci_internet_gateway_facts:
      id: 'ocid1.internetgateway..xcds'

Return Values

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

Key Returned Description
internet_gateways
complex
 success
Attributes of the Internet Gateways.

Sample:
[{'is_enabled': True, 'lifecycle_state': 'AVAILABLE', 'display_name': 'ansible_internet_gateway_updated', 'compartment_id': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx', 'vcn_id': 'ocid1.vcn.oc1.phx.xxxxxEXAMPLExxxxx', 'defined_tags': {'features': {'capacity': 'medium'}}, 'freeform_tags': {'region': 'east'}, 'time_created': '2017-11-14T18:50:50.751000+00:00', 'id': 'ocid1.internetgateway.oc1.phx.xxxxxEXAMPLExxxxx'}]
  vcn_id
string
 always
Identifier of the Virtual Cloud Network to which the Internet Gateway is attached.

Sample:
ocid1.vcn..ixcd
  display_name
string
 always
Name assigned to the Internet Gateway during creation

Sample:
ansible_ig
  compartment_id
string
 always
The identifier of the compartment containing the Internet Gateway

Sample:
ocid1.compartment.oc1.xzvf..oifds
  lifecycle_state
string
 always
The current state of the Internet Gateway

Sample:
ACTIVE
  id
string
 always
Identifier of the Internet Gateway

Sample:
ocid1.internetgateway.oc1.axdf
  time_created
datetime
 always
Date and time when the Internet Gateway was created, in the format defined by RFC3339

Sample:
2016-08-25 21:10:29.600000


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

  • Debayan Gupta(@debayan_gupta)

Hint

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