From 20092786cf85900aac179e06f1d5955508c91b03 Mon Sep 17 00:00:00 2001 From: Abhijeet Kasurde Date: Fri, 27 Jul 2018 13:33:43 +0530 Subject: [PATCH] VMware: new module : vmware_guest_custom_attributes (#38114) Signed-off-by: Abhijeet Kasurde --- .../vmware/vmware_guest_custom_attributes.py | 226 ++++++++++++++++++ .../vmware_guest_custom_attributes/aliases | 2 + .../tasks/main.yml | 144 +++++++++++ 3 files changed, 372 insertions(+) create mode 100644 lib/ansible/modules/cloud/vmware/vmware_guest_custom_attributes.py create mode 100644 test/integration/targets/vmware_guest_custom_attributes/aliases create mode 100644 test/integration/targets/vmware_guest_custom_attributes/tasks/main.yml diff --git a/lib/ansible/modules/cloud/vmware/vmware_guest_custom_attributes.py b/lib/ansible/modules/cloud/vmware/vmware_guest_custom_attributes.py new file mode 100644 index 00000000000..5ed67e7b7f0 --- /dev/null +++ b/lib/ansible/modules/cloud/vmware/vmware_guest_custom_attributes.py @@ -0,0 +1,226 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- + +# Copyright, (c) 2018, Ansible Project +# Copyright, (c) 2018, Abhijeet Kasurde +# +# 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 = ''' +--- +module: vmware_guest_custom_attributes +short_description: Manage custom attributes from VMWare for the given virtual machine +description: + - This module can be used to add, remove and update custom attributes for the given virtual machine. +version_added: 2.7 +author: + - Jimmy Conner + - Abhijeet Kasurde (@Akasurde) +notes: + - Tested on vSphere 6.5 +requirements: + - "python >= 2.6" + - PyVmomi +options: + name: + description: + - Name of the virtual machine to work with. + required: True + state: + description: + - The action to take. + - If set to C(present), then custom attribute is added or updated. + - If set to C(absent), then custom attribute is removed. + default: 'present' + choices: ['present', 'absent'] + uuid: + description: + - UUID of the virtual machine to manage if known. This is VMware's unique identifier. + - This is required parameter, if C(name) is not supplied. + folder: + description: + - Absolute path to find an existing guest. + - This is required parameter, if C(name) is supplied and multiple virtual machines with same name are found. + datacenter: + description: + - Datacenter name where the virtual machine is located in. + required: True + attributes: + description: + - A list of name and value of custom attributes that needs to be manage. + - Value of custom attribute is not required and will be ignored, if C(state) is set to C(absent). + default: [] +extends_documentation_fragment: vmware.documentation +''' + +EXAMPLES = ''' +- name: Add virtual machine custom attributes + vmware_guest_custom_attributes: + hostname: 192.168.1.209 + username: administrator@vsphere.local + password: vmware + uuid: 421e4592-c069-924d-ce20-7e7533fab926 + state: present + attributes: + - name: MyAttribute + value: MyValue + delegate_to: localhost + register: attributes + +- name: Add multiple virtual machine custom attributes + vmware_guest_custom_attributes: + hostname: 192.168.1.209 + username: administrator@vsphere.local + password: vmware + uuid: 421e4592-c069-924d-ce20-7e7533fab926 + state: present + attributes: + - name: MyAttribute + value: MyValue + - name: MyAttribute2 + value: MyValue2 + delegate_to: localhost + register: attributes + +- name: Remove virtual machine Attribute + vmware_guest_custom_attributes: + hostname: 192.168.1.209 + username: administrator@vsphere.local + password: vmware + uuid: 421e4592-c069-924d-ce20-7e7533fab926 + state: absent + attributes: + - name: MyAttribute + delegate_to: localhost + register: attributes + +''' + +RETURN = """ +custom_attributes: + description: metadata about the virtual machine attributes + returned: always + type: dict + sample: { + "mycustom": "my_custom_value", + "mycustom_2": "my_custom_value_2", + "sample_1": "sample_1_value", + "sample_2": "sample_2_value", + "sample_3": "sample_3_value" + } +""" + +try: + from pyVmomi import vim +except ImportError: + pass + +from ansible.module_utils.basic import AnsibleModule +from ansible.module_utils.vmware import PyVmomi, vmware_argument_spec + + +class VmAttributeManager(PyVmomi): + def __init__(self, module): + super(VmAttributeManager, self).__init__(module) + self.custom_field_mgr = self.content.customFieldsManager.field + + def set_custom_field(self, vm, user_fields): + result_fields = dict() + change_list = list() + changed = False + + for field in user_fields: + field_key = self.check_exists(field['name']) + found = False + field_value = field.get('value', '') + + for k, v in [(x.name, v.value) for x in self.custom_field_mgr for v in vm.customValue if x.key == v.key]: + if k == field['name']: + found = True + if v != field_value: + if not self.module.check_mode: + self.content.customFieldsManager.SetField(entity=vm, key=field_key.key, value=field_value) + result_fields[k] = field_value + change_list.append(True) + if not found and field_value != "": + if not field_key and not self.module.check_mode: + field_key = self.content.customFieldsManager.AddFieldDefinition(name=field['name'], moType=vim.VirtualMachine) + change_list.append(True) + if not self.module.check_mode: + self.content.customFieldsManager.SetField(entity=vm, key=field_key.key, value=field_value) + result_fields[field['name']] = field_value + + if any(change_list): + changed = True + + return {'changed': changed, 'failed': False, 'custom_attributes': result_fields} + + def check_exists(self, field): + for x in self.custom_field_mgr: + if x.name == field: + return x + return False + + +def main(): + argument_spec = vmware_argument_spec() + argument_spec.update( + datacenter=dict(type='str'), + name=dict(required=True, type='str'), + folder=dict(type='str'), + uuid=dict(type='str'), + state=dict(type='str', default='present', + choices=['absent', 'present']), + attributes=dict( + type='list', + default=[], + options=dict( + name=dict(type='str', required=True), + value=dict(type='str'), + ) + ), + ) + + module = AnsibleModule( + argument_spec=argument_spec, + supports_check_mode=True, + required_one_of=[['name', 'uuid']], + ) + + if module.params.get('folder'): + # FindByInventoryPath() does not require an absolute path + # so we should leave the input folder path unmodified + module.params['folder'] = module.params['folder'].rstrip('/') + + pyv = VmAttributeManager(module) + results = {'changed': False, 'failed': False, 'instance': dict()} + + # Check if the virtual machine exists before continuing + vm = pyv.get_vm() + + if vm: + # virtual machine already exists + if module.params['state'] == "present": + results = pyv.set_custom_field(vm, module.params['attributes']) + elif module.params['state'] == "absent": + results = pyv.set_custom_field(vm, module.params['attributes']) + module.exit_json(**results) + else: + # virtual machine does not exists + module.fail_json(msg="Unable to manage custom attributes for non-existing" + " virtual machine %s" % (module.params.get('name') or module.params.get('uuid'))) + + +if __name__ == '__main__': + main() diff --git a/test/integration/targets/vmware_guest_custom_attributes/aliases b/test/integration/targets/vmware_guest_custom_attributes/aliases new file mode 100644 index 00000000000..845e8a6dad5 --- /dev/null +++ b/test/integration/targets/vmware_guest_custom_attributes/aliases @@ -0,0 +1,2 @@ +cloud/vcenter +unsupported diff --git a/test/integration/targets/vmware_guest_custom_attributes/tasks/main.yml b/test/integration/targets/vmware_guest_custom_attributes/tasks/main.yml new file mode 100644 index 00000000000..34a6b06592a --- /dev/null +++ b/test/integration/targets/vmware_guest_custom_attributes/tasks/main.yml @@ -0,0 +1,144 @@ +# Test code for the vmware_guest_custom_attributes module. +# Copyright: (c) 2018, Abhijeet Kasurde +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +# TODO: Current pinned version of vcsim does not support custom fields +# commenting testcase below + +- name: store the vcenter container ip + set_fact: + vcsim: "{{ lookup('env', 'vcenter_host') }}" + +- debug: var=vcsim + +- name: Wait for Flask controller to come up online + wait_for: + host: "{{ vcsim }}" + port: 5000 + state: started + +- name: kill vcsim + uri: + url: http://{{ vcsim }}:5000/killall + +- name: start vcsim + uri: + url: http://{{ vcsim }}:5000/spawn?datacenter=1&cluster=1&folder=0 + register: vcsim_instance + +- name: Wait for vcsim server to come up online + wait_for: + host: "{{ vcsim }}" + port: 443 + state: started + +- name: get a list of Datacenter from vcsim + uri: + url: http://{{ vcsim }}:5000/govc_find?filter=DC + register: datacenters + +- set_fact: dc1="{{ datacenters['json'][0] }}" + +- name: get a list of virtual machines from vcsim + uri: + url: http://{{ vcsim }}:5000/govc_find?filter=VM + register: vms + +- set_fact: vm1="{{ vms['json'][0] }}" + +- name: Add custom attribute to the given virtual machine + vmware_guest_custom_attributes: + validate_certs: False + hostname: "{{ vcsim }}" + username: "{{ vcsim_instance['json']['username'] }}" + password: "{{ vcsim_instance['json']['password'] }}" + datacenter: "{{ dc1 | basename }}" + name: "{{ vm1 | basename }}" + folder: "{{ vm1 | dirname }}" + state: present + attributes: + - name: 'sample_1' + value: 'sample_1_value' + - name: 'sample_2' + value: 'sample_2_value' + - name: 'sample_3' + value: 'sample_3_value' + register: guest_facts_0001 + +- debug: msg="{{ guest_facts_0001 }}" + +- assert: + that: + - "guest_facts_0001.changed" + +- name: Add custom attribute to the given virtual machine again + vmware_guest_custom_attributes: + validate_certs: False + hostname: "{{ vcsim }}" + username: "{{ vcsim_instance['json']['username'] }}" + password: "{{ vcsim_instance['json']['password'] }}" + datacenter: "{{ dc1 | basename }}" + name: "{{ vm1 | basename }}" + folder: "{{ vm1 | dirname }}" + state: present + attributes: + - name: 'sample_1' + value: 'sample_1_value' + - name: 'sample_2' + value: 'sample_2_value' + - name: 'sample_3' + value: 'sample_3_value' + register: guest_facts_0002 + +- debug: msg="{{ guest_facts_0002 }}" + +- assert: + that: + - "not guest_facts_0002.changed" + +- name: Remove custom attribute to the given virtual machine + vmware_guest_custom_attributes: + validate_certs: False + hostname: "{{ vcsim }}" + username: "{{ vcsim_instance['json']['username'] }}" + password: "{{ vcsim_instance['json']['password'] }}" + datacenter: "{{ dc1 | basename }}" + name: "{{ vm1 | basename }}" + folder: "{{ vm1 | dirname }}" + state: absent + attributes: + - name: 'sample_1' + - name: 'sample_2' + - name: 'sample_3' + register: guest_facts_0004 + +- debug: msg="{{ guest_facts_0004 }}" + +- assert: + that: + - "guest_facts_0004.changed" + +# TODO: vcsim returns duplicate values so removing custom attributes +# results in change. vCenter show correct behavior. Commenting this +# till this is supported by vcsim. +#- name: Remove custom attribute to the given virtual machine again +# vmware_guest_custom_attributes: +# validate_certs: False +# hostname: "{{ vcsim }}" +# username: "{{ vcsim_instance['json']['username'] }}" +# password: "{{ vcsim_instance['json']['password'] }}" +# datacenter: "{{ dc1 | basename }}" +# name: "{{ vm1 | basename }}" +# folder: "{{ vm1 | dirname }}" +# state: absent +# attributes: +# - name: 'sample_1' +# - name: 'sample_2' +# - name: 'sample_3' +# register: guest_facts_0005 + +#- debug: msg="{{ guest_facts_0005 }}" + +#- assert: +# that: +# - "not guest_facts_0005.changed"