mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
ab52efc7fb
The quantum_* modules will now try neutronclient first, and fall back to quantumclient. If that fails, error out. The code now references neutron instead of quantum in all internal cases.
253 lines
8.4 KiB
Python
253 lines
8.4 KiB
Python
#!/usr/bin/python
|
|
#coding: utf-8 -*-
|
|
|
|
# (c) 2013, Benno Joy <benno@ansibleworks.com>
|
|
#
|
|
# 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
|
|
from keystoneclient.v2_0 import client as ksclient
|
|
except ImportError:
|
|
print("failed=True msg='quantumclient (or neutronclient) and keystone client are required'")
|
|
DOCUMENTATION = '''
|
|
---
|
|
module: quantum_router_interface
|
|
version_added: "1.2"
|
|
short_description: Attach/Dettach a subnet's interface to a router
|
|
description:
|
|
- Attach/Dettach a subnet interface to a router, to provide a gateway for the subnet.
|
|
options:
|
|
login_username:
|
|
description:
|
|
- login username to authenticate to keystone
|
|
required: true
|
|
default: admin
|
|
login_password:
|
|
description:
|
|
- Password of login user
|
|
required: true
|
|
default: 'yes'
|
|
login_tenant_name:
|
|
description:
|
|
- The tenant name of the login user
|
|
required: true
|
|
default: 'yes'
|
|
auth_url:
|
|
description:
|
|
- The keystone URL for authentication
|
|
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 subnet's interface should be attached.
|
|
required: true
|
|
default: None
|
|
subnet_name:
|
|
description:
|
|
- Name of the subnet to whose interface should be attached to the router.
|
|
required: true
|
|
default: None
|
|
tenant_name:
|
|
description:
|
|
- Name of the tenant whose subnet has to be attached.
|
|
required: false
|
|
default: None
|
|
requirements: ["quantumclient", "keystoneclient"]
|
|
'''
|
|
|
|
EXAMPLES = '''
|
|
# Attach tenant1's subnet to the external router
|
|
- quantum_router_interface: state=present login_username=admin
|
|
login_password=admin
|
|
login_tenant_name=admin
|
|
tenant_name=tenant1
|
|
router_name=external_route
|
|
subnet_name=t1subnet
|
|
'''
|
|
|
|
|
|
_os_keystone = None
|
|
_os_tenant_id = 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 as e:
|
|
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 as e:
|
|
module.fail_json(msg = "Error getting network endpoint: %s" % e.message)
|
|
return endpoint
|
|
|
|
def _get_neutron_client(module, kwargs):
|
|
_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 as e:
|
|
module.fail_json(msg = "Error in connecting to neutron: %s " % e.message)
|
|
return neutron
|
|
|
|
def _set_tenant_id(module):
|
|
global _os_tenant_id
|
|
if not module.params['tenant_name']:
|
|
login_tenant_name = module.params['login_tenant_name']
|
|
else:
|
|
login_tenant_name = module.params['tenant_name']
|
|
|
|
for tenant in _os_keystone.tenants.list():
|
|
if tenant.name == login_tenant_name:
|
|
_os_tenant_id = tenant.id
|
|
break
|
|
if not _os_tenant_id:
|
|
module.fail_json(msg = "The tenant id cannot be found, please check the paramters")
|
|
|
|
|
|
def _get_router_id(module, neutron):
|
|
kwargs = {
|
|
'name': module.params['router_name'],
|
|
}
|
|
try:
|
|
routers = neutron.list_routers(**kwargs)
|
|
except Exception as e:
|
|
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_subnet_id(module, neutron):
|
|
subnet_id = None
|
|
kwargs = {
|
|
'tenant_id': _os_tenant_id,
|
|
'name': module.params['subnet_name'],
|
|
}
|
|
try:
|
|
subnets = neutron.list_subnets(**kwargs)
|
|
except Exception as e:
|
|
module.fail_json( msg = " Error in getting the subnet list:%s " % e.message)
|
|
if not subnets['subnets']:
|
|
return None
|
|
return subnets['subnets'][0]['id']
|
|
|
|
def _get_port_id(neutron, module, router_id, subnet_id):
|
|
kwargs = {
|
|
'tenant_id': _os_tenant_id,
|
|
'device_id': router_id,
|
|
}
|
|
try:
|
|
ports = neutron.list_ports(**kwargs)
|
|
except Exception as e:
|
|
module.fail_json( msg = "Error in listing ports: %s" % e.message)
|
|
if not ports['ports']:
|
|
return None
|
|
for port in ports['ports']:
|
|
for subnet in port['fixed_ips']:
|
|
if subnet['subnet_id'] == subnet_id:
|
|
return port['id']
|
|
return None
|
|
|
|
def _add_interface_router(neutron, module, router_id, subnet_id):
|
|
kwargs = {
|
|
'subnet_id': subnet_id
|
|
}
|
|
try:
|
|
neutron.add_interface_router(router_id, kwargs)
|
|
except Exception as e:
|
|
module.fail_json(msg = "Error in adding interface to router: %s" % e.message)
|
|
return True
|
|
|
|
def _remove_interface_router(neutron, module, router_id, subnet_id):
|
|
kwargs = {
|
|
'subnet_id': subnet_id
|
|
}
|
|
try:
|
|
neutron.remove_interface_router(router_id, kwargs)
|
|
except Exception as e:
|
|
module.fail_json(msg="Error in removing interface from router: %s" % e.message)
|
|
return True
|
|
|
|
def main():
|
|
module = AnsibleModule(
|
|
argument_spec = dict(
|
|
login_username = dict(default='admin'),
|
|
login_password = dict(required=True),
|
|
login_tenant_name = dict(required='True'),
|
|
auth_url = dict(default='http://127.0.0.1:35357/v2.0/'),
|
|
region_name = dict(default=None),
|
|
router_name = dict(required=True),
|
|
subnet_name = dict(required=True),
|
|
tenant_name = dict(default=None),
|
|
state = dict(default='present', choices=['absent', 'present']),
|
|
),
|
|
)
|
|
|
|
neutron = _get_neutron_client(module, module.params)
|
|
_set_tenant_id(module)
|
|
|
|
router_id = _get_router_id(module, neutron)
|
|
if not router_id:
|
|
module.fail_json(msg="failed to get the router id, please check the router name")
|
|
|
|
subnet_id = _get_subnet_id(module, neutron)
|
|
if not subnet_id:
|
|
module.fail_json(msg="failed to get the subnet id, please check the subnet name")
|
|
|
|
if module.params['state'] == 'present':
|
|
port_id = _get_port_id(neutron, module, router_id, subnet_id)
|
|
if not port_id:
|
|
_add_interface_router(neutron, module, router_id, subnet_id)
|
|
module.exit_json(changed=True, result="created", id=port_id)
|
|
module.exit_json(changed=False, result="success", id=port_id)
|
|
|
|
if module.params['state'] == 'absent':
|
|
port_id = _get_port_id(neutron, module, router_id, subnet_id)
|
|
if not port_id:
|
|
module.exit_json(changed = False, result = "Success")
|
|
_remove_interface_router(neutron, module, router_id, subnet_id)
|
|
module.exit_json(changed=True, result="Deleted")
|
|
|
|
# this is magic, see lib/ansible/module.params['common.py
|
|
from ansible.module_utils.basic import *
|
|
main()
|
|
|