opentelekomcloud.cloud.nat_dnat_rule module – Manage NAT DNAT rules

Note

This module is part of the opentelekomcloud.cloud collection (version 0.11.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

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

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

New in version 0.0.6: of opentelekomcloud.cloud

Synopsis

• Manage NAT DNAT rules

Requirements

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

• openstacksdk

• openstacksdk >= 0.36.0

• otcextensions

• python >= 3.6

Parameters

Parameter	Comments
admin_state_up boolean	DNAT rule state. Choices: no yes
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 aliases: cacert string	A path to a CA Cert bundle that can be used as part of verifying SSL API requests.
client_cert aliases: cert string	A path to a client certificate to use as part of the SSL transaction.
client_key aliases: key string	A path to a client key to use as part of the SSL transaction.
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.
external_service_port string	Specifies the port for providing external services. Mandatory for DNAT rule creation
floating_ip string	ID or Name of the floating IP Mandatory for DNAT rule creation
id string	ID of the DNAT rule
interface aliases: endpoint_type string	Endpoint URL type to fetch from the service catalog. Choices: admin internal public ← (default)
internal_service_port string	Specifies the port used by ECSs or BMSs to provide services for external systems Mandatory for DNAT rule creation
nat_gateway string	ID or Name of the NAT gateway Mandatory for DNAT rule creation
port string	Specifies the port ID of an ECS or a BMS. This parameter and private_ip are alternative
private_ip string	Specifies the private IP address, for example, the IP address of a Direct Connect connection. This parameter and port are alternative
project_id string	Specifies the project ID
protocol string	Specifies the protocol type. Currently, TCP, UDP, and ANY are supported. Mandatory for DNAT rule creation Choices: tcp ← (default) udp any
region_name string	Name of the region.
state string	Instance state Choices: present ← (default) absent
timeout integer	How long should ansible wait for the requested resource. Default: 180
validate_certs aliases: verify boolean	Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to yes. Choices: no ← (default) yes
wait boolean	Should ansible wait until the requested resource is complete. Choices: no yes ← (default)

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

# create DNAT rule
nat_dnat:
    cloud: otc
    nat_gateway: 2b725feb-f0b7-4dcc-a7b4-e02336867123
    internal_service_port: 80
    external_service_port: 80
    port: 840bbea5-aaf8-40b9-bf17-cc081a785123
    floating_ip: f39ef6e6-a4b3-42be-a501-b7dfe251b123
    protocol: tcp
    state: present

Return Values

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

Key	Description
dnat_rule complex	List of dictionaries describing DNAT rules. Returned: On Success.
admin_state_up boolean	Specifies whether the rule is active or down. Returned: success Sample: true
created_at string	Creation time of the DNAT rule Returned: success Sample: “yyyy-mm-dd hh:mm:ss”
external_service_port string	Specifies the port for providing external services. Returned: success Sample: 80
floating_ip string	IP / ID of the floating IP Address assigned to the rule. Returned: success Sample: “123.12.1.12”
id string	ID of the DNAT rule Returned: success Sample: “5acab424-69fb-4408-93d1-b2801b306827”
internal_service_port string	Specifies the port used by ECSs or BMSs to provide services for external systems Returned: success Sample: 80
nat_gateway_id string	ID or name of the assigned Nat gateway. Returned: success Sample: “2aa32feb-f0b7-4dcc-a7b4-e0233686702b”
port string	Specifies the port ID of an ECS or a BMS. This parameter and private_ip are alternative Returned: success Sample: “736abea5-aaf8-40b9-bf17-cc081a785d67”
private_ip string	Specifies the private IP address, e.g. the IP address of a Direct Connect connection. This parameter and port are alternative Returned: success Sample: “192.168.2.1”
protocol string	Used protocol Returned: success Sample: “tcp”
status string	Specifies the status of the NAT gateway. Returned: success Sample: “ACTIVE”

Authors

• Sebastian Gode (@SebastianGode)

Whats next

• opentelekomcloud.cloud.nat_dnat_rule_info module – Get DNAT rule details

last updated: 2022-02-25 12:26