openstack.cloud.floating_ip module – Manage floating IP addresses for OpenStack servers

Note

This module is part of the openstack.cloud collection (version 2.3.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.floating_ip.

Synopsis

• Add or remove an floating ip address to/from an OpenStack server.

• Returns the floating IP when attaching only if wait is true.

• When detaching a floating IP there might be a delay until an server does not list the floating IP any more.

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.
fixed_address string	To which fixed IP of server the floating IP address should be attached to.
floating_ip_address string	A floating IP address to attach or to detach. When state is present can be used to specify a IP address to attach. floating_ip_address requires network to be set.
interface aliases: endpoint_type string	Endpoint URL type to fetch from the service catalog. Choices: "admin" "internal" "public" ← (default)
nat_destination aliases: fixed_network, internal_network string	The name or id of a neutron private network that the fixed IP to attach floating IP is on
network string	The name or ID of a neutron external network or a nova pool name.
purge boolean	When state is absent, indicates whether or not to delete the floating IP completely, or only detach it from the server. Default is to detach only. Choices: false ← (default) true
region_name string	Name of the region.
reuse boolean	When state is present, and floating_ip_address is not present, this parameter can be used to specify whether we should try to reuse a floating IP address already allocated to the project. When reuse is true, network is defined and floating_ip_address is undefined, then nat_destination and fixed_address will be ignored. Choices: false ← (default) true
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
server string / required	The name or ID of the server to which the IP address should be assigned.
state string	Should the resource be present or absent. 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

# Assign a floating IP to the first interface of `cattle001` from an existing
# external network or nova pool. A new floating IP from the first available
# external network is allocated to the project.
- openstack.cloud.floating_ip:
     cloud: dguerri
     server: cattle001

# Assign a new floating IP to the server fixed ip `192.0.2.3` of
# `cattle001`. If a free floating IP is already allocated to the project, it is
# reused; if not, a new one is created.
- openstack.cloud.floating_ip:
     cloud: dguerri
     state: present
     reuse: true
     server: cattle001
     network: ext_net
     fixed_address: 192.0.2.3
     wait: true
     timeout: 180

# Assign a new floating IP from the network `ext_net` to the server fixed
# ip in network `private_net` of `cattle001`.
- openstack.cloud.floating_ip:
     cloud: dguerri
     state: present
     server: cattle001
     network: ext_net
     nat_destination: private_net
     wait: true
     timeout: 180

# Detach a floating IP address from a server
- openstack.cloud.floating_ip:
     cloud: dguerri
     state: absent
     floating_ip_address: 203.0.113.2
     server: cattle001

Return Values

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

Key	Description
floating_ip dictionary	Dictionary describing the floating ip address. Returned: success
created_at string	Timestamp at which the floating IP was assigned. Returned: success
description string	The description of a floating IP. Returned: success
dns_domain string	The DNS domain. Returned: success
dns_name string	The DNS name. Returned: success
fixed_ip_address string	The fixed IP address associated with a floating IP address. Returned: success
floating_ip_address string	The IP address of a floating IP. Returned: success
floating_network_id string	The id of the network associated with a floating IP. Returned: success
id string	Id of the floating ip. Returned: success
name string	Name of the floating ip. Returned: success
port_details dictionary	The details of the port that this floating IP associates with. Present if fip-port-details extension is loaded. Returned: success
port_id string	The port ID floating ip associated with. Returned: success
project_id string	The ID of the project this floating IP is associated with. Returned: success
qos_policy_id string	The ID of the QoS policy attached to the floating IP. Returned: success
revision_number string	Revision number. Returned: success
router_id string	The id of the router floating ip associated with. Returned: success
status string	The status of a floating IP, which can be ‘ACTIVE’ or ‘DOWN’. Returned: success
subnet_id string	The id of the subnet the floating ip associated with. Returned: success
tags list / elements=string	List of tags. Returned: success
updated_at string	Timestamp at which the floating IP was last updated. Returned: success

Authors

• OpenStack Ansible SIG

Collection links

• Issue Tracker
• Repository (Sources)