diff options
Diffstat (limited to 'lib/ansible/module_utils/dimensiondata.py')
| -rw-r--r-- | lib/ansible/module_utils/dimensiondata.py | 338 |
1 files changed, 0 insertions, 338 deletions
diff --git a/lib/ansible/module_utils/dimensiondata.py b/lib/ansible/module_utils/dimensiondata.py deleted file mode 100644 index 179c3eff9c..0000000000 --- a/lib/ansible/module_utils/dimensiondata.py +++ /dev/null @@ -1,338 +0,0 @@ -# -*- coding: utf-8 -*- -# -# Copyright (c) 2016 Dimension Data -# -# 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/>. -# -# Authors: -# - Aimon Bustardo <aimon.bustardo@dimensiondata.com> -# - Mark Maglana <mmaglana@gmail.com> -# - Adam Friedman <tintoy@tintoy.io> -# -# Common functionality to be used by versious module components - -import os -import re -import traceback - -from ansible.module_utils.basic import AnsibleModule, missing_required_lib -from ansible.module_utils.six.moves import configparser -from os.path import expanduser -from uuid import UUID - -LIBCLOUD_IMP_ERR = None -try: - from libcloud.common.dimensiondata import API_ENDPOINTS, DimensionDataAPIException, DimensionDataStatus - from libcloud.compute.base import Node, NodeLocation - from libcloud.compute.providers import get_driver - from libcloud.compute.types import Provider - - import libcloud.security - - HAS_LIBCLOUD = True -except ImportError: - LIBCLOUD_IMP_ERR = traceback.format_exc() - HAS_LIBCLOUD = False - -# MCP 2.x version patten for location (datacenter) names. -# -# Note that this is not a totally reliable way of determining MCP version. -# Unfortunately, libcloud's NodeLocation currently makes no provision for extended properties. -# At some point we may therefore want to either enhance libcloud or enable overriding mcp_version -# by specifying it in the module parameters. -MCP_2_LOCATION_NAME_PATTERN = re.compile(r".*MCP\s?2.*") - - -class DimensionDataModule(object): - """ - The base class containing common functionality used by Dimension Data modules for Ansible. - """ - - def __init__(self, module): - """ - Create a new DimensionDataModule. - - Will fail if Apache libcloud is not present. - - :param module: The underlying Ansible module. - :type module: AnsibleModule - """ - - self.module = module - - if not HAS_LIBCLOUD: - self.module.fail_json(msg=missing_required_lib('libcloud'), exception=LIBCLOUD_IMP_ERR) - - # Credentials are common to all Dimension Data modules. - credentials = self.get_credentials() - self.user_id = credentials['user_id'] - self.key = credentials['key'] - - # Region and location are common to all Dimension Data modules. - region = self.module.params['region'] - self.region = 'dd-{0}'.format(region) - self.location = self.module.params['location'] - - libcloud.security.VERIFY_SSL_CERT = self.module.params['validate_certs'] - - self.driver = get_driver(Provider.DIMENSIONDATA)( - self.user_id, - self.key, - region=self.region - ) - - # Determine the MCP API version (this depends on the target datacenter). - self.mcp_version = self.get_mcp_version(self.location) - - # Optional "wait-for-completion" arguments - if 'wait' in self.module.params: - self.wait = self.module.params['wait'] - self.wait_time = self.module.params['wait_time'] - self.wait_poll_interval = self.module.params['wait_poll_interval'] - else: - self.wait = False - self.wait_time = 0 - self.wait_poll_interval = 0 - - def get_credentials(self): - """ - Get user_id and key from module configuration, environment, or dotfile. - Order of priority is module, environment, dotfile. - - To set in environment: - - export MCP_USER='myusername' - export MCP_PASSWORD='mypassword' - - To set in dot file place a file at ~/.dimensiondata with - the following contents: - - [dimensiondatacloud] - MCP_USER: myusername - MCP_PASSWORD: mypassword - """ - - if not HAS_LIBCLOUD: - self.module.fail_json(msg='libcloud is required for this module.') - - user_id = None - key = None - - # First, try the module configuration - if 'mcp_user' in self.module.params: - if 'mcp_password' not in self.module.params: - self.module.fail_json( - msg='"mcp_user" parameter was specified, but not "mcp_password" (either both must be specified, or neither).' - ) - - user_id = self.module.params['mcp_user'] - key = self.module.params['mcp_password'] - - # Fall back to environment - if not user_id or not key: - user_id = os.environ.get('MCP_USER', None) - key = os.environ.get('MCP_PASSWORD', None) - - # Finally, try dotfile (~/.dimensiondata) - if not user_id or not key: - home = expanduser('~') - config = configparser.RawConfigParser() - config.read("%s/.dimensiondata" % home) - - try: - user_id = config.get("dimensiondatacloud", "MCP_USER") - key = config.get("dimensiondatacloud", "MCP_PASSWORD") - except (configparser.NoSectionError, configparser.NoOptionError): - pass - - # One or more credentials not found. Function can't recover from this - # so it has to raise an error instead of fail silently. - if not user_id: - raise MissingCredentialsError("Dimension Data user id not found") - elif not key: - raise MissingCredentialsError("Dimension Data key not found") - - # Both found, return data - return dict(user_id=user_id, key=key) - - def get_mcp_version(self, location): - """ - Get the MCP version for the specified location. - """ - - location = self.driver.ex_get_location_by_id(location) - if MCP_2_LOCATION_NAME_PATTERN.match(location.name): - return '2.0' - - return '1.0' - - def get_network_domain(self, locator, location): - """ - Retrieve a network domain by its name or Id. - """ - - if is_uuid(locator): - network_domain = self.driver.ex_get_network_domain(locator) - else: - matching_network_domains = [ - network_domain for network_domain in self.driver.ex_list_network_domains(location=location) - if network_domain.name == locator - ] - - if matching_network_domains: - network_domain = matching_network_domains[0] - else: - network_domain = None - - if network_domain: - return network_domain - - raise UnknownNetworkError("Network '%s' could not be found" % locator) - - def get_vlan(self, locator, location, network_domain): - """ - Get a VLAN object by its name or id - """ - if is_uuid(locator): - vlan = self.driver.ex_get_vlan(locator) - else: - matching_vlans = [ - vlan for vlan in self.driver.ex_list_vlans(location, network_domain) - if vlan.name == locator - ] - - if matching_vlans: - vlan = matching_vlans[0] - else: - vlan = None - - if vlan: - return vlan - - raise UnknownVLANError("VLAN '%s' could not be found" % locator) - - @staticmethod - def argument_spec(**additional_argument_spec): - """ - Build an argument specification for a Dimension Data module. - :param additional_argument_spec: An optional dictionary representing the specification for additional module arguments (if any). - :return: A dict containing the argument specification. - """ - - spec = dict( - region=dict(type='str', default='na'), - mcp_user=dict(type='str', required=False), - mcp_password=dict(type='str', required=False, no_log=True), - location=dict(type='str', required=True), - validate_certs=dict(type='bool', required=False, default=True) - ) - - if additional_argument_spec: - spec.update(additional_argument_spec) - - return spec - - @staticmethod - def argument_spec_with_wait(**additional_argument_spec): - """ - Build an argument specification for a Dimension Data module that includes "wait for completion" arguments. - :param additional_argument_spec: An optional dictionary representing the specification for additional module arguments (if any). - :return: A dict containing the argument specification. - """ - - spec = DimensionDataModule.argument_spec( - wait=dict(type='bool', required=False, default=False), - wait_time=dict(type='int', required=False, default=600), - wait_poll_interval=dict(type='int', required=False, default=2) - ) - - if additional_argument_spec: - spec.update(additional_argument_spec) - - return spec - - @staticmethod - def required_together(*additional_required_together): - """ - Get the basic argument specification for Dimension Data modules indicating which arguments are must be specified together. - :param additional_required_together: An optional list representing the specification for additional module arguments that must be specified together. - :return: An array containing the argument specifications. - """ - - required_together = [ - ['mcp_user', 'mcp_password'] - ] - - if additional_required_together: - required_together.extend(additional_required_together) - - return required_together - - -class LibcloudNotFound(Exception): - """ - Exception raised when Apache libcloud cannot be found. - """ - - pass - - -class MissingCredentialsError(Exception): - """ - Exception raised when credentials for Dimension Data CloudControl cannot be found. - """ - - pass - - -class UnknownNetworkError(Exception): - """ - Exception raised when a network or network domain cannot be found. - """ - - pass - - -class UnknownVLANError(Exception): - """ - Exception raised when a VLAN cannot be found. - """ - - pass - - -def get_dd_regions(): - """ - Get the list of available regions whose vendor is Dimension Data. - """ - - # Get endpoints - all_regions = API_ENDPOINTS.keys() - - # Only Dimension Data endpoints (no prefix) - regions = [region[3:] for region in all_regions if region.startswith('dd-')] - - return regions - - -def is_uuid(u, version=4): - """ - Test if valid v4 UUID - """ - try: - uuid_obj = UUID(u, version=version) - - return str(uuid_obj) == u - except ValueError: - return False |