adds the bigip_ucs module (#26663)

This module allows you to load existing UCS files onto a BIG-IP system Unit tests are provided. Integration tests can be found here https://github.com/F5Networks/f5-ansible/blob/devel/test/integration/bigip_ucs.yaml#L23 https://github.com/F5Networks/f5-ansible/tree/devel/test/integration/targets/bigip_ucs/tasks
7 years ago · 75e609c15e
parent 72f41148a0
commit 75e609c15e
2 changed files with 1023 additions and 0 deletions
--- a/lib/ansible/modules/network/f5/bigip_ucs.py
+++ b/lib/ansible/modules/network/f5/bigip_ucs.py
@ -0,0 +1,614 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+#
+# Copyright 2017 F5 Networks Inc.
+#
+# This file is part of Ansible
+#
+# Ansible 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.
+#
+# Ansible 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 Ansible.  If not, see <http://www.gnu.org/licenses/>.
+
+ANSIBLE_METADATA = {
+    'status': ['preview'],
+    'supported_by': 'community',
+    'metadata_version': '1.0'
+}
+
+DOCUMENTATION = '''
+---
+module: bigip_ucs
+short_description: Manage upload, installation and removal of UCS files.
+description:
+   - Manage upload, installation and removal of UCS files.
+version_added: "2.4"
+options:
+  include_chassis_level_config:
+    description:
+      - During restore of the UCS file, include chassis level configuration
+        that is shared among boot volume sets. For example, cluster default
+        configuration.
+    choices:
+      - yes
+      - no
+  ucs:
+    description:
+      - The path to the UCS file to install. The parameter must be
+        provided if the C(state) is either C(installed) or C(activated).
+        When C(state) is C(absent), the full path for this parameter will be
+        ignored and only the filename will be used to select a UCS for removal.
+        Therefore you could specify C(/mickey/mouse/test.ucs) and this module
+        would only look for C(test.ucs).
+  force:
+    description:
+      - If C(yes) will upload the file every time and replace the file on the
+        device. If C(no), the file will only be uploaded if it does not already
+        exist. Generally should be C(yes) only in cases where you have reason
+        to believe that the image was corrupted during upload.
+    choices:
+      - yes
+      - no
+  no_license:
+    description:
+      - Performs a full restore of the UCS file and all the files it contains,
+        with the exception of the license file. The option must be used to
+        restore a UCS on RMA devices (Returned Materials Authorization).
+    choices:
+      - yes
+      - no
+  no_platform_check:
+    description:
+      - Bypasses the platform check and allows a UCS that was created using a
+        different platform to be installed. By default (without this option),
+        a UCS created from a different platform is not allowed to be installed.
+    choices:
+      - yes
+      - no
+  passphrase:
+    description:
+      - Specifies the passphrase that is necessary to load the specified UCS file.
+    choices:
+      - yes
+      - no
+  reset_trust:
+    description:
+      - When specified, the device and trust domain certs and keys are not
+        loaded from the UCS. Instead, a new set is regenerated.
+    choices:
+      - yes
+      - no
+  state:
+    description:
+      - When C(installed), ensures that the UCS is uploaded and installed,
+        on the system. When C(present), ensures that the UCS is uploaded.
+        When C(absent), the UCS will be removed from the system. When
+        C(installed), the uploading of the UCS is idempotent, however the
+        installation of that configuration is not idempotent.
+    default: present
+    choices:
+      - absent
+      - installed
+      - present
+notes:
+   - Requires the f5-sdk Python package on the host. This is as easy as
+     pip install f5-sdk.
+   - Only the most basic checks are performed by this module. Other checks and
+     considerations need to be taken into account. See the following URL.
+     https://support.f5.com/kb/en-us/solutions/public/11000/300/sol11318.html
+   - This module does not handle devices with the FIPS 140 HSM
+   - This module does not handle BIG-IPs systems on the 6400, 6800, 8400, or
+     8800 hardware platform.
+   - This module does not verify that the new or replaced SSH keys from the
+     UCS file are synchronized between the BIG-IP system and the SCCP
+   - This module does not support the 'rma' option
+   - This module does not support restoring a UCS archive on a BIG-IP 1500,
+     3400, 4100, 6400, 6800, or 8400 hardware platform other than the system
+     from which the backup was created
+   - The UCS restore operation restores the full configuration only if the
+     hostname of the target system matches the hostname on which the UCS
+     archive was created. If the hostname does not match, only the shared
+     configuration is restored. You can ensure hostnames match by using
+     the C(bigip_hostname) Ansible module in a task before using this module.
+   - This module does not support re-licensing a BIG-IP restored from a UCS
+   - This module does not support restoring encrypted archives on replacement
+     RMA units.
+extends_documentation_fragment: f5
+requirements:
+  - f5-sdk
+author:
+  - Tim Rupp (@caphrim007)
+'''
+
+EXAMPLES = '''
+- name: Upload UCS
+  bigip_ucs:
+      server: "lb.mydomain.com"
+      user: "admin"
+      password: "secret"
+      ucs: "/root/bigip.localhost.localdomain.ucs"
+      state: "present"
+  delegate_to: localhost
+
+- name: Install (upload, install) UCS.
+  bigip_ucs:
+      server: "lb.mydomain.com"
+      user: "admin"
+      password: "secret"
+      ucs: "/root/bigip.localhost.localdomain.ucs"
+      state: "installed"
+  delegate_to: localhost
+
+- name: Install (upload, install) UCS without installing the license portion
+  bigip_ucs:
+      server: "lb.mydomain.com"
+      user: "admin"
+      password: "secret"
+      ucs: "/root/bigip.localhost.localdomain.ucs"
+      state: "installed"
+      no_license: "yes"
+  delegate_to: localhost
+
+- name: Install (upload, install) UCS except the license, and bypassing the platform check
+  bigip_ucs:
+      server: "lb.mydomain.com"
+      user: "admin"
+      password: "secret"
+      ucs: "/root/bigip.localhost.localdomain.ucs"
+      state: "installed"
+      no_license: "yes"
+      no_platform_check: "yes"
+  delegate_to: localhost
+
+- name: Install (upload, install) UCS using a passphrase necessary to load the UCS
+  bigip_ucs:
+      server: "lb.mydomain.com"
+      user: "admin"
+      password: "secret"
+      ucs: "/root/bigip.localhost.localdomain.ucs"
+      state: "installed"
+      passphrase: "MyPassphrase1234"
+  delegate_to: localhost
+
+- name: Remove uploaded UCS file
+  bigip_ucs:
+      server: "lb.mydomain.com"
+      user: "admin"
+      password: "secret"
+      ucs: "bigip.localhost.localdomain.ucs"
+      state: "absent"
+  delegate_to: localhost
+'''
+
+RETURN = '''
+# only common fields returned
+'''
+
+import os
+import re
+import time
+
+from collections import OrderedDict
+from distutils.version import LooseVersion
+from ansible.module_utils.f5_utils import (
+    AnsibleF5Client,
+    AnsibleF5Parameters,
+    HAS_F5SDK,
+    F5ModuleError,
+    iControlUnexpectedHTTPError,
+    iteritems
+)
+
+
+class Parameters(AnsibleF5Parameters):
+    api_map = {}
+    updatables = []
+    returnables = []
+    api_attributes = []
+
+    def _check_required_if(self, parameter):
+        if self._values[parameter] is not True:
+            return self._values[parameter]
+        if self.state != 'installed':
+            raise F5ModuleError(
+                '"{0}" parameters requires "installed" state'.format(parameter)
+            )
+
+    @property
+    def basename(self):
+        return os.path.basename(self.ucs)
+
+    @property
+    def options(self):
+        return {
+            'include-chassis-level-config': self.include_chassis_level_config,
+            'no-license': self.no_license,
+            'no-platform-check': self.no_platform_check,
+            'passphrase': self.passphrase,
+            'reset-trust': self.reset_trust
+        }
+
+    @property
+    def reset_trust(self):
+        self._check_required_if('reset_trust')
+        return self._values['reset_trust']
+
+    @property
+    def passphrase(self):
+        self._check_required_if('passphrase')
+        return self._values['passphrase']
+
+    @property
+    def no_platform_check(self):
+        self._check_required_if('no_platform_check')
+        return self._values['no_platform_check']
+
+    @property
+    def no_license(self):
+        self._check_required_if('no_license')
+        return self._values['no_license']
+
+    @property
+    def include_chassis_level_config(self):
+        self._check_required_if('include_chassis_level_config')
+        return self._values['include_chassis_level_config']
+
+    @property
+    def install_command(self):
+        cmd = 'tmsh load sys ucs /var/local/ucs/{0}'.format(self.basename)
+        # Append any options that might be specified
+        options = OrderedDict(sorted(self.options.items(), key=lambda t: t[0]))
+        print(options)
+        for k, v in iteritems(options):
+            if v is False or v is None:
+                continue
+            elif k == 'passphrase':
+                cmd += ' %s %s' % (k, v)
+            else:
+                cmd += ' %s' % (k)
+        return cmd
+
+    def to_return(self):
+        result = {}
+        for returnable in self.returnables:
+            result[returnable] = getattr(self, returnable)
+        result = self._filter_params(result)
+        return result
+
+    def api_params(self):
+        result = {}
+        for api_attribute in self.api_attributes:
+            if self.api_map is not None and api_attribute in self.api_map:
+                result[api_attribute] = getattr(self, self.api_map[api_attribute])
+            else:
+                result[api_attribute] = getattr(self, api_attribute)
+        result = self._filter_params(result)
+        return result
+
+
+class ModuleManager(object):
+    def __init__(self, client):
+        self.client = client
+
+    def exec_module(self):
+        if self.is_version_v1():
+            manager = V1Manager(self.client)
+        else:
+            manager = V2Manager(self.client)
+
+        return manager.exec_module()
+
+    def is_version_v1(self):
+        """Checks to see if the TMOS version is less than 12.1.0
+
+        Versions prior to 12.1.0 have a bug which prevents the REST
+        API from properly listing any UCS files when you query the
+        /mgmt/tm/sys/ucs endpoint. Therefore you need to do everything
+        through tmsh over REST.
+
+        :return: Bool
+        """
+        version = self.client.api.tmos_version
+        if LooseVersion(version) < LooseVersion('12.1.0'):
+            return True
+        else:
+            return False
+
+
+class BaseManager(object):
+    def __init__(self, client):
+        self.client = client
+        self.have = None
+        self.want = Parameters(self.client.module.params)
+        self.changes = Parameters()
+
+    def exec_module(self):
+        changed = False
+        result = dict()
+        state = self.want.state
+
+        try:
+            if state in ['present', 'installed']:
+                changed = self.present()
+            elif state == "absent":
+                changed = self.absent()
+        except iControlUnexpectedHTTPError as e:
+            raise F5ModuleError(str(e))
+
+        changes = self.changes.to_return()
+        result.update(**changes)
+        result.update(dict(changed=changed))
+        return result
+
+    def present(self):
+        if self.exists():
+            return self.update()
+        else:
+            return self.create()
+
+    def update(self):
+        if self.client.check_mode:
+            if self.want.force:
+                return True
+            return False
+        elif self.want.force:
+            self.remove()
+            return self.create()
+        elif self.want.state == 'installed':
+            return self.install_on_device()
+        else:
+            return False
+
+    def create(self):
+        if self.client.check_mode:
+            return True
+        self.create_on_device()
+        if not self.exists():
+            raise F5ModuleError("Failed to upload the UCS file")
+        if self.want.state == 'installed':
+            self.install_on_device()
+        return True
+
+    def absent(self):
+        if self.exists():
+            return self.remove()
+        return False
+
+    def should_update(self):
+        result = self._update_changed_options()
+        if result:
+            return True
+        return False
+
+    def remove(self):
+        if self.client.check_mode:
+            return True
+        self.remove_from_device()
+        if self.exists():
+            raise F5ModuleError("Failed to delete the UCS file")
+        return True
+
+    def wait_for_rest_api_restart(self):
+        time.sleep(5)
+        for x in xrange(0, 60):
+            try:
+                self.client.reconnect()
+                break
+            except Exception:
+                time.sleep(3)
+
+    def wait_for_configuration_reload(self):
+        noops = 0
+        while noops < 4:
+            time.sleep(3)
+            try:
+                output = self.client.api.tm.util.bash.exec_cmd(
+                    'run',
+                    utilCmdArgs='-c "tmsh show sys mcp-state"'
+                )
+            except Exception as ex:
+                # This can be caused by restjavad restarting.
+                continue
+
+            if not hasattr(output, 'commandResult'):
+                continue
+
+            # Need to re-connect here because the REST framework will be restarting
+            # and thus be clearing its authorization cache
+            result = output.commandResult
+            if self._is_config_reloading_failed_on_device(result):
+                raise F5ModuleError(
+                    "Failed to reload the configuration. This may be due "
+                    "to a cross-version incompatibility. {0}".format(result)
+                )
+            if self._is_config_reloading_success_on_device(result):
+                if self._is_config_reloading_running_on_device(result):
+                    noops += 1
+                    continue
+            noops = 0
+
+    def _is_config_reloading_success_on_device(self, output):
+        succeed = r'Last Configuration Load Status\s+full-config-load-succeed'
+        matches = re.search(succeed, output)
+        if matches:
+            return True
+        return False
+
+    def _is_config_reloading_running_on_device(self, output):
+        running = r'Running Phase\s+running'
+        matches = re.search(running, output)
+        if matches:
+            return True
+        return False
+
+    def _is_config_reloading_failed_on_device(self, output):
+        failed = r'Last Configuration Load Status\s+base-config-load-failed'
+        matches = re.search(failed, output)
+        if matches:
+            return True
+        return False
+
+
+class V1Manager(BaseManager):
+    """Manager class for V1 product
+
+    V1 products include versions of BIG-IP < 12.1.0, but >= 12.0.0.
+
+    These versions had a number of API deficiencies. These include, but
+    are not limited to,
+
+      * UCS collection endpoint listed no items
+      * No API to upload UCS files
+
+    """
+    def create_on_device(self):
+        remote_path = "/var/local/ucs"
+        tpath_name = '/var/config/rest/downloads'
+
+        upload = self.client.api.shared.file_transfer.uploads
+
+        try:
+            upload.upload_file(self.want.ucs)
+        except IOError as ex:
+            raise F5ModuleError(str(ex))
+
+        self.client.api.tm.util.unix_mv.exec_cmd(
+            'run',
+            utilCmdArgs='{0}/{2} {1}/{2}'.format(
+                tpath_name, remote_path, self.want.basename
+            )
+        )
+        return True
+
+    def read_current_from_device(self):
+        result = []
+        output = self.client.api.tm.util.bash.exec_cmd(
+            'run',
+            utilCmdArgs='-c "tmsh list sys ucs"'
+        )
+        if hasattr(output, 'commandResult'):
+            lines = output.commandResult.split("\n")
+            result = [x.strip() for x in lines]
+            result = list(set(result))
+        return result
+
+    def exists(self):
+        collection = self.read_current_from_device()
+        if self.want.basename in collection:
+            return True
+        return False
+
+    def remove_from_device(self):
+        output = self.client.api.tm.util.bash.exec_cmd(
+            'run',
+            utilCmdArgs='-c "tmsh delete sys ucs {0}"'.format(self.want.basename)
+        )
+        if hasattr(output, 'commandResult'):
+            if '{0} is deleted'.format(self.want.basename) in output.commandResult:
+                return True
+        return False
+
+    def install_on_device(self):
+        try:
+            self.client.api.tm.util.bash.exec_cmd(
+                'run',
+                utilCmdArgs='-c "{0}"'.format(self.want.install_command)
+            )
+        except Exception as ex:
+            # Reloading a UCS configuration will cause restjavad to restart,
+            # aborting the connection.
+            if 'Connection aborted' in str(ex):
+                pass
+            elif 'TimeoutException' in str(ex):
+                # Timeouts appear to be able to happen in 12.1.2
+                pass
+            else:
+                raise F5ModuleError(str(ex))
+        self.wait_for_rest_api_restart()
+        self.wait_for_configuration_reload()
+        return True
+
+
+class V2Manager(V1Manager):
+    """Manager class for V2 product
+
+    V2 products include versions of BIG-IP >= 12.1.0 but < 13.0.0.
+
+    These versions fixed the collection bug in V1, but had yet to add the
+    ability to upload files using a dedicated UCS upload API.
+
+    """
+
+    def read_current_from_device(self):
+        result = []
+        resource = self.client.api.tm.sys.ucs.load()
+        items = resource.attrs.get('items', [])
+        for item in items:
+            result.append(os.path.basename(item['apiRawValues']['filename']))
+        return result
+
+    def exists(self):
+        collection = self.read_current_from_device()
+        if self.want.basename in collection:
+            return True
+        return False
+
+
+class ArgumentSpec(object):
+    def __init__(self):
+        self.supports_check_mode = True
+        self.argument_spec = dict(
+            force=dict(
+                type='bool',
+                default='no'
+            ),
+            include_chassis_level_config=dict(
+                type='bool'
+            ),
+            no_license=dict(
+                type='bool'
+            ),
+            no_platform_check=dict(
+                type='bool'
+            ),
+            passphrase=dict(no_log=True),
+            reset_trust=dict(type='bool'),
+            state=dict(
+                default='present',
+                choices=['absent', 'installed', 'present']
+            ),
+            ucs=dict(required=True)
+        )
+        self.f5_product_name = 'bigip'
+
+
+def main():
+    if not HAS_F5SDK:
+        raise F5ModuleError("The python f5-sdk module is required")
+
+    spec = ArgumentSpec()
+
+    client = AnsibleF5Client(
+        argument_spec=spec.argument_spec,
+        supports_check_mode=spec.supports_check_mode,
+        f5_product_name=spec.f5_product_name
+    )
+
+    try:
+        mm = ModuleManager(client)
+        results = mm.exec_module()
+        client.module.exit_json(**results)
+    except F5ModuleError as e:
+        client.module.fail_json(msg=str(e))
+
+
+if __name__ == '__main__':
+    main()
--- a/test/units/modules/network/f5/test_bigip_ucs.py
+++ b/test/units/modules/network/f5/test_bigip_ucs.py
@ -0,0 +1,409 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright 2017 F5 Networks Inc.
+#
+# This file is part of Ansible
+#
+# Ansible 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.
+#
+# Ansible 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 Ansible.  If not, see <http://www.gnu.org/licenses/>.
+
+from __future__ import (absolute_import, division, print_function)
+__metaclass__ = type
+
+import os
+import json
+import pytest
+import sys
+
+from nose.plugins.skip import SkipTest
+if sys.version_info < (2, 7):
+    raise SkipTest("F5 Ansible modules require Python >= 2.7")
+
+from ansible.compat.tests import unittest
+from ansible.compat.tests.mock import patch, Mock
+from ansible.module_utils import basic
+from ansible.module_utils._text import to_bytes
+from ansible.module_utils.f5_utils import AnsibleF5Client
+from ansible.module_utils.f5_utils import F5ModuleError
+
+try:
+    from library.bigip_ucs import Parameters
+    from library.bigip_ucs import ModuleManager
+    from library.bigip_ucs import ArgumentSpec
+    from library.bigip_ucs import V1Manager
+    from library.bigip_ucs import V2Manager
+except ImportError:
+    try:
+        from ansible.modules.network.f5.bigip_ucs import Parameters
+        from ansible.modules.network.f5.bigip_ucs import ModuleManager
+        from ansible.modules.network.f5.bigip_ucs import ArgumentSpec
+        from ansible.modules.network.f5.bigip_ucs import V1Manager
+        from ansible.modules.network.f5.bigip_ucs import V2Manager
+    except ImportError:
+        raise SkipTest("F5 Ansible modules require the f5-sdk Python library")
+
+fixture_path = os.path.join(os.path.dirname(__file__), 'fixtures')
+fixture_data = {}
+
+
+def set_module_args(args):
+    args = json.dumps({'ANSIBLE_MODULE_ARGS': args})
+    basic._ANSIBLE_ARGS = to_bytes(args)
+
+
+def load_fixture(name):
+    path = os.path.join(fixture_path, name)
+
+    if path in fixture_data:
+        return fixture_data[path]
+
+    with open(path) as f:
+        data = f.read()
+
+    try:
+        data = json.loads(data)
+    except Exception:
+        pass
+
+    fixture_data[path] = data
+    return data
+
+
+class TestParameters(unittest.TestCase):
+    def test_module_parameters(self):
+        args = dict(
+            ucs="/root/bigip.localhost.localdomain.ucs",
+            force=True,
+            include_chassis_level_config=True,
+            no_license=True,
+            no_platform_check=True,
+            passphrase="foobar",
+            reset_trust=True,
+            state='installed'
+        )
+
+        p = Parameters(args)
+        assert p.ucs == '/root/bigip.localhost.localdomain.ucs'
+        assert p.force is True
+        assert p.include_chassis_level_config is True
+        assert p.no_license is True
+        assert p.no_platform_check is True
+        assert p.passphrase == "foobar"
+        assert p.reset_trust is True
+        assert p.install_command == \
+            "tmsh load sys ucs /var/local/ucs/bigip.localhost.localdomain.ucs " \
+            "include-chassis-level-config no-license no-platform-check " \
+            "passphrase foobar reset-trust"
+
+    def test_module_parameters_false_ucs_booleans(self):
+        args = dict(
+            ucs="/root/bigip.localhost.localdomain.ucs",
+            include_chassis_level_config=False,
+            no_license=False,
+            no_platform_check=False,
+            reset_trust=False
+        )
+
+        p = Parameters(args)
+        assert p.ucs == '/root/bigip.localhost.localdomain.ucs'
+        assert p.include_chassis_level_config is False
+        assert p.no_license is False
+        assert p.no_platform_check is False
+        assert p.reset_trust is False
+        assert p.install_command == "tmsh load sys ucs /var/local/ucs/bigip.localhost.localdomain.ucs"
+
+
+@patch('ansible.module_utils.f5_utils.AnsibleF5Client._get_mgmt_root',
+       return_value=True)
+class TestV1Manager(unittest.TestCase):
+
+    def setUp(self):
+        self.spec = ArgumentSpec()
+
+    def test_ucs_default_present(self, *args):
+        set_module_args(dict(
+            ucs="/root/bigip.localhost.localdomain.ucs",
+            server='localhost',
+            password='password',
+            user='admin'
+        ))
+
+        client = AnsibleF5Client(
+            argument_spec=self.spec.argument_spec,
+            supports_check_mode=self.spec.supports_check_mode,
+            f5_product_name=self.spec.f5_product_name
+        )
+
+        # Override methods to force specific logic in the module to happen
+        mm = ModuleManager(client)
+        mm.is_version_v1 = Mock(return_value=True)
+
+        vm = V1Manager(client)
+        vm.create_on_device = Mock(return_value=True)
+        vm.exists = Mock(side_effect=[False, True])
+
+        results = vm.exec_module()
+
+        assert results['changed'] is True
+
+    def test_ucs_explicit_present(self, *args):
+        set_module_args(dict(
+            ucs="/root/bigip.localhost.localdomain.ucs",
+            server='localhost',
+            password='password',
+            user='admin',
+            state='present'
+        ))
+
+        client = AnsibleF5Client(
+            argument_spec=self.spec.argument_spec,
+            supports_check_mode=self.spec.supports_check_mode,
+            f5_product_name=self.spec.f5_product_name
+        )
+
+        # Override methods to force specific logic in the module to happen
+        mm = ModuleManager(client)
+        mm.is_version_v1 = Mock(return_value=True)
+
+        vm = V1Manager(client)
+        vm.create_on_device = Mock(return_value=True)
+        vm.exists = Mock(side_effect=[False, True])
+
+        results = vm.exec_module()
+
+        assert results['changed'] is True
+
+    def test_ucs_installed(self, *args):
+        set_module_args(dict(
+            ucs="/root/bigip.localhost.localdomain.ucs",
+            server='localhost',
+            password='password',
+            user='admin',
+            state='installed'
+        ))
+
+        client = AnsibleF5Client(
+            argument_spec=self.spec.argument_spec,
+            supports_check_mode=self.spec.supports_check_mode,
+            f5_product_name=self.spec.f5_product_name
+        )
+
+        # Override methods to force specific logic in the module to happen
+        mm = ModuleManager(client)
+        mm.is_version_v1 = Mock(return_value=True)
+
+        vm = V1Manager(client)
+        vm.create_on_device = Mock(return_value=True)
+        vm.exists = Mock(return_value=True)
+        vm.install_on_device = Mock(return_value=True)
+
+        results = vm.exec_module()
+
+        assert results['changed'] is True
+
+    def test_ucs_absent_exists(self, *args):
+        set_module_args(dict(
+            ucs="/root/bigip.localhost.localdomain.ucs",
+            server='localhost',
+            password='password',
+            user='admin',
+            state='absent'
+        ))
+
+        client = AnsibleF5Client(
+            argument_spec=self.spec.argument_spec,
+            supports_check_mode=self.spec.supports_check_mode,
+            f5_product_name=self.spec.f5_product_name
+        )
+
+        # Override methods to force specific logic in the module to happen
+        mm = ModuleManager(client)
+        mm.is_version_v1 = Mock(return_value=True)
+
+        vm = V1Manager(client)
+        vm.remove_from_device = Mock(return_value=True)
+        vm.exists = Mock(side_effect=[True, False])
+
+        results = vm.exec_module()
+
+        assert results['changed'] is True
+
+    def test_ucs_absent_fails(self, *args):
+        set_module_args(dict(
+            ucs="/root/bigip.localhost.localdomain.ucs",
+            server='localhost',
+            password='password',
+            user='admin',
+            state='absent'
+        ))
+
+        client = AnsibleF5Client(
+            argument_spec=self.spec.argument_spec,
+            supports_check_mode=self.spec.supports_check_mode,
+            f5_product_name=self.spec.f5_product_name
+        )
+
+        # Override methods to force specific logic in the module to happen
+        mm = ModuleManager(client)
+        mm.is_version_v1 = Mock(return_value=True)
+
+        vm = V1Manager(client)
+        vm.remove_from_device = Mock(return_value=True)
+        vm.exists = Mock(side_effect=[True, True])
+
+        with pytest.raises(F5ModuleError) as ex:
+            vm.exec_module()
+        assert 'Failed to delete' in str(ex.value)
+
+
+@patch('ansible.module_utils.f5_utils.AnsibleF5Client._get_mgmt_root',
+       return_value=True)
+class TestV2Manager(unittest.TestCase):
+
+    def setUp(self):
+        self.spec = ArgumentSpec()
+
+    def test_ucs_default_present(self, *args):
+        set_module_args(dict(
+            ucs="/root/bigip.localhost.localdomain.ucs",
+            server='localhost',
+            password='password',
+            user='admin'
+        ))
+
+        client = AnsibleF5Client(
+            argument_spec=self.spec.argument_spec,
+            supports_check_mode=self.spec.supports_check_mode,
+            f5_product_name=self.spec.f5_product_name
+        )
+
+        # Override methods to force specific logic in the module to happen
+        mm = ModuleManager(client)
+        mm.is_version_v1 = Mock(return_value=False)
+
+        vm = V2Manager(client)
+        vm.create_on_device = Mock(return_value=True)
+        vm.exists = Mock(side_effect=[False, True])
+
+        results = vm.exec_module()
+
+        assert results['changed'] is True
+
+    def test_ucs_explicit_present(self, *args):
+        set_module_args(dict(
+            ucs="/root/bigip.localhost.localdomain.ucs",
+            server='localhost',
+            password='password',
+            user='admin',
+            state='present'
+        ))
+
+        client = AnsibleF5Client(
+            argument_spec=self.spec.argument_spec,
+            supports_check_mode=self.spec.supports_check_mode,
+            f5_product_name=self.spec.f5_product_name
+        )
+
+        # Override methods to force specific logic in the module to happen
+        mm = ModuleManager(client)
+        mm.is_version_v1 = Mock(return_value=False)
+
+        vm = V2Manager(client)
+        vm.create_on_device = Mock(return_value=True)
+        vm.exists = Mock(side_effect=[False, True])
+
+        results = vm.exec_module()
+
+        assert results['changed'] is True
+
+    def test_ucs_installed(self, *args):
+        set_module_args(dict(
+            ucs="/root/bigip.localhost.localdomain.ucs",
+            server='localhost',
+            password='password',
+            user='admin',
+            state='installed'
+        ))
+
+        client = AnsibleF5Client(
+            argument_spec=self.spec.argument_spec,
+            supports_check_mode=self.spec.supports_check_mode,
+            f5_product_name=self.spec.f5_product_name
+        )
+
+        # Override methods to force specific logic in the module to happen
+        mm = ModuleManager(client)
+        mm.is_version_v1 = Mock(return_value=False)
+
+        vm = V2Manager(client)
+        vm.create_on_device = Mock(return_value=True)
+        vm.exists = Mock(return_value=True)
+        vm.install_on_device = Mock(return_value=True)
+
+        results = vm.exec_module()
+
+        assert results['changed'] is True
+
+    def test_ucs_absent_exists(self, *args):
+        set_module_args(dict(
+            ucs="/root/bigip.localhost.localdomain.ucs",
+            server='localhost',
+            password='password',
+            user='admin',
+            state='absent'
+        ))
+
+        client = AnsibleF5Client(
+            argument_spec=self.spec.argument_spec,
+            supports_check_mode=self.spec.supports_check_mode,
+            f5_product_name=self.spec.f5_product_name
+        )
+
+        # Override methods to force specific logic in the module to happen
+        mm = ModuleManager(client)
+        mm.is_version_v1 = Mock(return_value=False)
+
+        vm = V1Manager(client)
+        vm.remove_from_device = Mock(return_value=True)
+        vm.exists = Mock(side_effect=[True, False])
+
+        results = vm.exec_module()
+
+        assert results['changed'] is True
+
+    def test_ucs_absent_fails(self, *args):
+        set_module_args(dict(
+            ucs="/root/bigip.localhost.localdomain.ucs",
+            server='localhost',
+            password='password',
+            user='admin',
+            state='absent'
+        ))
+
+        client = AnsibleF5Client(
+            argument_spec=self.spec.argument_spec,
+            supports_check_mode=self.spec.supports_check_mode,
+            f5_product_name=self.spec.f5_product_name
+        )
+
+        # Override methods to force specific logic in the module to happen
+        mm = ModuleManager(client)
+        mm.is_version_v1 = Mock(return_value=False)
+
+        vm = V1Manager(client)
+        vm.remove_from_device = Mock(return_value=True)
+        vm.exists = Mock(side_effect=[True, True])
+
+        with pytest.raises(F5ModuleError) as ex:
+            vm.exec_module()
+        assert 'Failed to delete' in str(ex.value)