oci_nat_gateway_facts – Retrieve facts of NAT gateways¶

New in version 2.5.

Synopsis
Requirements
Parameters
Notes
Examples
Return Values
Status

Synopsis ¶

This module retrieves information of the specified NAT gateway or lists all the NAT gateways in the specified compartment.

Requirements ¶

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

python >= 2.7
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io

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. compartment_id is required to get all the NAT gateways in the 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.
lifecycle_state -	Choices: PROVISIONING AVAILABLE TERMINATING TERMINATED	A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. Allowed values are "PROVISIONING", "AVAILABLE", "TERMINATING", "TERMINATED"
nat_gateway_id -		The OCID of the NAT gateway. nat_gateway_id is required to get a specific NAT gateway's information. aliases: id
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.
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
vcn_id -		The OCID of the VCN. Use vcn_id with compartment_id to filter the results by VCN.

Notes ¶

Note

For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html

Examples ¶

- name: Get all the NAT gateways in a compartment
  oci_nat_gateway_facts:
    compartment_id: 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx'

- name: Get a specific NAT gateway using its OCID
  oci_nat_gateway_facts:
    nat_gateway_id: ocid1.natgateway.oc1.phx.xxxxxEXAMPLExxxxx

Return Values ¶

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

Key		Returned	Description
nat_gateways complex		always	List of NAT gateway details Sample: [{'freeform_tags': {}, 'compartment_id': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx', 'id': 'ocid1.natgateway.oc1.phx.xxxxxEXAMPLExxxxx', 'nat_ip': '129.213.64.168', 'vcn_id': 'ocid1.vcn.oc1.phx.xxxxxEXAMPLExxxxx', 'defined_tags': {}, 'display_name': 'ansible_nat_gateway', 'lifecycle_state': 'AVAILABLE', 'block_traffic': False, 'time_created': '2017-11-13T20:22:40.626000+00:00'}]
	block_traffic boolean	always	Whether the NAT gateway blocks all traffic through it. The default is false. Sample: True
	compartment_id string	always	The OCID of the compartment containing the NAT gateway. Sample: ocid1.compartment.oc1..xxxxxEXAMPLExxxxx
	defined_tags string	always	Defined tags for this resource. Each key is predefined and scoped to a namespace. Sample: {'Operations': {'CostCenter': '42'}}
	display_name string	always	Name of the NAT gateway. Sample: ansible_nat_gateway
	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'}
	id string	always	OCID of the NAT gateway. Sample: ocid1.natgateway.oc1.phx.xxxxxEXAMPLExxxxx
	lifecycle_state string	always	Current state of the NAT gateway. Sample: AVAILABLE
	nat_ip string	always	The IP address associated with the NAT gateway. Sample: 129.213.64.168
	time_created string	always	The date and time the NAT gateway was created, in the format defined by RFC3339. Sample: 2017-11-13 20:22:40.626000+00:00
	vcn_id string	always	The OCID of the VCN the NAT gateway belongs to. Sample: ocid1.vcn.oc1.phx.xxxxxEXAMPLExxxxx

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.

oci_nat_gateway_facts – Retrieve facts of NAT gateways¶

Synopsis¶

Requirements¶

Parameters¶

Notes¶

Examples¶

Return Values¶

Status¶