Adds the BIGIQ application HTTPS offload module (#40269)

This module allows you to manage HTTPS offload applications on a BIGIQ

lib/ansible/modules/network/f5/bigiq_application_https_offload.py

@@ -0,0 +1,979 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+#
+# Copyright: (c) 2018, F5 Networks Inc.
+# GNU General Public License v3.0 (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+from __future__ import absolute_import, division, print_function
+__metaclass__ = type
+
+
+ANSIBLE_METADATA = {'metadata_version': '1.1',
+                    'status': ['preview'],
+                    'supported_by': 'community'}
+
+DOCUMENTATION = r'''
+---
+module: bigiq_application_https_offload
+short_description: Manages BIG-IQ HTTPS offload applications
+description:
+  - Manages BIG-IQ applications used for load balancing an HTTPS application on
+    port 443 with SSL offloading on BIG-IP.
+version_added: 2.6
+options:
+  name:
+    description:
+      - Name of the new application.
+    required: True
+  description:
+    description:
+      - Description of the application.
+  servers:
+    description:
+      - A list of servers that the application is hosted on.
+      - If you are familiar with other BIG-IP setting, you might also refer to this
+        list as the list of pool members.
+      - When creating a new application, at least one server is required.
+    suboptions:
+      address:
+        description:
+          - The IP address of the server.
+      port:
+        description:
+          - The port of the server.
+        default: 80
+  inbound_virtual:
+    description:
+      - Settings to configure the virtual which will receive the inbound connection.
+      - This virtual will be used to host the HTTPS endpoint of the application.
+      - Traffic destined to the C(redirect_virtual) will be offloaded to this
+        parameter to ensure that proper redirection from insecure, to secure, occurs.
+    suboptions:
+      destination:
+        description:
+          - Specifies destination IP address information to which the virtual server
+            sends traffic.
+          - This parameter is required when creating a new application.
+      netmask:
+        description:
+          - Specifies the netmask to associate with the given C(destination).
+          - This parameter is required when creating a new application.
+      port:
+        description:
+          - The port that the virtual listens for connections on.
+          - When creating a new application, if this parameter is not specified, the
+            default value of C(443) will be used.
+        default: 443
+  redirect_virtual:
+    description:
+      - Settings to configure the virtual which will receive the connection to be
+        redirected.
+      - This virtual will be used to host the HTTP endpoint of the application.
+      - Traffic destined to this parameter will be offloaded to the
+        C(inbound_virtual) parameter to ensure that proper redirection from insecure,
+        to secure, occurs.
+    suboptions:
+      destination:
+        description:
+          - Specifies destination IP address information to which the virtual server
+            sends traffic.
+          - This parameter is required when creating a new application.
+      netmask:
+        description:
+          - Specifies the netmask to associate with the given C(destination).
+          - This parameter is required when creating a new application.
+      port:
+        description:
+          - The port that the virtual listens for connections on.
+          - When creating a new application, if this parameter is not specified, the
+            default value of C(80) will be used.
+        default: 80
+  client_ssl_profile:
+    description:
+      - Specifies the SSL profile for managing client-side SSL traffic.
+    suboptions:
+      name:
+        description:
+          - The name of the client SSL profile to created and used.
+          - When creating a new application, if this value is not specified, the
+            default value of C(clientssl) will be used.
+      cert_key_chain:
+        description:
+          - One or more certificates and keys to associate with the SSL profile.
+          - This option is always a list. The keys in the list dictate the details
+            of the client/key/chain/passphrase combination.
+          - Note that BIG-IPs can only have one of each type of each certificate/key
+            type. This means that you can only have one RSA, one DSA, and one ECDSA
+            per profile.
+          - If you attempt to assign two RSA, DSA, or ECDSA certificate/key combo,
+            the device will reject this.
+          - This list is a complex list that specifies a number of keys. There are
+            several supported keys.
+          - When creating a new profile, if this parameter is not specified, the
+            default value of C(inherit) will be used.
+        suboptions:
+          cert:
+            description:
+              - Specifies a cert name for use.
+            required: True
+          key:
+            description:
+              - Specifies a key name.
+            required: True
+          chain:
+            description:
+              - Specifies a certificate chain that is relevant to the certificate and
+                key mentioned earlier.
+              - This key is optional.
+          passphrase:
+            description:
+              - Contains the passphrase of the key file, should it require one.
+              - Passphrases are encrypted on the remote BIG-IP device.
+  service_environment:
+    description:
+      - Specifies the name of service environment that the application will be
+        deployed to.
+      - When creating a new application, this parameter is required.
+  add_analytics:
+    description:
+      - Collects statistics of the BIG-IP that the application is deployed to.
+      - This parameter is only relevant when specifying a C(service_environment) which
+        is a BIG-IP; not an SSG.
+    type: bool
+    default: no
+  state:
+    description:
+      - The state of the resource on the system.
+      - When C(present), guarantees that the resource exists with the provided attributes.
+      - When C(absent), removes the resource from the system.
+    default: present
+    choices:
+      - absent
+      - present
+extends_documentation_fragment: f5
+author:
+  - Tim Rupp (@caphrim007)
+'''
+
+EXAMPLES = r'''
+- name: Load balance an HTTPS application on port 443 with SSL offloading on BIG-IP
+  bigiq_application_https_offload:
+    name: my-app
+    description: Redirect HTTP to HTTPS
+    service_environment: my-ssg
+    servers:
+      - address: 1.2.3.4
+        port: 8080
+      - address: 5.6.7.8
+        port: 8080
+    inbound_virtual:
+      destination: 2.2.2.2
+      netmask: 255.255.255.255
+      port: 443
+    redirect_virtual:
+      destination: 2.2.2.2
+      netmask: 255.255.255.255
+      port: 80
+    provider:
+      password: secret
+      server: lb.mydomain.com
+      user: admin
+    state: present
+  delegate_to: localhost
+'''
+
+RETURN = r'''
+description:
+  description: The new description of the application of the resource.
+  returned: changed
+  type: string
+  sample: My application
+service_environment:
+  description: The environment which the service was deployed to.
+  returned: changed
+  type: string
+  sample: my-ssg1
+inbound_virtual_destination:
+  description: The destination of the virtual that was created.
+  returned: changed
+  type: string
+  sample: 6.7.8.9
+inbound_virtual_netmask:
+  description: The network mask of the provided inbound destination.
+  returned: changed
+  type: string
+  sample: 255.255.255.0
+inbound_virtual_port:
+  description: The port the inbound virtual address listens on.
+  returned: changed
+  type: int
+  sample: 80
+servers:
+  description: List of servers, and their ports, that make up the application.
+  type: complex
+  returned: changed
+  contains:
+    address:
+      description: The IP address of the server.
+      returned: changed
+      type: string
+      sample: 2.3.4.5
+    port:
+      description: The port that the server listens on.
+      returned: changed
+      type: int
+      sample: 8080
+  sample: hash/dictionary of values
+'''
+
+import time
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible.module_utils.basic import env_fallback
+from ansible.module_utils.six import string_types
+
+try:
+    from library.module_utils.network.f5.bigiq import F5RestClient
+    from library.module_utils.network.f5.common import F5ModuleError
+    from library.module_utils.network.f5.common import AnsibleF5Parameters
+    from library.module_utils.network.f5.common import f5_argument_spec
+    from library.module_utils.network.f5.common import exit_json
+    from library.module_utils.network.f5.common import fail_json
+    from library.module_utils.network.f5.common import fq_name
+except ImportError:
+    from ansible.module_utils.network.f5.bigiq import F5RestClient
+    from ansible.module_utils.network.f5.common import F5ModuleError
+    from ansible.module_utils.network.f5.common import AnsibleF5Parameters
+    from ansible.module_utils.network.f5.common import f5_argument_spec
+    from ansible.module_utils.network.f5.common import exit_json
+    from ansible.module_utils.network.f5.common import fail_json
+    from ansible.module_utils.network.f5.common import fq_name
+
+try:
+    import netaddr
+    HAS_NETADDR = True
+except ImportError:
+    HAS_NETADDR = False
+
+
+class Parameters(AnsibleF5Parameters):
+    api_map = {
+        'templateReference': 'template_reference',
+        'subPath': 'sub_path',
+        'ssgReference': 'ssg_reference',
+        'configSetName': 'config_set_name',
+        'defaultDeviceReference': 'default_device_reference',
+        'addAnalytics': 'add_analytics'
+    }
+
+    api_attributes = [
+        'resources', 'description', 'configSetName', 'subPath', 'templateReference',
+        'ssgReference', 'defaultDeviceReference', 'addAnalytics'
+    ]
+
+    returnables = [
+        'resources', 'description', 'config_set_name', 'sub_path', 'template_reference',
+        'ssg_reference', 'default_device_reference', 'servers', 'inbound_virtual',
+        'redirect_virtual', 'client_ssl_profile', 'add_analytics'
+    ]
+
+    updatables = [
+        'resources', 'description', 'config_set_name', 'sub_path', 'template_reference',
+        'ssg_reference', 'default_device_reference', 'servers', 'add_analytics'
+    ]
+
+
+class ApiParameters(Parameters):
+    pass
+
+
+class ModuleParameters(Parameters):
+    @property
+    def http_profile(self):
+        return "profile_http"
+
+    @property
+    def config_set_name(self):
+        return self.name
+
+    @property
+    def sub_path(self):
+        return self.name
+
+    @property
+    def template_reference(self):
+        filter = "name+eq+'Default-f5-HTTPS-offload-lb-template'"
+        uri = "https://{0}:{1}/mgmt/cm/global/templates/?$filter={2}&$top=1&$select=selfLink".format(
+            self.client.provider['server'],
+            self.client.provider['server_port'],
+            filter
+        )
+        resp = self.client.api.get(uri)
+        try:
+            response = resp.json()
+        except ValueError as ex:
+            raise F5ModuleError(str(ex))
+        if resp.status == 200 and response['totalItems'] == 0:
+            raise F5ModuleError(
+                "No default HTTP LB template was found."
+            )
+        elif 'code' in response and response['code'] == 400:
+            if 'message' in response:
+                raise F5ModuleError(response['message'])
+            else:
+                raise F5ModuleError(resp._content)
+
+        result = dict(
+            link=response['items'][0]['selfLink']
+        )
+        return result
+
+    @property
+    def default_device_reference(self):
+        try:
+            # An IP address was specified
+            netaddr.IPAddress(self.service_environment)
+            filter = "address+eq+'{0}'".format(self.service_environment)
+        except netaddr.core.AddrFormatError:
+            # Assume a hostname was specified
+            filter = "hostname+eq+'{0}'".format(self.service_environment)
+
+        uri = "https://{0}:{1}/mgmt/shared/resolver/device-groups/cm-adccore-allbigipDevices/devices/?$filter={2}&$top=1&$select=selfLink".format(
+            self.client.provider['server'],
+            self.client.provider['server_port'],
+            filter
+        )
+        resp = self.client.api.get(uri)
+        try:
+            response = resp.json()
+        except ValueError as ex:
+            raise F5ModuleError(str(ex))
+        if resp.status == 200 and response['totalItems'] == 0:
+            return None
+        elif 'code' in response and response['code'] == 400:
+            if 'message' in response:
+                raise F5ModuleError(response['message'])
+            else:
+                raise F5ModuleError(resp._content)
+        result = dict(
+            link=response['items'][0]['selfLink']
+        )
+        return result
+
+    @property
+    def ssg_reference(self):
+        filter = "name+eq+'{0}'".format(self.service_environment)
+        uri = "https://{0}:{1}/mgmt/cm/cloud/service-scaling-groups/?$filter={2}&$top=1&$select=selfLink".format(
+            self.client.provider['server'],
+            self.client.provider['server_port'],
+            filter
+        )
+        resp = self.client.api.get(uri)
+        try:
+            response = resp.json()
+        except ValueError as ex:
+            raise F5ModuleError(str(ex))
+        if resp.status == 200 and response['totalItems'] == 0:
+            return None
+        elif 'code' in response and response['code'] == 400:
+            if 'message' in response:
+                raise F5ModuleError(response['message'])
+            else:
+                raise F5ModuleError(resp._content)
+        result = dict(
+            link=response['items'][0]['selfLink']
+        )
+        return result
+
+
+class Changes(Parameters):
+    def to_return(self):
+        result = {}
+        for returnable in self.returnables:
+            result[returnable] = getattr(self, returnable)
+        result = self._filter_params(result)
+        return result
+
+
+class UsableChanges(Changes):
+    @property
+    def resources(self):
+        result = dict()
+        result.update(self.http_profile)
+        result.update(self.http_monitor)
+        result.update(self.inbound_virtual_server)
+        result.update(self.redirect_virtual_server)
+        result.update(self.pool)
+        result.update(self.nodes)
+        result.update(self.ssl_profile)
+        return result
+
+    @property
+    def inbound_virtual_server(self):
+        result = dict()
+        result['ltm:virtual:7a5f7da91996'] = [
+            dict(
+                parameters=dict(
+                    name='default_vs',
+                    destinationAddress=self.inbound_virtual['address'],
+                    mask=self.inbound_virtual['netmask'],
+                    destinationPort=self.inbound_virtual['port']
+                ),
+                subcollectionResources=self.inbound_profiles
+            )
+        ]
+        return result
+
+    @property
+    def inbound_profiles(self):
+        result = {
+            'profiles:14c995c33411': [
+                dict(
+                    parameters=dict()
+                )
+            ],
+            'profiles:8ba4bb101701': [
+                dict(
+                    parameters=dict()
+                )
+            ],
+            'profiles:9448fe71611e': [
+                dict(
+                    parameters=dict()
+                )
+            ]
+        }
+        return result
+
+    @property
+    def redirect_virtual_server(self):
+        result = dict()
+        result['ltm:virtual:40e8c4a6f542'] = [
+            dict(
+                parameters=dict(
+                    name='default_redirect_vs',
+                    destinationAddress=self.redirect_virtual['address'],
+                    mask=self.redirect_virtual['netmask'],
+                    destinationPort=self.redirect_virtual['port']
+                ),
+                subcollectionResources=self.redirect_profiles
+            )
+        ]
+        return result
+
+    @property
+    def redirect_profiles(self):
+        result = {
+            'profiles:8ba4bb101701': [
+                dict(
+                    parameters=dict()
+                )
+            ],
+            'profiles:9448fe71611e': [
+                dict(
+                    parameters=dict()
+                )
+            ]
+        }
+        return result
+
+    @property
+    def pool(self):
+        result = dict()
+        result['ltm:pool:be70d46c6d73'] = [
+            dict(
+                parameters=dict(
+                    name='pool_0'
+                ),
+                subcollectionResources=self.pool_members
+            )
+        ]
+        return result
+
+    @property
+    def pool_members(self):
+        result = dict()
+        result['members:dec6d24dc625'] = []
+        for x in self.servers:
+            member = dict(
+                parameters=dict(
+                    port=x['port'],
+                    nodeReference=dict(
+                        link='#/resources/ltm:node:45391b57b104/{0}'.format(x['address']),
+                        fullPath='# {0}'.format(x['address'])
+                    )
+                )
+            )
+            result['members:dec6d24dc625'].append(member)
+        return result
+
+    @property
+    def http_profile(self):
+        result = dict()
+        result['ltm:profile:http:8ba4bb101701'] = [
+            dict(
+                parameters=dict(
+                    name='profile_http'
+                )
+            )
+        ]
+        return result
+
+    @property
+    def http_monitor(self):
+        result = dict()
+        result['ltm:monitor:http:fd07629373b0'] = [
+            dict(
+                parameters=dict(
+                    name='monitor-http'
+                )
+            )
+        ]
+        return result
+
+    @property
+    def nodes(self):
+        result = dict()
+        result['ltm:node:45391b57b104'] = []
+        for x in self.servers:
+            tmp = dict(
+                parameters=dict(
+                    name=x['address'],
+                    address=x['address']
+                )
+            )
+            result['ltm:node:45391b57b104'].append(tmp)
+        return result
+
+    @property
+    def node_addresses(self):
+        result = [x['address'] for x in self.servers]
+        return result
+
+    @property
+    def ssl_profile(self):
+        result = dict()
+        result['ltm:profile:client-ssl:14c995c33411'] = [
+            dict(
+                parameters=dict(
+                    name='clientssl',
+                    certKeyChain=self.cert_key_chains
+                )
+            )
+        ]
+        return result
+
+    def _get_cert_references(self):
+        result = dict()
+        uri = "https://{0}:{1}/mgmt/cm/adc-core/working-config/sys/file/ssl-cert/".format(
+            self.client.provider['server'],
+            self.client.provider['server_port']
+        )
+
+        resp = self.client.api.get(uri)
+        try:
+            response = resp.json()
+        except ValueError as ex:
+            raise F5ModuleError(str(ex))
+        for cert in response['items']:
+            key = fq_name(cert['partition'], cert['name'])
+            result[key] = cert['selfLink']
+        return result
+
+    def _get_key_references(self):
+        result = dict()
+        uri = "https://{0}:{1}/mgmt/cm/adc-core/working-config/sys/file/ssl-key/".format(
+            self.client.provider['server'],
+            self.client.provider['server_port']
+        )
+        resp = self.client.api.get(uri)
+        try:
+            response = resp.json()
+        except ValueError as ex:
+            raise F5ModuleError(str(ex))
+        for cert in response['items']:
+            key = fq_name(cert['partition'], cert['name'])
+            result[key] = cert['selfLink']
+        return result
+
+    @property
+    def cert_key_chains(self):
+        result = []
+        if self.client_ssl_profile is None:
+            return None
+        if 'cert_key_chain' not in self.client_ssl_profile:
+            return None
+
+        kc = self.client_ssl_profile['cert_key_chain']
+        if isinstance(kc, string_types) and kc != 'inherit':
+            raise F5ModuleError(
+                "Only the 'inherit' setting is available when 'cert_key_chain' is a string."
+            )
+
+        if not isinstance(kc, list):
+            raise F5ModuleError(
+                "The value of 'cert_key_chain' is not one of the supported types."
+            )
+
+        cert_references = self._get_cert_references()
+        key_references = self._get_key_references()
+
+        for idx, x in enumerate(kc):
+            tmp = dict(
+                name='clientssl{0}'.format(idx)
+            )
+            if 'cert' not in x:
+                raise F5ModuleError(
+                    "A 'cert' option is required when specifying the 'cert_key_chain' parameter.."
+                )
+            elif x['cert'] not in cert_references:
+                raise F5ModuleError(
+                    "The specified 'cert' was not found. Did you specify its full path?"
+                )
+            else:
+                key = x['cert']
+                tmp['certReference'] = dict(
+                    link=cert_references[key],
+                    fullPath=key
+                )
+
+            if 'key' not in x:
+                raise F5ModuleError(
+                    "A 'key' option is required when specifying the 'cert_key_chain' parameter.."
+                )
+            elif x['key'] not in key_references:
+                raise F5ModuleError(
+                    "The specified 'key' was not found. Did you specify its full path?"
+                )
+            else:
+                key = x['key']
+                tmp['keyReference'] = dict(
+                    link=key_references[key],
+                    fullPath=key
+                )
+
+            if 'chain' in x and x['chain'] not in cert_references:
+                raise F5ModuleError(
+                    "The specified 'key' was not found. Did you specify its full path?"
+                )
+            else:
+                key = x['chain']
+                tmp['chainReference'] = dict(
+                    link=cert_references[key],
+                    fullPath=key
+                )
+
+            if 'passphrase' in x:
+                tmp['passphrase'] = x['passphrase']
+            result.append(tmp)
+        return result
+
+
+class ReportableChanges(Changes):
+    pass
+
+
+class Difference(object):
+    def __init__(self, want, have=None):
+        self.want = want
+        self.have = have
+
+    def compare(self, param):
+        try:
+            result = getattr(self, param)
+            return result
+        except AttributeError:
+            return self.__default(param)
+
+    def __default(self, param):
+        attr1 = getattr(self.want, param)
+        try:
+            attr2 = getattr(self.have, param)
+            if attr1 != attr2:
+                return attr1
+        except AttributeError:
+            return attr1
+
+
+class ModuleManager(object):
+    def __init__(self, *args, **kwargs):
+        self.module = kwargs.get('module', None)
+        self.client = kwargs.get('client', None)
+        self.want = ModuleParameters(params=self.module.params)
+        self.want.client = self.client
+        self.have = ApiParameters()
+        self.changes = UsableChanges()
+
+    def _set_changed_options(self):
+        changed = {}
+        for key in Parameters.returnables:
+            if getattr(self.want, key) is not None:
+                changed[key] = getattr(self.want, key)
+        if changed:
+            self.changes = UsableChanges(params=changed)
+            self.changes.client = self.client
+
+    def _update_changed_options(self):
+        diff = Difference(self.want, self.have)
+        updatables = Parameters.updatables
+        changed = dict()
+        for k in updatables:
+            change = diff.compare(k)
+            if change is None:
+                continue
+            else:
+                if isinstance(change, dict):
+                    changed.update(change)
+                else:
+                    changed[k] = change
+        if changed:
+            self.changes = UsableChanges(params=changed)
+            self.changes.client = self.client
+            return True
+        return False
+
+    def should_update(self):
+        result = self._update_changed_options()
+        if result:
+            return True
+        return False
+
+    def exec_module(self):
+        changed = False
+        result = dict()
+        state = self.want.state
+
+        if state == "present":
+            changed = self.present()
+        elif state == "absent":
+            changed = self.absent()
+
+        reportable = ReportableChanges(params=self.changes.to_return())
+        changes = reportable.to_return()
+        result.update(**changes)
+        result.update(dict(changed=changed))
+        self._announce_deprecations(result)
+        return result
+
+    def _announce_deprecations(self, result):
+        warnings = result.pop('__warnings', [])
+        for warning in warnings:
+            self.client.module.deprecate(
+                msg=warning['msg'],
+                version=warning['version']
+            )
+
+    def present(self):
+        if self.exists():
+            return False
+        else:
+            return self.create()
+
+    def exists(self):
+        uri = "https://{0}:{1}/mgmt/ap/query/v1/tenants/default/reports/AllApplicationsList?$filter=name+eq+'{2}'".format(
+            self.client.provider['server'],
+            self.client.provider['server_port'],
+            self.want.name
+        )
+        resp = self.client.api.get(uri)
+        try:
+            response = resp.json()
+        except ValueError as ex:
+            raise F5ModuleError(str(ex))
+        if resp.status == 200 and 'result' in response and 'totalItems' in response['result'] and response['result']['totalItems'] == 0:
+            return False
+        return True
+
+    def remove(self):
+        if self.module.check_mode:
+            return True
+        self_link = self.remove_from_device()
+        self.wait_for_apply_template_task(self_link)
+        if self.exists():
+            raise F5ModuleError("Failed to delete the resource.")
+        return True
+
+    def has_no_service_environment(self):
+        if self.want.default_device_reference is None and self.want.ssg_reference is None:
+            return True
+        return False
+
+    def create(self):
+        if self.want.service_environment is None:
+            raise F5ModuleError(
+                "A 'service_environment' must be specified when creating a new application."
+            )
+        if self.want.servers is None:
+            raise F5ModuleError(
+                "At least one 'servers' item is needed when creating a new application."
+            )
+        if self.want.inbound_virtual is None:
+            raise F5ModuleError(
+                "An 'inbound_virtual' must be specified when creating a new application."
+            )
+        self._set_changed_options()
+
+        if self.has_no_service_environment():
+            raise F5ModuleError(
+                "The specified 'service_environment' ({0}) was not found.".format(self.want.service_environment)
+            )
+
+        if self.module.check_mode:
+            return True
+        self_link = self.create_on_device()
+        self.wait_for_apply_template_task(self_link)
+        if not self.exists():
+            raise F5ModuleError(
+                "Failed to deploy application."
+            )
+        return True
+
+    def create_on_device(self):
+        params = self.changes.api_params()
+        params['mode'] = 'CREATE'
+
+        uri = 'https://{0}:{1}/mgmt/cm/global/tasks/apply-template'.format(
+            self.client.provider['server'],
+            self.client.provider['server_port']
+        )
+
+        resp = self.client.api.post(uri, json=params)
+        try:
+            response = resp.json()
+        except ValueError as ex:
+            raise F5ModuleError(str(ex))
+
+        if 'code' in response and response['code'] == 400:
+            if 'message' in response:
+                raise F5ModuleError(response['message'])
+            else:
+                raise F5ModuleError(resp._content)
+        return response['selfLink']
+
+    def absent(self):
+        if self.exists():
+            return self.remove()
+        return False
+
+    def remove_from_device(self):
+        params = dict(
+            configSetName=self.want.name,
+            mode='DELETE'
+        )
+        uri = 'https://{0}:{1}/mgmt/cm/global/tasks/apply-template'.format(
+            self.client.provider['server'],
+            self.client.provider['server_port']
+        )
+
+        resp = self.client.api.post(uri, json=params)
+        try:
+            response = resp.json()
+        except ValueError as ex:
+            raise F5ModuleError(str(ex))
+
+        if 'code' in response and response['code'] == 400:
+            if 'message' in response:
+                raise F5ModuleError(response['message'])
+            else:
+                raise F5ModuleError(resp._content)
+        return response['selfLink']
+
+    def wait_for_apply_template_task(self, self_link):
+        host = 'https://{0}:{1}'.format(
+            self.client.provider['server'],
+            self.client.provider['server_port']
+        )
+        uri = self_link.replace('https://localhost', host)
+
+        while True:
+            resp = self.client.api.get(uri)
+            try:
+                response = resp.json()
+            except ValueError as ex:
+                raise F5ModuleError(str(ex))
+
+            if response['status'] == 'FINISHED' and response.get('currentStep', None) == 'DONE':
+                return True
+            elif 'errorMessage' in response:
+                raise F5ModuleError(response['errorMessage'])
+            time.sleep(5)
+
+
+class ArgumentSpec(object):
+    def __init__(self):
+        self.supports_check_mode = True
+        argument_spec = dict(
+            name=dict(required=True),
+            description=dict(),
+            servers=dict(
+                type='list',
+                options=dict(
+                    address=dict(required=True),
+                    port=dict(default=80)
+                )
+            ),
+            inbound_virtual=dict(
+                type='dict',
+                options=dict(
+                    address=dict(required=True),
+                    netmask=dict(required=True),
+                    port=dict(default=443)
+                )
+            ),
+            redirect_virtual=dict(
+                type='dict',
+                options=dict(
+                    address=dict(required=True),
+                    netmask=dict(required=True),
+                    port=dict(default=80)
+                )
+            ),
+            service_environment=dict(),
+            state=dict(
+                default='present',
+                choices=['present', 'absent']
+            ),
+            client_ssl_profile=dict(
+                type='dict',
+                name=dict(default='clientssl'),
+                cert_key_chain=dict(
+                    type='raw',
+                    options=dict(
+                        cert=dict(),
+                        key=dict(),
+                        chain=dict(),
+                        passphrase=dict()
+                    )
+                )
+            ),
+            add_analytics=dict(type='bool', default='no'),
+        )
+        self.argument_spec = {}
+        self.argument_spec.update(f5_argument_spec)
+        self.argument_spec.update(argument_spec)
+        self.mutually_exclusive = [
+            ['inherit_cert_key_chain', 'cert_key_chain']
+        ]
+
+
+def main():
+    spec = ArgumentSpec()
+
+    module = AnsibleModule(
+        argument_spec=spec.argument_spec,
+        supports_check_mode=spec.supports_check_mode
+    )
+    if not HAS_NETADDR:
+        module.fail_json(msg="The python netaddr module is required")
+
+    try:
+        client = F5RestClient(module=module)
+        mm = ModuleManager(module=module, client=client)
+        results = mm.exec_module()
+        exit_json(module, results, client)
+    except F5ModuleError as ex:
+        fail_json(module, ex, client)
+
+
+if __name__ == '__main__':
+    main()

test/units/modules/network/f5/test_bigiq_application_https_offload.py

@@ -0,0 +1,182 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright: (c) 2017, F5 Networks Inc.
+# GNU General Public License v3.0 (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+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 Mock
+from ansible.compat.tests.mock import patch
+from ansible.module_utils.basic import AnsibleModule
+
+try:
+    from library.modules.bigiq_application_https_offload import ApiParameters
+    from library.modules.bigiq_application_https_offload import ModuleParameters
+    from library.modules.bigiq_application_https_offload import ModuleManager
+    from library.modules.bigiq_application_https_offload import ArgumentSpec
+    from library.module_utils.network.f5.common import F5ModuleError
+    from library.module_utils.network.f5.common import iControlUnexpectedHTTPError
+    from test.unit.modules.utils import set_module_args
+except ImportError:
+    try:
+        from ansible.modules.network.f5.bigiq_application_https_offload import ApiParameters
+        from ansible.modules.network.f5.bigiq_application_https_offload import ModuleParameters
+        from ansible.modules.network.f5.bigiq_application_https_offload import ModuleManager
+        from ansible.modules.network.f5.bigiq_application_https_offload import ArgumentSpec
+        from ansible.module_utils.network.f5.common import F5ModuleError
+        from ansible.module_utils.network.f5.common import iControlUnexpectedHTTPError
+        from units.modules.utils import set_module_args
+    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 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(
+            name='foo',
+            description='my description',
+            service_environment='bar',
+            servers=[
+                dict(
+                    address='1.2.3.4',
+                    port=8080
+                ),
+                dict(
+                    address='5.6.7.8',
+                    port=8000
+                )
+            ],
+            inbound_virtual=dict(
+                address='2.2.2.2',
+                netmask='255.255.255.255',
+                port=80
+            ),
+            redirect_virtual=dict(
+                address='3.3.3.3',
+                netmask='255.255.255.255',
+                port=80
+            )
+        )
+
+        p = ModuleParameters(params=args)
+        assert p.name == 'foo'
+        assert p.config_set_name == 'foo'
+        assert p.sub_path == 'foo'
+        assert p.http_profile == 'profile_http'
+        assert p.service_environment == 'bar'
+        assert len(p.servers) == 2
+        assert 'address' in p.servers[0]
+        assert 'port' in p.servers[0]
+        assert 'address' in p.servers[1]
+        assert 'port' in p.servers[1]
+        assert p.servers[0]['address'] == '1.2.3.4'
+        assert p.servers[0]['port'] == 8080
+        assert p.servers[1]['address'] == '5.6.7.8'
+        assert p.servers[1]['port'] == 8000
+        assert 'address' in p.inbound_virtual
+        assert 'netmask' in p.inbound_virtual
+        assert 'port' in p.inbound_virtual
+        assert p.inbound_virtual['address'] == '2.2.2.2'
+        assert p.inbound_virtual['netmask'] == '255.255.255.255'
+        assert p.inbound_virtual['port'] == 80
+        assert 'address' in p.redirect_virtual
+        assert 'netmask' in p.redirect_virtual
+        assert 'port' in p.redirect_virtual
+        assert p.redirect_virtual['address'] == '3.3.3.3'
+        assert p.redirect_virtual['netmask'] == '255.255.255.255'
+        assert p.redirect_virtual['port'] == 80
+
+
+@patch('ansible.module_utils.f5_utils.AnsibleF5Client._get_mgmt_root',
+       return_value=True)
+class TestManager(unittest.TestCase):
+
+    def setUp(self):
+        self.spec = ArgumentSpec()
+        self.patcher1 = patch('time.sleep')
+        self.patcher1.start()
+
+    def tearDown(self):
+        self.patcher1.stop()
+
+    def test_create(self, *args):
+        set_module_args(dict(
+            name='foo',
+            description='my description',
+            service_environment='bar',
+            servers=[
+                dict(
+                    address='1.2.3.4',
+                    port=8080
+                ),
+                dict(
+                    address='5.6.7.8',
+                    port=8000
+                )
+            ],
+            inbound_virtual=dict(
+                address='2.2.2.2',
+                netmask='255.255.255.255',
+                port=80
+            ),
+            redirect_virtual=dict(
+                address='3.3.3.3',
+                netmask='255.255.255.255',
+                port=80
+            ),
+            provider=dict(
+                server='localhost',
+                password='password',
+                user='admin'
+            )
+        ))
+
+        module = AnsibleModule(
+            argument_spec=self.spec.argument_spec,
+            supports_check_mode=self.spec.supports_check_mode
+        )
+
+        # Override methods to force specific logic in the module to happen
+        mm = ModuleManager(module=module)
+        mm.has_no_service_environment = Mock(return_value=False)
+        mm.wait_for_apply_template_task = Mock(return_value=True)
+
+        mm.create_on_device = Mock(return_value=True)
+        mm.exists = Mock(side_effect=[False, True])
+
+        results = mm.exec_module()
+
+        assert results['changed'] is True
+        assert results['description'] == 'my description'