mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-26 20:31:27 -07:00
0f893027c4
Start using this to construct shade OpenStack Cloud objects in a consistent manner. This will let us centralize things like dealing with password arguments and whatnot. It also allows us to introduce the ability to pass a fully formed config dict directly to the module. Migrate all OpenStack modules to use openstack_cloud_from_module. Have it return the shade library since it's responsible for importing shade and shade is needed for the exceptions. Only pull specific OpenStack arguments for the constructor Rather than passing **module.params to the shade constructor, pull out only the values that make sense. This should prevent the issues with module parameters stepping on shade parameters. Replace module.params.pop with module.params.get We don't need to pop these anymore since the shade constructor is now using opt-in values. Using real urls is ungood. Use example.com domains. Also, get rid of the antiquated port numbers.
266 lines
9.9 KiB
Python
266 lines
9.9 KiB
Python
#!/usr/bin/python
|
|
# Copyright (c) 2015 Hewlett-Packard Development Company, L.P.
|
|
# Author: Davide Guerri <davide.guerri@hp.com>
|
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
|
|
from __future__ import absolute_import, division, print_function
|
|
__metaclass__ = type
|
|
|
|
|
|
ANSIBLE_METADATA = {'metadata_version': '1.1',
|
|
'status': ['preview'],
|
|
'supported_by': 'community'}
|
|
|
|
|
|
DOCUMENTATION = '''
|
|
---
|
|
module: os_floating_ip
|
|
version_added: "2.0"
|
|
author: "Davide Guerri <davide.guerri@hp.com>"
|
|
short_description: Add/Remove floating IP from an instance
|
|
extends_documentation_fragment: openstack
|
|
description:
|
|
- Add or Remove a floating IP to an instance
|
|
options:
|
|
server:
|
|
description:
|
|
- The name or ID of the instance to which the IP address
|
|
should be assigned.
|
|
required: true
|
|
network:
|
|
description:
|
|
- The name or ID of a neutron external network or a nova pool name.
|
|
required: false
|
|
floating_ip_address:
|
|
description:
|
|
- A floating IP address to attach or to detach. Required only if I(state)
|
|
is absent. When I(state) is present can be used to specify a IP address
|
|
to attach.
|
|
required: false
|
|
reuse:
|
|
description:
|
|
- When I(state) is present, and I(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.
|
|
required: false
|
|
default: false
|
|
fixed_address:
|
|
description:
|
|
- To which fixed IP of server the floating IP address should be
|
|
attached to.
|
|
required: false
|
|
nat_destination:
|
|
description:
|
|
- The name or id of a neutron private network that the fixed IP to
|
|
attach floating IP is on
|
|
required: false
|
|
default: None
|
|
aliases: ["fixed_network", "internal_network"]
|
|
version_added: "2.3"
|
|
wait:
|
|
description:
|
|
- When attaching a floating IP address, specify whether we should
|
|
wait for it to appear as attached.
|
|
required: false
|
|
default: false
|
|
timeout:
|
|
description:
|
|
- Time to wait for an IP address to appear as attached. See wait.
|
|
required: false
|
|
default: 60
|
|
state:
|
|
description:
|
|
- Should the resource be present or absent.
|
|
choices: [present, absent]
|
|
required: false
|
|
default: present
|
|
purge:
|
|
description:
|
|
- When I(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.
|
|
required: false
|
|
default: false
|
|
version_added: "2.1"
|
|
availability_zone:
|
|
description:
|
|
- Ignored. Present for backwards compatibility
|
|
required: false
|
|
requirements: ["shade"]
|
|
'''
|
|
|
|
EXAMPLES = '''
|
|
# Assign a floating IP to the fist interface of `cattle001` from an exiting
|
|
# external network or nova pool. A new floating IP from the first available
|
|
# external network is allocated to the project.
|
|
- os_floating_ip:
|
|
cloud: dguerri
|
|
server: cattle001
|
|
|
|
# Assign a new floating IP to the instance 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.
|
|
- os_floating_ip:
|
|
cloud: dguerri
|
|
state: present
|
|
reuse: yes
|
|
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 instance fixed
|
|
# ip in network `private_net` of `cattle001`.
|
|
- os_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
|
|
- os_floating_ip:
|
|
cloud: dguerri
|
|
state: absent
|
|
floating_ip_address: 203.0.113.2
|
|
server: cattle001
|
|
'''
|
|
|
|
from ansible.module_utils.basic import AnsibleModule, remove_values
|
|
from ansible.module_utils.openstack import openstack_full_argument_spec, openstack_module_kwargs, openstack_cloud_from_module
|
|
|
|
|
|
def _get_floating_ip(cloud, floating_ip_address):
|
|
f_ips = cloud.search_floating_ips(
|
|
filters={'floating_ip_address': floating_ip_address})
|
|
if not f_ips:
|
|
return None
|
|
|
|
return f_ips[0]
|
|
|
|
|
|
def main():
|
|
argument_spec = openstack_full_argument_spec(
|
|
server=dict(required=True),
|
|
state=dict(default='present', choices=['absent', 'present']),
|
|
network=dict(required=False, default=None),
|
|
floating_ip_address=dict(required=False, default=None),
|
|
reuse=dict(required=False, type='bool', default=False),
|
|
fixed_address=dict(required=False, default=None),
|
|
nat_destination=dict(required=False, default=None,
|
|
aliases=['fixed_network', 'internal_network']),
|
|
wait=dict(required=False, type='bool', default=False),
|
|
timeout=dict(required=False, type='int', default=60),
|
|
purge=dict(required=False, type='bool', default=False),
|
|
)
|
|
|
|
module_kwargs = openstack_module_kwargs()
|
|
module = AnsibleModule(argument_spec, **module_kwargs)
|
|
|
|
if module.params['nat_destination']:
|
|
min_version = '1.8.0'
|
|
else:
|
|
min_version = None
|
|
|
|
server_name_or_id = module.params['server']
|
|
state = module.params['state']
|
|
network = module.params['network']
|
|
floating_ip_address = module.params['floating_ip_address']
|
|
reuse = module.params['reuse']
|
|
fixed_address = module.params['fixed_address']
|
|
nat_destination = module.params['nat_destination']
|
|
wait = module.params['wait']
|
|
timeout = module.params['timeout']
|
|
purge = module.params['purge']
|
|
|
|
shade, cloud = openstack_cloud_from_module(module, min_version=min_version)
|
|
|
|
try:
|
|
server = cloud.get_server(server_name_or_id)
|
|
if server is None:
|
|
module.fail_json(
|
|
msg="server {0} not found".format(server_name_or_id))
|
|
|
|
if state == 'present':
|
|
# If f_ip already assigned to server, check that it matches
|
|
# requirements.
|
|
public_ip = cloud.get_server_public_ip(server)
|
|
f_ip = _get_floating_ip(cloud, public_ip) if public_ip else public_ip
|
|
if f_ip:
|
|
if network:
|
|
network_id = cloud.get_network(name_or_id=network)["id"]
|
|
else:
|
|
network_id = None
|
|
# check if we have floting ip on given nat_destination network
|
|
if nat_destination:
|
|
nat_floating_addrs = [addr for addr in server.addresses.get(
|
|
cloud.get_network(nat_destination)['name'], [])
|
|
if addr.addr == public_ip and
|
|
addr['OS-EXT-IPS:type'] == 'floating']
|
|
|
|
if len(nat_floating_addrs) == 0:
|
|
module.fail_json(msg="server {server} already has a "
|
|
"floating-ip on a different "
|
|
"nat-destination than '{nat_destination}'"
|
|
.format(server=server_name_or_id,
|
|
nat_destination=nat_destination))
|
|
|
|
if all([fixed_address, f_ip.fixed_ip_address == fixed_address,
|
|
network, f_ip.network != network_id]):
|
|
# Current state definitely conflicts with requirements
|
|
module.fail_json(msg="server {server} already has a "
|
|
"floating-ip on requested "
|
|
"interface but it doesn't match "
|
|
"requested network {network}: {fip}"
|
|
.format(server=server_name_or_id,
|
|
network=network,
|
|
fip=remove_values(f_ip,
|
|
module.no_log_values)))
|
|
if not network or f_ip.network == network_id:
|
|
# Requirements are met
|
|
module.exit_json(changed=False, floating_ip=f_ip)
|
|
|
|
# Requirements are vague enough to ignore existing f_ip and try
|
|
# to create a new f_ip to the server.
|
|
|
|
server = cloud.add_ips_to_server(
|
|
server=server, ips=floating_ip_address, ip_pool=network,
|
|
reuse=reuse, fixed_address=fixed_address, wait=wait,
|
|
timeout=timeout, nat_destination=nat_destination)
|
|
fip_address = cloud.get_server_public_ip(server)
|
|
# Update the floating IP status
|
|
f_ip = _get_floating_ip(cloud, fip_address)
|
|
module.exit_json(changed=True, floating_ip=f_ip)
|
|
|
|
elif state == 'absent':
|
|
if floating_ip_address is None:
|
|
if not server_name_or_id:
|
|
module.fail_json(msg="either server or floating_ip_address are required")
|
|
server = cloud.get_server(server_name_or_id)
|
|
floating_ip_address = cloud.get_server_public_ip(server)
|
|
|
|
f_ip = _get_floating_ip(cloud, floating_ip_address)
|
|
|
|
if not f_ip:
|
|
# Nothing to detach
|
|
module.exit_json(changed=False)
|
|
changed = False
|
|
if f_ip["fixed_ip_address"]:
|
|
cloud.detach_ip_from_server(
|
|
server_id=server['id'], floating_ip_id=f_ip['id'])
|
|
# Update the floating IP status
|
|
f_ip = cloud.get_floating_ip(id=f_ip['id'])
|
|
changed = True
|
|
if purge:
|
|
cloud.delete_floating_ip(f_ip['id'])
|
|
module.exit_json(changed=True)
|
|
module.exit_json(changed=changed, floating_ip=f_ip)
|
|
|
|
except shade.OpenStackCloudException as e:
|
|
module.fail_json(msg=str(e), extra_data=e.extra_data)
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|