opentelekomcloud.cloud.nat_dnat_rule module -- Manage NAT DNAT rules¶
Note
This module is part of the opentelekomcloud.cloud collection (version 0.14.6).
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.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: opentelekomcloud.cloud.nat_dnat_rule.
New in opentelekomcloud.cloud 0.0.6
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 |
|---|---|
DNAT rule state. Choices:
|
|
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. |
|
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. |
|
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. |
|
A path to a CA Cert bundle that can be used as part of verifying SSL API requests. |
|
A path to a client certificate to use as part of the SSL transaction. |
|
A path to a client key to use as part of the SSL transaction. |
|
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. |
|
Specifies the port for providing external services. Mandatory for DNAT rule creation |
|
ID or Name of the floating IP Mandatory for DNAT rule creation |
|
ID of the DNAT rule |
|
Endpoint URL type to fetch from the service catalog. Choices:
|
|
Specifies the port used by ECSs or BMSs to provide services for external systems Mandatory for DNAT rule creation |
|
ID or Name of the NAT gateway Mandatory for DNAT rule creation |
|
Specifies the port ID of an ECS or a BMS. This parameter and private_ip are alternative |
|
Specifies the private IP address, for example, the IP address of a Direct Connect connection. This parameter and port are alternative |
|
Specifies the project ID |
|
Specifies the protocol type. Currently, TCP, UDP, and ANY are supported. Mandatory for DNAT rule creation Choices:
|
|
Name of the region. |
|
Log level of the OpenStackSDK Choices:
|
|
Path to the logfile of the OpenStackSDK. If empty no log is written |
|
Instance state Choices:
|
|
How long should ansible wait for the requested resource. Default: |
|
Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to Choices:
|
|
Should ansible wait until the requested resource is complete. Choices:
|
Notes¶
Note
The standard OpenStack environment variables, such as
OS_USERNAMEmay 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 |
|---|---|
List of dictionaries describing DNAT rules. Returned: On Success. |
|
Specifies whether the rule is active or down. Returned: success Sample: |
|
Creation time of the DNAT rule Returned: success Sample: |
|
Specifies the port for providing external services. Returned: success Sample: |
|
IP / ID of the floating IP Address assigned to the rule. Returned: success Sample: |
|
ID of the DNAT rule Returned: success Sample: |
|
Specifies the port used by ECSs or BMSs to provide services for external systems Returned: success Sample: |
|
ID or name of the assigned Nat gateway. Returned: success Sample: |
|
Specifies the port ID of an ECS or a BMS. This parameter and private_ip are alternative Returned: success Sample: |
|
Specifies the private IP address, e.g. the IP address of a Direct Connect connection. This parameter and port are alternative Returned: success Sample: |
|
Used protocol Returned: success Sample: |
|
Specifies the status of the NAT gateway. Returned: success Sample: |