ansible/cloud/quantum_floating_ip_associate.py

219 lines
7.8 KiB
Python
Raw Normal View History

2013-05-23 04:25:05 +02:00
#!/usr/bin/python
#coding: utf-8 -*-
2014-01-28 17:20:36 +01:00
# (c) 2013, Benno Joy <benno@ansible.com>
2013-05-23 04:25:05 +02:00
#
# This module is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This software is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this software. If not, see <http://www.gnu.org/licenses/>.
try:
from novaclient.v1_1 import client as nova_client
try:
from neutronclient.neutron import client
except ImportError:
from quantumclient.quantum import client
2013-05-23 04:25:05 +02:00
from keystoneclient.v2_0 import client as ksclient
import time
except ImportError:
print "failed=True msg='novaclient, keystone, and quantumclient (or neutronclient) client are required'"
2013-05-23 04:25:05 +02:00
DOCUMENTATION = '''
---
module: quantum_floating_ip_associate
version_added: "1.2"
short_description: Associate or disassociate a particular floating IP with an instance
2013-05-23 04:25:05 +02:00
description:
- Associates or disassociates a specific floating IP with a particular instance
2013-05-23 04:25:05 +02:00
options:
login_username:
description:
- login username to authenticate to keystone
required: true
default: admin
login_password:
description:
2013-05-29 16:45:31 +02:00
- password of login user
2013-05-23 04:25:05 +02:00
required: true
2013-06-01 17:53:57 +02:00
default: 'yes'
2013-05-23 04:25:05 +02:00
login_tenant_name:
description:
2013-05-29 16:45:31 +02:00
- the tenant name of the login user
2013-05-23 04:25:05 +02:00
required: true
2013-05-29 16:45:31 +02:00
default: true
2013-05-23 04:25:05 +02:00
auth_url:
description:
2013-05-29 16:45:31 +02:00
- the keystone url for authentication
2013-05-23 04:25:05 +02:00
required: false
default: 'http://127.0.0.1:35357/v2.0/'
region_name:
description:
2013-05-29 16:45:31 +02:00
- name of the region
2013-05-23 04:25:05 +02:00
required: false
default: None
state:
description:
2013-05-29 16:45:31 +02:00
- indicates the desired state of the resource
2013-05-23 04:25:05 +02:00
choices: ['present', 'absent']
default: present
instance_name:
description:
- name of the instance to which the public IP should be assigned
2013-05-23 04:25:05 +02:00
required: true
default: None
ip_address:
description:
2013-05-29 16:45:31 +02:00
- floating ip that should be assigned to the instance
2013-05-23 04:25:05 +02:00
required: true
default: None
requirements: ["quantumclient", "neutronclient", "keystoneclient"]
2013-05-23 04:25:05 +02:00
'''
2013-05-29 16:45:31 +02:00
EXAMPLES = '''
# Associate a specific floating IP with an Instance
- quantum_floating_ip_associate:
state=present
login_username=admin
login_password=admin
login_tenant_name=admin
ip_address=1.1.1.1
instance_name=vm1
2013-05-29 16:45:31 +02:00
'''
2013-05-23 04:25:05 +02:00
def _get_ksclient(module, kwargs):
try:
kclient = ksclient.Client(username=kwargs.get('login_username'),
password=kwargs.get('login_password'),
tenant_name=kwargs.get('login_tenant_name'),
auth_url=kwargs.get('auth_url'))
except Exception, e:
2013-05-23 04:25:05 +02:00
module.fail_json(msg = "Error authenticating to the keystone: %s " % e.message)
global _os_keystone
_os_keystone = kclient
return kclient
def _get_endpoint(module, ksclient):
try:
endpoint = ksclient.service_catalog.url_for(service_type='network', endpoint_type='publicURL')
except Exception, e:
module.fail_json(msg = "Error getting network endpoint: %s" % e.message)
2013-05-23 04:25:05 +02:00
return endpoint
def _get_neutron_client(module, kwargs):
2013-05-23 04:25:05 +02:00
_ksclient = _get_ksclient(module, kwargs)
token = _ksclient.auth_token
endpoint = _get_endpoint(module, _ksclient)
kwargs = {
'token': token,
'endpoint_url': endpoint
}
try:
neutron = client.Client('2.0', **kwargs)
except Exception, e:
module.fail_json(msg = "Error in connecting to neutron: %s " % e.message)
return neutron
2013-05-23 04:25:05 +02:00
def _get_server_state(module, nova):
server_info = None
server = None
try:
for server in nova.servers.list():
if server:
info = server._info
2013-05-25 05:46:23 +02:00
if info['name'] == module.params['instance_name']:
if info['status'] != 'ACTIVE' and module.params['state'] == 'present':
module.fail_json(msg="The VM is available but not Active. state:" + info['status'])
server_info = info
break
except Exception, e:
module.fail_json(msg = "Error in getting the server list: %s" % e.message)
return server_info, server
def _get_port_id(neutron, module, instance_id):
kwargs = dict(device_id = instance_id)
2013-05-23 04:25:05 +02:00
try:
ports = neutron.list_ports(**kwargs)
except Exception, e:
2013-05-25 05:46:23 +02:00
module.fail_json( msg = "Error in listing ports: %s" % e.message)
2013-05-23 04:25:05 +02:00
if not ports['ports']:
2013-05-25 05:46:23 +02:00
return None
2013-05-23 04:25:05 +02:00
return ports['ports'][0]['id']
def _get_floating_ip_id(module, neutron):
2013-05-23 04:25:05 +02:00
kwargs = {
2013-05-25 05:46:23 +02:00
'floating_ip_address': module.params['ip_address']
2013-05-23 04:25:05 +02:00
}
try:
ips = neutron.list_floatingips(**kwargs)
except Exception, e:
module.fail_json(msg = "error in fetching the floatingips's %s" % e.message)
2013-05-23 04:25:05 +02:00
if not ips['floatingips']:
module.fail_json(msg = "Could find the ip specified in parameter, Please check")
2013-05-23 04:25:05 +02:00
ip = ips['floatingips'][0]['id']
if not ips['floatingips'][0]['port_id']:
2013-05-25 05:46:23 +02:00
state = "detached"
2013-05-23 04:25:05 +02:00
else:
state = "attached"
2013-05-23 04:25:05 +02:00
return state, ip
def _update_floating_ip(neutron, module, port_id, floating_ip_id):
2013-05-23 04:25:05 +02:00
kwargs = {
2013-05-25 05:46:23 +02:00
'port_id': port_id
2013-05-23 04:25:05 +02:00
}
try:
result = neutron.update_floatingip(floating_ip_id, {'floatingip': kwargs})
except Exception, e:
2013-06-01 17:53:57 +02:00
module.fail_json(msg = "There was an error in updating the floating ip address: %s" % e.message)
module.exit_json(changed = True, result = result, public_ip=module.params['ip_address'])
2013-05-23 04:25:05 +02:00
def main():
argument_spec = openstack_argument_spec()
argument_spec.update(dict(
2013-06-01 17:53:57 +02:00
ip_address = dict(required=True),
instance_name = dict(required=True),
2013-06-01 17:53:57 +02:00
state = dict(default='present', choices=['absent', 'present'])
))
module = AnsibleModule(argument_spec=argument_spec)
2013-05-23 04:25:05 +02:00
try:
nova = nova_client.Client(module.params['login_username'], module.params['login_password'],
module.params['login_tenant_name'], module.params['auth_url'], service_type='compute')
except Exception, e:
module.fail_json( msg = " Error in authenticating to nova: %s" % e.message)
neutron = _get_neutron_client(module, module.params)
state, floating_ip_id = _get_floating_ip_id(module, neutron)
2013-05-23 04:25:05 +02:00
if module.params['state'] == 'present':
if state == 'attached':
module.exit_json(changed = False, result = 'attached', public_ip=module.params['ip_address'])
server_info, server_obj = _get_server_state(module, nova)
if not server_info:
2013-06-01 17:53:57 +02:00
module.fail_json(msg = " The instance name provided cannot be found")
port_id = _get_port_id(neutron, module, server_info['id'])
if not port_id:
module.fail_json(msg = "Cannot find a port for this instance, maybe fixed ip is not assigned")
_update_floating_ip(neutron, module, port_id, floating_ip_id)
2013-05-23 04:25:05 +02:00
if module.params['state'] == 'absent':
if state == 'detached':
module.exit_json(changed = False, result = 'detached')
if state == 'attached':
_update_floating_ip(neutron, module, None, floating_ip_id)
2013-06-01 17:53:57 +02:00
module.exit_json(changed = True, result = "detached")
2013-05-23 04:25:05 +02:00
# this is magic, see lib/ansible/module.params['common.py
from ansible.module_utils.basic import *
from ansible.module_utils.openstack import *
2013-05-23 04:25:05 +02:00
main()