cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

VMware: New module vmware_drs_group_facts (#50649)

Browse source 
* Added new vmware module for gathering facts for DRS groups
* Update lib/ansible/modules/cloud/vmware/vmware_drs_group_facts.py
* Updated doc
* Fixed integration test with mutual exclusive paramteres

Co-Authored-By: karstenjakobsen <karsten@karstenjakobsen.dk>
This commit is contained in:
Karsten Jakobsen 2019-01-14 17:26:12 +01:00 committed by Abhijeet Kasurde
parent 8fa01a22a1
commit 53437e80d9
3 changed files with 346 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

279
lib/ansible/modules/cloud/vmware/vmware_drs_group_facts.py Normal file
View file

@ -0,0 +1,279 @@
#!/usr/bin/python
# -*- coding: utf-8 -*-
# Copyright: (c) 2018, Karsten Kaj Jakobsen <kj@patientsky.com>
# 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'''
---
author:
- "Karsten Kaj Jakobsen (@karstenjakobsen)"
description:
- "This module can be used to gather facts about DRS VM/HOST groups from the given cluster."
extends_documentation_fragment: vmware.documentation
module: vmware_drs_group_facts
notes:
- "Tested on vSphere 6.5 and 6.7"
options:
cluster_name:
description:
- "Cluster to search for VM/Host groups."
- "If set, facts of DRS groups belonging this cluster will be returned."
- "Not needed if C(datacenter) is set."
required: false
datacenter:
aliases:
- datacenter_name
description:
- "Datacenter to search for DRS VM/Host groups."
required: true
requirements:
- "python >= 2.6"
- PyVmomi
short_description: "Gathers facts about DRS VM/Host groups on the given cluster"
version_added: "2.8"
'''
EXAMPLES = r'''
---
- name: "Gather DRS facts about given Cluster"
register: cluster_drs_group_facts
vmware_drs_group_facts:
hostname: "{{ vcenter_hostname }}"
password: "{{ vcenter_password }}"
username: "{{ vcenter_username }}"
cluster_name: "{{ cluster_name }}"
datacenter: "{{ datacenter }}"
delegate_to: localhost
- name: "Gather DRS group facts about all clusters in given datacenter"
register: cluster_drs_group_facts
vmware_drs_group_facts:
hostname: "{{ vcenter_hostname }}"
password: "{{ vcenter_password }}"
username: "{{ vcenter_username }}"
datacenter: "{{ datacenter }}"
delegate_to: localhost
'''
RETURN = r'''
drs_group_facts:
description: Metadata about DRS group from given cluster / datacenter
returned: always
type: dict
sample:
"drs_group_facts": {
"DC0_C0": [
{
"group_name": "GROUP_HOST_S01",
"hosts": [
"vm-01.zone",
"vm-02.zone"
],
"type": "host"
},
{
"group_name": "GROUP_HOST_S02",
"hosts": [
"vm-03.zone",
"vm-04.zone"
],
"type": "host"
},
{
"group_name": "GROUP_VM_S01",
"type": "vm",
"vms": [
"test-node01"
]
},
{
"group_name": "GROUP_VM_S02",
"type": "vm",
"vms": [
"test-node02"
]
}
],
"DC0_C1": []
}
'''
try:
from pyVmomi import vim
except ImportError:
pass
from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils.vmware import vmware_argument_spec, PyVmomi, find_datacenter_by_name, get_all_objs
class VmwareDrsGroupFactManager(PyVmomi):
def __init__(self, module, datacenter_name, cluster_name=None):
"""
Doctring: Init
"""
super(VmwareDrsGroupFactManager, self).__init__(module)
self.__datacenter_name = datacenter_name
self.__datacenter_obj = None
self.__cluster_name = cluster_name
self.__cluster_obj = None
self.__msg = 'Nothing to see here...'
self.__result = dict()
self.__changed = False
if datacenter_name:
datacenter_obj = find_datacenter_by_name(self.content, datacenter_name=datacenter_name)
self.cluster_obj_list = []
if datacenter_obj:
folder = datacenter_obj.hostFolder
self.cluster_obj_list = get_all_objs(self.content, [vim.ClusterComputeResource], folder)
else:
raise Exception("Datacenter '%s' not found" % self.__datacenter_name)
if cluster_name:
cluster_obj = self.find_cluster_by_name(cluster_name=self.__cluster_name)
if cluster_obj is None:
raise Exception("Cluster '%s' not found" % self.__cluster_name)
else:
self.cluster_obj_list = [cluster_obj]
def get_result(self):
"""
Docstring
"""
return self.__result
def __set_result(self, result):
"""
Sets result
Args:
result: drs group result list
Returns: None
"""
self.__result = result
def __get_all_from_group(self, group_obj, host_group=False):
"""
Return all VM / Host names using given group
Args:
group_obj: Group object
host_group: True if we want only host name from group
Returns: List of VM / Host names belonging to given group object
"""
obj_name_list = []
if not all([group_obj]):
return obj_name_list
if not host_group and isinstance(group_obj, vim.cluster.VmGroup):
obj_name_list = [vm.name for vm in group_obj.vm]
elif host_group and isinstance(group_obj, vim.cluster.HostGroup):
obj_name_list = [host.name for host in group_obj.host]
return obj_name_list
def __normalize_group_data(self, group_obj):
"""
Return human readable group spec
Args:
group_obj: Group object
Returns: Dictionary with DRS groups
"""
if not all([group_obj]):
return {}
# Check if group is a host group
if hasattr(group_obj, 'host'):
return dict(
group_name=group_obj.name,
hosts=self.__get_all_from_group(group_obj=group_obj, host_group=True),
type="host"
)
else:
return dict(
group_name=group_obj.name,
vms=self.__get_all_from_group(group_obj=group_obj),
type="vm"
)
def gather_facts(self):
"""
Gather DRS group facts about given cluster
Returns: Dictionary of clusters with DRS groups
"""
cluster_group_facts = dict()
for cluster_obj in self.cluster_obj_list:
cluster_group_facts[cluster_obj.name] = []
for drs_group in cluster_obj.configurationEx.group:
cluster_group_facts[cluster_obj.name].append(self.__normalize_group_data(drs_group))
self.__set_result(cluster_group_facts)
def main():
argument_spec = vmware_argument_spec()
argument_spec.update(
datacenter=dict(type='str', required=False, aliases=['datacenter_name']),
cluster_name=dict(type='str', required=False),
)
module = AnsibleModule(
argument_spec=argument_spec,
supports_check_mode=True,
required_one_of=[['cluster_name', 'datacenter']],
mutually_exclusive=[['cluster_name', 'datacenter']],
)
try:
# Create instance of VmwareDrsGroupManager
vmware_drs_group_facts = VmwareDrsGroupFactManager(module=module,
datacenter_name=module.params.get('datacenter'),
cluster_name=module.params.get('cluster_name', None))
vmware_drs_group_facts.gather_facts()
# Set results
results = dict(failed=False,
drs_group_facts=vmware_drs_group_facts.get_result())
except Exception as error:
results = dict(failed=True, msg="Error: %s" % error)
if results['failed']:
module.fail_json(**results)
else:
module.exit_json(**results)
if __name__ == "__main__":
main()

2
test/integration/targets/vmware_drs_group_facts/aliases Normal file
View file

@ -0,0 +1,2 @@
shippable/vcenter/group1
cloud/vcenter

65
test/integration/targets/vmware_drs_group_facts/tasks/main.yml Normal file
View file

@ -0,0 +1,65 @@
# Test code for the vmware_drs_group_facts module
# Copyright: (c) 2018, Karsten Kaj Jakobsen <kj@patientsky.com>
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
- 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?cluster=2
register: vcsim_instance
- name: Wait for Flask controller to come up online
wait_for:
host: "{{ vcsim }}"
port: 443
state: started
- debug: var=vcsim_instance
- name: Gather DRS group facts from given cluster
vmware_drs_group_facts:
hostname: "{{ vcsim }}"
username: "{{ vcsim_instance['json']['username'] }}"
password: "{{ vcsim_instance['json']['password'] }}"
cluster_name: DC0_C0
validate_certs: False
register: drs_group_0001_results
- debug: var=drs_group_0001_results
- assert:
that:
- "drs_group_0001_results.drs_group_facts.DC0_C0 is defined"
- "not drs_group_0001_results.drs_group_facts.DC0_C1 is defined"
- "not drs_group_0001_results.changed"
- name: Gather DRS group facts from given datacenter
vmware_drs_group_facts:
hostname: "{{ vcsim }}"
username: "{{ vcsim_instance['json']['username'] }}"
password: "{{ vcsim_instance['json']['password'] }}"
datacenter: DC0
validate_certs: False
register: drs_group_0002_results
- debug: var=drs_group_0002_results
- assert:
that:
- "drs_group_0002_results.drs_group_facts.DC0_C0 is defined"
- "drs_group_0002_results.drs_group_facts.DC0_C1 is defined"
- "not drs_group_0002_results.changed"