ansible/cloud/quantum_router_gateway.py

214 lines
7.1 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:
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
except ImportError:
print("failed=True msg='quantumclient (or neutronclient) and keystone client are required'")
2013-05-23 04:25:05 +02:00
DOCUMENTATION = '''
---
module: quantum_router_gateway
version_added: "1.2"
2013-05-23 04:25:05 +02:00
short_description: set/unset a gateway interface for the router with the specified external network
description:
- Creates/Removes a gateway interface from the router, used to associate a external network with a router to route external traffic.
options:
login_username:
description:
- login username to authenticate to keystone
required: true
default: admin
login_password:
description:
- Password of login user
required: true
2013-06-01 18:02:47 +02:00
default: 'yes'
2013-05-23 04:25:05 +02:00
login_tenant_name:
description:
- The tenant name of the login user
required: true
2013-06-01 18:02:47 +02:00
default: 'yes'
2013-05-23 04:25:05 +02:00
auth_url:
description:
- 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:
- Name of the region
required: false
default: None
state:
description:
- Indicate desired state of the resource
choices: ['present', 'absent']
default: present
router_name:
description:
- Name of the router to which the gateway should be attached.
required: true
default: None
network_name:
description:
- Name of the external network which should be attached to the router.
required: true
default: None
requirements: ["quantumclient", "neutronclient", "keystoneclient"]
2013-05-23 04:25:05 +02:00
'''
EXAMPLES = '''
# Attach an external network with a router to allow flow of external traffic
- quantum_router_gateway: state=present login_username=admin login_password=admin
login_tenant_name=admin router_name=external_router
network_name=external_network
'''
2013-05-23 04:25:05 +02:00
_os_keystone = None
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
2013-05-23 04:25:05 +02:00
_os_keystone = kclient
return kclient
2013-05-23 04:25:05 +02:00
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
2013-05-23 04:25:05 +02:00
}
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_router_id(module, neutron):
2013-05-23 04:25:05 +02:00
kwargs = {
'name': module.params['router_name'],
}
try:
routers = neutron.list_routers(**kwargs)
except Exception, e:
2013-05-23 04:25:05 +02:00
module.fail_json(msg = "Error in getting the router list: %s " % e.message)
if not routers['routers']:
return None
return routers['routers'][0]['id']
def _get_net_id(neutron, module):
2013-05-23 04:25:05 +02:00
kwargs = {
2013-06-01 18:02:47 +02:00
'name': module.params['network_name'],
'router:external': True
2013-05-23 04:25:05 +02:00
}
try:
networks = neutron.list_networks(**kwargs)
except Exception, e:
module.fail_json("Error in listing neutron networks: %s" % e.message)
2013-05-23 04:25:05 +02:00
if not networks['networks']:
return None
return networks['networks'][0]['id']
def _get_port_id(neutron, module, router_id, network_id):
2013-05-23 04:25:05 +02:00
kwargs = {
2013-06-01 18:02:47 +02:00
'device_id': router_id,
'network_id': network_id,
2013-05-23 04:25:05 +02:00
}
try:
ports = neutron.list_ports(**kwargs)
except Exception, e:
module.fail_json( msg = "Error in listing ports: %s" % e.message)
2013-05-23 04:25:05 +02:00
if not ports['ports']:
return None
2013-05-23 04:25:05 +02:00
return ports['ports'][0]['id']
def _add_gateway_router(neutron, module, router_id, network_id):
2013-05-23 04:25:05 +02:00
kwargs = {
2013-06-01 18:02:47 +02:00
'network_id': network_id
2013-05-23 04:25:05 +02:00
}
try:
neutron.add_gateway_router(router_id, kwargs)
except Exception, e:
module.fail_json(msg = "Error in adding gateway to router: %s" % e.message)
2013-05-23 04:25:05 +02:00
return True
def _remove_gateway_router(neutron, module, router_id):
2013-05-23 04:25:05 +02:00
try:
neutron.remove_gateway_router(router_id)
except Exception, e:
2013-06-01 18:02:47 +02:00
module.fail_json(msg = "Error in removing gateway to router: %s" % e.message)
2013-05-23 04:25:05 +02:00
return True
2013-05-23 04:25:05 +02:00
def main():
argument_spec = openstack_argument_spec()
argument_spec.update(dict(
2013-06-01 18:02:47 +02:00
router_name = dict(required=True),
network_name = dict(required=True),
state = dict(default='present', choices=['absent', 'present']),
))
module = AnsibleModule(argument_spec=argument_spec)
neutron = _get_neutron_client(module, module.params)
router_id = _get_router_id(module, neutron)
2013-06-01 18:02:47 +02:00
2013-05-23 04:25:05 +02:00
if not router_id:
2013-06-01 18:02:47 +02:00
module.fail_json(msg="failed to get the router id, please check the router name")
network_id = _get_net_id(neutron, module)
2013-05-23 04:25:05 +02:00
if not network_id:
2013-06-01 18:02:47 +02:00
module.fail_json(msg="failed to get the network id, please check the network name and make sure it is external")
2013-05-23 04:25:05 +02:00
if module.params['state'] == 'present':
port_id = _get_port_id(neutron, module, router_id, network_id)
if not port_id:
_add_gateway_router(neutron, module, router_id, network_id)
2013-06-01 18:02:47 +02:00
module.exit_json(changed=True, result="created")
module.exit_json(changed=False, result="success")
2013-05-23 04:25:05 +02:00
if module.params['state'] == 'absent':
port_id = _get_port_id(neutron, module, router_id, network_id)
if not port_id:
2013-06-01 18:02:47 +02:00
module.exit_json(changed=False, result="Success")
_remove_gateway_router(neutron, module, router_id)
2013-06-01 18:02:47 +02:00
module.exit_json(changed=True, result="Deleted")
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()