opentelekomcloud.cloud.nat_gateway_info – Get NAT gateways

Note

This plugin is part of the opentelekomcloud.cloud collection (version 0.9.0).

To install it use: ansible-galaxy collection install opentelekomcloud.cloud.

To use it in a playbook, specify: opentelekomcloud.cloud.nat_gateway_info.

New in version 0.0.4: of opentelekomcloud.cloud

Synopsis

• Get NAT gateway info from the OTC.

Requirements

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

• openstacksdk

• openstacksdk >= 0.36.0

• otcextensions

• python >= 3.6

Parameters

Parameter	Choices/Defaults	Comments
admin_state_up boolean	Choices: no yes	NAT gateway state.
api_timeout integer		How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library.
auth dictionary		Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth_url, username, password, project_name and any information about domains (for example, os_user_domain_name or os_project_domain_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS_* environment variables are present.
auth_type string		Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly.
ca_cert string		A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert
client_cert string		A path to a client certificate to use as part of the SSL transaction. aliases: cert
client_key string		A path to a client key to use as part of the SSL transaction. aliases: key
cloud raw		Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth_type. This parameter is not needed if auth is provided or if OpenStack OS_* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml.
created_at string		Creation time of the NAT gateway
description string		Description of the NAT gateway
gateway string		Name or ID of the NAT gateway.
interface string	Choices: admin internal public ←	Endpoint URL type to fetch from the service catalog. aliases: endpoint_type
internal_network_id string		Network ID where the NAT gateway is attached to.
project_id string		Filters NAT gateways of the project ID.
region_name string		Name of the region.
router_id string		ID of the router where the NAT gateway is attached.
spec string	Choices: 1 2 3 4	Specifies the type of the NAT gateway. 1 (small 10.000 connections), 2 (medium 50.000 connections), 3 (large 200.000 connections), 4 (extra-large 1.000.000 connections)
status string		Specifies the status of the NAT gateway
timeout integer	Default: 180	How long should ansible wait for the requested resource.
validate_certs boolean	Choices: no ← yes	Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to yes. aliases: verify
wait boolean	Choices: no yes ←	Should ansible wait until the requested resource is complete.

Notes

Note

• The standard OpenStack environment variables, such as OS_USERNAME may be used instead of providing explicit values.

• Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at https://docs.openstack.org/openstacksdk/

Examples

# Get configs versions.
- nat_gateway_info:
  register: gw

- nat_gateway_info:
    gateway: "my_gateway"
  register: gw

- nat_gateway_info:
    spec: "1"
  register: gw

- nat_gateway_info:
    status: "ACTIVE"
    spec: "1"
  register: gw

Return Values

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

Key		Returned	Description
nat_gateways complex		On Success.	List of dictionaries describing NAT gateways.
	admin_state_up boolean	success	Specifies whether gateway is up or down. Sample: True
	created_at string	success	Creation time of the NAT gateway Sample: yyyy-mm-dd hh:mm:ss
	description string	success	Description of the NAT gateway Sample: My Gateway
	id string	success	ID of the NAT gateway Sample: my-gateway
	internal_network_id string	success	Network ID where the NAT gateway is attached to. Sample: 25d24fc8-d019-4a34-9fff-0a09fde6a123
	name string	success	Name of the NAT gateway. Sample: my-gateway
	project_id string	success	Project ID where the NAT gateway is located in. Sample: 16d53a84a13b49529d2e2c3646612345
	router_id string	success	VPC / Router ID where the NAT gateway is attached to. Sample: 25d24fc8-d019-4a34-9fff-0a09fde6a123
	spec string	success	Specifies the type of the NAT gateway. Sample: 1
	status string	success	Specifies the status of the NAT gateway. Sample: ACTIVE

Authors

• Tino Schreiber (@tischrei)