nat_snat_rule

updated: None

nat_snat_rule

Note

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

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

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

New in version 0.0.1: of opentelekomcloud.cloud

Synopsis

  • Manage NAT SNAT rule instances

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
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
cidr
string
Specifies a subset of the VPC subnet CIDR block or
a CIDR block of Direct Connect connection.
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.
floating_ip
string
Address or ID of the floating IP where the SNAT rule is attached to.
Mandatory for SNAT rule creation
id
string
ID of the NAT SNAT rule
Mandatory for SNAT rule deletion
interface
string
    Choices:
  • admin
  • internal
  • public ←
Endpoint URL type to fetch from the service catalog.

aliases: endpoint_type
nat_gateway
string
Name or ID of the NAT gateway
Mandatory for SNAT rule creation
network
string
ID or Name of the network for the SNAT rule.
Mandatory for SNAT rule creation
region_name
string
Name of the region.
source_type
integer
    Choices:
  • 0
  • 1
Default:
0
0 Either network_id or cidr can be specified in VPC
1 only cidr can be specified over a Direct Connect connection.
state
string
    Choices:
  • present ←
  • absent
Instance state
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

# Create snat_rule with cidr
- nat_snat_rule:
    cloud: otc
    nat_gateway: 0035136a-9b29-4232-b456-1059ca11a123
    floating_ip: '80.158.47.5'
    cidr: '192.168.0.0/32'
    state: present
  register: snat

# Create SNAT rule with network
- nat_snat_rule:
    cloud: otc
    nat_gateway: 0035136a-9b29-4232-b456-1059ca11a123
    floating_ip: '80.158.47.5'
    network: c6b2dbc9-ca80-4b49-bbbb-85ea9b96f123
    state: present
  register: snat

Return Values

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

Key Returned Description
snat_rule
complex
On Success.
Dictionary describing the SNAT rule.
 
admin_state_up
boolean
success
Specifies whether gateway is up or down.

Sample:
True
 
cidr
string
success
Specifies a subset of the VPC subnet CIDR block or
a CIDR block of Direct Connect connection.

Sample:
192.168.1.10/32
 
created_at
string
success
Creation time of the NAT SNAT rule

Sample:
yyyy-mm-dd hh:mm:ss
 
floating_ip_address
string
success
Address of the floating IP

Sample:
e1029c97-639e-4481-9254-f30c5632b123"
 
floating_ip_id
string
success
ID of the floating IP address

Sample:
e1029c97-639e-4481-9254-f30c5632b123
 
id
string
success
ID of the NAT SNAT rule

Sample:
3fea684b-50f1-4613-967a-a7bed5e59123
 
nat_gateway_id
string
success
ID of the attached NAT gateway

Sample:
25d24fc8-d019-4a34-9fff-0a09fde6a123
 
network_id
string
success
Network ID of the subnet where the NAT SNAT rule
points to.

Sample:
25d24fc8-d019-4a34-9fff-0a09fde6a567
 
source_type
integer
success
0 Either network_id or cidr can be specified in VPC
1 only cidr can be specified over a Direct Connect connection.
 
status
string
success
Specifies the status of the NAT gateway.

Sample:
ACTIVE
 
tenant_id
string
success
Project ID where the NAT SNAT rule is located in.

Sample:
25d24fc8-d019-4a34-9fff-0a09fde6a567


Authors

  • Tino Schreiber (@tischrei)

updated: None