Add support for Context Profiles and Service Groups

plugins/modules/nsxt_context_profile.py

@@ -0,0 +1,339 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+#
+# Copyright 2018 VMware, Inc.
+# SPDX-License-Identifier: BSD-2-Clause OR GPL-3.0-only
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
+# BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+# IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+# WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+# EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+from __future__ import absolute_import, division, print_function
+
+__metaclass__ = type
+
+ANSIBLE_METADATA = {'metadata_version': '1.1',
+                    'status': ['preview'],
+                    'supported_by': 'community'}
+DOCUMENTATION = '''
+---
+module: nsxt_context_profiles
+short_description: 'Create a new context profile.'
+description: "Creates a new context profile using the specified URLs. attributes is a
+              required parameter. display_name & description are optional parameters"
+version_added: '1.0'
+author: 'William Stoneman'
+options:
+    hostname:
+        description: 'Deployed NSX manager hostname.'
+        required: true
+        type: str
+    username:
+        description: 'The username to authenticate with the NSX manager.'
+        required: true
+        type: str
+    password:
+        description: 'The password to authenticate with the NSX manager.'
+        required: true
+        type: str
+    attributes:
+        description: "Represents the URLs for the context profile."
+        required: true
+        type: list
+    display_name:
+        description: 'Display name'
+        required: true
+        type: str
+    description:
+        description: 'Description of the resource'
+        required: false
+        type: str
+    state:
+        choices:
+            - present
+            - absent
+        description: "State can be either 'present' or 'absent'.
+                      'present' is used to create or update resource.
+                      'absent' is used to delete resource."
+        required: true
+
+'''
+
+EXAMPLES = '''
+- name: Create a new Context Profile
+  nsxt_security_services:
+    hostname: "10.192.167.137"
+    username: "admin"
+    password: "Admin!23Admin"
+    validate_certs: False
+    display_name: "IPBlock-Tenant-1"
+    description: "IPBlock-Tenant-1 Description"
+    attributes:
+    - key: DOMAIN_NAME
+      datatype: STRING
+      value:
+      - depot.broadcom.com
+      - hostupdate.vmware.com
+      - vapp-updates.vmware.com
+      - vcsa.vmware.com
+      - feedback.esp.vmware.com
+      - vcgw-updates.vmware.com
+      - partnerweb.vmware.com
+      - '*.esp.vmware.com'
+      - '*.prod.nsxti.vmware.com'
+    state: present
+    id: "IPBlock_Tenant_1"
+'''
+
+RETURN = '''# '''
+
+import json, time
+from ansible.module_utils.basic import AnsibleModule
+from ansible_collections.vmware.ansible_for_nsxt.plugins.module_utils.vmware_nsxt import vmware_argument_spec, request, \
+    validate_nsx_mp_support
+from ansible.module_utils._text import to_native
+
+
+def get_context_params(args=None):
+    args_to_remove = ['state', 'username', 'password', 'port', 'hostname', 'validate_certs']
+    for key in args_to_remove:
+        args.pop(key, None)
+    for key, value in args.copy().items():
+        if value == None:
+            args.pop(key, None)
+    return args
+
+
+def get_context(module, manager_url, mgr_username, mgr_password, validate_certs):
+    try:
+        (rc, resp) = request(manager_url + '/infra/context-profiles', headers=dict(Accept='application/json'),
+                             url_username=mgr_username, url_password=mgr_password, validate_certs=validate_certs,
+                             ignore_errors=True)
+    except Exception as err:
+        module.fail_json(msg='Error accessing contexts. Error [%s]' % (to_native(err)))
+    return resp
+
+def get_custom_attributes(module, manager_url, mgr_username, mgr_password, validate_certs):
+    try:
+        (rc, resp) = request(manager_url + '/infra/context-profiles/custom-attributes/default?attribute_key=DOMAIN_NAME', headers=dict(Accept='application/json'),
+                             url_username=mgr_username, url_password=mgr_password, validate_certs=validate_certs,
+                             ignore_errors=True)
+    except Exception as err:
+        module.fail_json(msg='Error accessing attribures. Error [%s]' % (to_native(err)))
+    return resp
+
+
+def get_context_from_id(module, manager_url, mgr_username, mgr_password, validate_certs, id):
+    contexts = get_context(module, manager_url, mgr_username, mgr_password, validate_certs)
+    for context in contexts['results']:
+        if 'id' in context and context['id'] == id:
+            return context
+    return None
+
+def get_custom_attributes_from_id(module, manager_url, mgr_username, mgr_password, validate_certs, value):
+    cust_attrbutes = get_custom_attributes(module, manager_url, mgr_username, mgr_password, validate_certs)
+    for cust_attr in cust_attrbutes['results']:
+        if 'attributes' in cust_attr:
+            for attribute in cust_attr['attributes']:
+                for attr_value in attribute['value']:
+
+                    if attr_value == value:
+                        return attr_value
+    return None
+
+
+def check_for_update(module, manager_url, mgr_username, mgr_password, validate_certs, context_params):
+    existing_context = get_context_from_id(module, manager_url, mgr_username, mgr_password, validate_certs,
+                                                       context_params['id'])
+
+    if existing_context is None:
+        return False
+    if "attributes" in existing_context:
+        if existing_context['attributes'][0]['value'] != context_params['attributes'][0]['value']:
+            return True
+    if "description" in existing_context:
+        if existing_context['description'] != context_params['description']:
+            return True
+    elif context_params['description'] is not None:
+        return True
+
+    if existing_context['display_name'] != context_params['display_name']:
+        return True
+    return False
+
+
+def main():
+    argument_spec = vmware_argument_spec()
+    argument_spec.update(display_name=dict(required=True, type='str'),
+                         attributes=dict(required=True, type='list'),
+                         description=dict(required=False, type='str'),
+                         state=dict(required=True, choices=['present', 'absent']),
+                         id=dict(required=True, type='str'))
+
+    module = AnsibleModule(argument_spec=argument_spec, supports_check_mode=True)
+    context_params = get_context_params(module.params.copy())
+    request_data = json.dumps(context_params)
+    state = module.params['state']
+    mgr_hostname = module.params['hostname']
+    mgr_username = module.params['username']
+    mgr_password = module.params['password']
+    validate_certs = module.params['validate_certs']
+    display_name = module.params['display_name']
+    id = module.params['id']
+    manager_url = 'https://{}/policy/api/v1'.format(mgr_hostname)
+
+
+    context_dict = get_context_from_id(module, manager_url, mgr_username, mgr_password, validate_certs,id)
+
+    service_id, revision = None, None
+    if context_dict:
+        service_id = context_dict['id'].replace(" ", "_").replace("-", "_")
+        revision = context_dict['_revision']
+
+    if state == 'present':
+        headers = dict(Accept="application/json")
+        headers['Content-Type'] = 'application/json'
+        updated = check_for_update(module, manager_url, mgr_username, mgr_password, validate_certs, context_params)
+
+
+
+        if not updated:
+            # add the block
+            if module.check_mode:
+                module.exit_json(changed=True, debug_out=str(json.dumps(context_params)), id='12345')
+
+            for attribute in context_params['attributes']:
+                for attr_value in attribute['value']:
+                    attribute_dict = get_custom_attributes_from_id(module, manager_url, mgr_username, mgr_password,
+                                                                 validate_certs,
+                                                                 attr_value)
+
+                    if not attribute_dict:
+                        body_data = {
+                            'key': "DOMAIN_NAME",
+                            'datatype': "STRING",
+                            'value': [
+                            attr_value
+                            ]
+                        }
+
+                        try:
+                            (rc, resp) = request(manager_url + '/infra/context-profiles/custom-attributes/default/?action=add',
+                                                 data=json.dumps(body_data).encode(), headers=headers,
+                                                 method='POST',
+                                                 url_username=mgr_username, url_password=mgr_password,
+                                                 validate_certs=validate_certs, ignore_errors=True)
+
+
+                        except Exception as err:
+                            module.fail_json(
+                                msg="Failed to add attribute. Request body [%s]. Error[%s]." % (
+                                context_params, to_native(err)))
+
+            body_data = {
+                'display_name': context_params['display_name'],
+                'attributes': context_params['attributes'],
+                'id': service_id,
+                'description': context_params['description']
+            }
+
+            try:
+
+                if service_id:
+                    module.exit_json(changed=False, id=service_id,
+                                     message="context with display_name %s already exist." % module.params[
+                                         'display_name'])
+                id = context_params['id'].replace(" ", "_").replace("-", "_")
+                (rc, resp) = request(manager_url + '/infra/context-profiles/%s' % id, data=json.dumps(body_data).encode(), headers=headers,
+                                     method='PUT',
+                                     url_username=mgr_username, url_password=mgr_password,
+                                     validate_certs=validate_certs, ignore_errors=True)
+
+
+            except Exception as err:
+                module.fail_json(
+                    msg="Failed to !!!!! add Context. Request body [%s]. Error[%s]." % (context_params, to_native(err)))
+
+            module.exit_json(changed=True, id=resp["id"], body=resp,
+                             message="Service with display name %s created." % context_params['display_name'])
+        else:
+
+            if module.check_mode:
+                module.exit_json(changed=True, debug_out=str(json.dumps(context_params)), id='12345')
+
+            for attribute in context_params['attributes']:
+                for attr_value in attribute['value']:
+                    attribute_dict = get_custom_attributes_from_id(module, manager_url, mgr_username, mgr_password,
+                                                                 validate_certs,
+                                                                 attr_value)
+
+                    if not attribute_dict:
+                        body_data = {
+                            'key': "DOMAIN_NAME",
+                            'datatype': "STRING",
+                            'value': [
+                            attr_value
+                            ]
+                        }
+
+                        try:
+                            (rc, resp) = request(manager_url + '/infra/context-profiles/custom-attributes/default/?action=add',
+                                                 data=json.dumps(body_data).encode(), headers=headers,
+                                                 method='POST',
+                                                 url_username=mgr_username, url_password=mgr_password,
+                                                 validate_certs=validate_certs, ignore_errors=True)
+
+
+                        except Exception as err:
+                            module.fail_json(
+                                msg="Failed to add attribute. Request body [%s]. Error[%s]." % (
+                                context_params, to_native(err)))
+
+
+            body_data = {
+                'display_name': context_params['display_name'],
+                'attributes': context_params['attributes'],
+                'id': service_id,
+                'description': context_params['description']
+            }
+
+            try:
+                id = context_params['id'].replace(" ", "_").replace("-", "_")
+                (rc, resp) = request(manager_url + '/infra/context-profiles/%s' % id, data=json.dumps(body_data).encode(), headers=headers,
+                                     method='PATCH',
+                                     url_username=mgr_username, url_password=mgr_password,
+                                     validate_certs=validate_certs, ignore_errors=True)
+
+
+            except Exception as err:
+                module.fail_json(
+                    msg="Failed to Update Context. Request body [%s]. Error[%s]." % (context_params, to_native(err)))
+            #time.sleep(5)
+            module.exit_json(changed=True, id=resp, body=resp,
+                             message="Service with display name %s updated." % context_params['id'])
+
+
+
+    elif state == 'absent':
+        # delete the array
+        id = service_id
+        if id is None:
+            module.exit_json(changed=False, msg='No service exist with display name %s' % display_name)
+        if module.check_mode:
+            module.exit_json(changed=True, debug_out=str(json.dumps(context_params)), id=id)
+        try:
+            (rc, resp) = request(manager_url + "/infra/context-profiles/%s" % id, method='DELETE',
+                                 url_username=mgr_username, url_password=mgr_password, validate_certs=validate_certs)
+        except Exception as err:
+            module.fail_json(msg="Failed to delete Service with id %s. Error[%s]." % (id, to_native(err)))
+
+        time.sleep(5)
+        module.exit_json(changed=True, object_name=id, message="Service with block id %s deleted." % id)
+
+
+if __name__ == '__main__':
+    main()