oci_internet_gateway - Create,update and delete OCI Internet Gateway

New in version 2.5.

Synopsis

  • Creates OCI Internet Gateway
  • Update OCI Internet Gateway, if present, with a new display name
  • Update OCI Internet Gateway, if present, with enable/disable state
  • Delete OCI Internet Gateway, if present.

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 under which this Internet Gateway would be created. Mandatory for create operation.Optional for delete and update. Mutually exclusive with ig_id.
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.
defined_tags
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm.
display_name
Name of the Internet Gateway. A user friendly name. Does not have to be unique, and could be changed. If not specified, a default name would be provided.

aliases: name
force_create
bool
    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.
freeform_tags
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm.
ig_id
Identifier of the Internet Gateway. Mandatory for delete and update.

aliases: id
is_enabled
bool
    Choices:
  • no
  • yes
This option is mandatory for create operation.If is_enabled=yes, the gateway would be enabled. If is_enabled=no, traffic is not routed to/from the Internet, regardless of route rules.

aliases: enabled
key_by
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.
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.
state
    Choices:
  • present ←
  • absent
Create,update or delete Internet Gateway. For state=present, if it does not exists, it gets created. If exists, it gets updated.
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 should be attached. Mandatory for create operation. Optional for delete and update. Mutually exclusive with ig_id.
wait
bool
    Choices:
  • no
  • yes ←
Whether to wait for create or delete operation to complete.
wait_timeout Default:
1200
Time, in seconds, to wait when wait=yes.
wait_until
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

#Note: These examples do not set authentication details.
#Create/update Internet Gateway
- name : Create new Internet Gateway in OCI
  oci_internet_gateway:
            compartment_id: 'ocid1.compartment..xdsc'
            vcn_id: 'ocid1.vcn..dsxc'
            name: 'ansible_ig'
            enabled: 'yes'
            freeform_tags:
                  region: 'east'
            defined_tags:
                features:
                   capacity: 'medium'
            state: 'present'
#Update Internet Gateway with ig_id
- name : Update Internet Gateway in OCI
  oci_internet_gateway:
            ig_id: 'ocid1.internetgateway..dsxc'
            display_name: 'ansible_ig'
            is_enabled: 'no'
            state: 'present'

#Delete Internet Gateway
- name : Delete Internet Gateway
  oci_internet_gateway:
            compartment_id: 'ocid1.compartment..xdsc'
            vcn_id: 'ocid1.vcn..dsxc'
            state: 'absent'

#Delete Internet Gateway
- name : Delete Internet Gateway
  oci_internet_gateway:
            id: 'ocid1.internetgateway..xdsc'
            state: 'absent'

Return Values

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

Key Returned Description
internet_gateway
complex
success
Attributes of the created/updated Internet Gateway. For delete, deleted Internet Gateway description will be returned.

Sample:
{'is_enabled': False, 'lifecycle_state': 'AVAILABLE', 'display_name': 'ansible_ig', '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-12T13:17:36.564000+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.