openstack.cloud.port_forwarding module – Create/Update/Delete port forwarding resources from OpenStack

Note

This module is part of the openstack.cloud collection (version 2.6.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 openstack.cloud. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: openstack.cloud.port_forwarding.

Synopsis

  • Create, Update and Remove Neutron floating IP port forwarding resources from OpenStack

  • Port forwarding allows external traffic to reach instances behind a floating IP

Requirements

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

  • python >= 3.6

  • openstacksdk >= 1.0.0

Parameters

Parameter

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, user_domain_name or 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

any

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_protocol_port

aliases: external_port

integer

The external port number on the floating IP that will be forwarded

Must be between 1 and 65535

Required if port_forwarding_id is set

floating_ip

aliases: floating_ip_address

string / required

The floating IP address or ID to create port forwarding on

interface

aliases: endpoint_type

string

Endpoint URL type to fetch from the service catalog.

Choices:

  • "admin"

  • "internal"

  • "public" ← (default)

internal_ip

aliases: internal_ip_address

string

The internal IP address to forward traffic to

Must be one of the fixed IPs on the specified port

If not specified, uses the first fixed IP of the port

Requires network_port

internal_protocol_port

aliases: internal_port

integer

The internal port number to forward traffic to

Must be between 1 and 65535

Required if port_forwarding_id is set

network_port

string

The Neutron port name or ID that contains the internal IP

Required if port_forwarding_id is set

port_forwarding_id

string

ID of an existing port forwarding resource

Used for updates and deletions when ID is known

protocol

string

The IP protocol for the port forwarding resource

Supports tcp and udp protocols

Required if port_forwarding_id is set

region_name

string

Name of the region.

sdk_log_level

string

Log level of the OpenStackSDK

Choices:

  • "INFO" ← (default)

  • "DEBUG"

sdk_log_path

string

Path to the logfile of the OpenStackSDK. If empty no log is written

state

string

Whether the port forwarding resource should exist or not

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 true.

Choices:

  • false

  • true

wait

boolean

Should ansible wait until the requested resource is complete.

Choices:

  • false

  • true ← (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

- name: Create new port fowarding
  openstack.cloud.port_forwarding:
  state: present
  floating_ip: 192.168.150.67
  external_protocol_port: 80
  internal_protocol_port: 8080
  network_port: example_http_port
  protocol: tcp

- name: Update previously created port forwarding
  openstack.cloud.port_forwarding:
  state: present
  port_forwarding_id: existing_port_forwarding
  floating_ip: 192.168.150.67
  internal_protocol_port: 9090

- name: Delete port forwarding
  openstack.cloud.port_forwarding:
  state: absent
  port_forwarding_id: "resource-id"
  floating_ip: "203.0.113.100"

Return Values

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

Key

Description

port_forwarding

list / elements=dictionary

Dictionary describing the port forwarding resource.

Returned: success

description

string

The description of the port forwarding.

Returned: success

external_port

integer

The external port number.

Returned: success

floatingip_id

string

The floating IP id associated with the port forwarding.

Returned: success

id

string

The id of the port forwarding.

Returned: success

internal_ip_address

string

The internal IP address associated with the port forwarding.

Returned: success

internal_port

integer

The internal port number.

Returned: success

internal_port_id

string

The ID of the network port associated with the port forwarding.

Returned: success

protocol

string

The IP protocol used for port forwarding.

Returned: success

Authors

  • OpenStack Ansible SIG