mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
VMware: Add tag facts to vmware_guest_facts (#47495)
Fixes: #46460 Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
This commit is contained in:
parent
5193e31886
commit
5f404eb0c1
2 changed files with 177 additions and 46 deletions
|
@ -52,7 +52,7 @@ class VmwareRestClient(object):
|
||||||
|
|
||||||
def check_required_library(self):
|
def check_required_library(self):
|
||||||
"""
|
"""
|
||||||
Function to check required libraries
|
Check required libraries
|
||||||
|
|
||||||
"""
|
"""
|
||||||
if not HAS_REQUESTS:
|
if not HAS_REQUESTS:
|
||||||
|
@ -71,7 +71,7 @@ class VmwareRestClient(object):
|
||||||
|
|
||||||
def connect_to_rest(self):
|
def connect_to_rest(self):
|
||||||
"""
|
"""
|
||||||
Function to connect to server using username and password
|
Connect to server using username and password
|
||||||
|
|
||||||
"""
|
"""
|
||||||
session = requests.Session()
|
session = requests.Session()
|
||||||
|
@ -79,12 +79,14 @@ class VmwareRestClient(object):
|
||||||
|
|
||||||
username = self.params.get('username', None)
|
username = self.params.get('username', None)
|
||||||
password = self.params.get('password', None)
|
password = self.params.get('password', None)
|
||||||
|
protocol = self.params.get('protocol', 'https')
|
||||||
|
hostname = self.params.get('hostname')
|
||||||
|
|
||||||
if not all([self.params.get('hostname', None), username, password]):
|
if not all([self.params.get('hostname', None), username, password]):
|
||||||
self.module.fail_json(msg="Missing one of the following : hostname, username, password."
|
self.module.fail_json(msg="Missing one of the following : hostname, username, password."
|
||||||
" Please read the documentation for more information.")
|
" Please read the documentation for more information.")
|
||||||
|
|
||||||
vcenter_url = "%(protocol)s://%(hostname)s/api" % self.params
|
vcenter_url = "%s://%s/api" % (protocol, hostname)
|
||||||
|
|
||||||
# Get request connector
|
# Get request connector
|
||||||
connector = get_requests_connector(session=session, url=vcenter_url)
|
connector = get_requests_connector(session=session, url=vcenter_url)
|
||||||
|
@ -100,7 +102,7 @@ class VmwareRestClient(object):
|
||||||
try:
|
try:
|
||||||
session_id = session_svc.create()
|
session_id = session_svc.create()
|
||||||
except OSError as os_err:
|
except OSError as os_err:
|
||||||
self.module.fail_json(msg="Failed to login to %s: %s" % (self.params['hostname'],
|
self.module.fail_json(msg="Failed to login to %s: %s" % (hostname,
|
||||||
to_native(os_err)))
|
to_native(os_err)))
|
||||||
|
|
||||||
if session_id is None:
|
if session_id is None:
|
||||||
|
@ -112,7 +114,7 @@ class VmwareRestClient(object):
|
||||||
stub_config.connector.set_security_context(session_security_context)
|
stub_config.connector.set_security_context(session_security_context)
|
||||||
|
|
||||||
if stub_config is None:
|
if stub_config is None:
|
||||||
self.module.fail_json(msg="Failed to login to %(hostname)s" % self.params)
|
self.module.fail_json(msg="Failed to login to %s" % hostname)
|
||||||
return stub_config
|
return stub_config
|
||||||
|
|
||||||
@staticmethod
|
@staticmethod
|
||||||
|
@ -134,3 +136,39 @@ class VmwareRestClient(object):
|
||||||
fallback=(env_fallback, ['VMWARE_VALIDATE_CERTS']),
|
fallback=(env_fallback, ['VMWARE_VALIDATE_CERTS']),
|
||||||
default=True),
|
default=True),
|
||||||
)
|
)
|
||||||
|
|
||||||
|
def get_tags_for_object(self, tag_service, tag_assoc_svc, dobj):
|
||||||
|
"""
|
||||||
|
Return list of tag objects associated with an object
|
||||||
|
Args:
|
||||||
|
dobj: Dynamic object
|
||||||
|
tag_service: Tag service object
|
||||||
|
tag_assoc_svc: Tag Association object
|
||||||
|
Returns: List of tag objects associated with the given object
|
||||||
|
"""
|
||||||
|
tag_ids = tag_assoc_svc.list_attached_tags(dobj)
|
||||||
|
tags = []
|
||||||
|
for tag_id in tag_ids:
|
||||||
|
tags.append(tag_service.get(tag_id))
|
||||||
|
return tags
|
||||||
|
|
||||||
|
def get_vm_tags(self, tag_service, tag_association_svc, vm_mid=None):
|
||||||
|
"""
|
||||||
|
Return list of tag name associated with virtual machine
|
||||||
|
Args:
|
||||||
|
tag_service: Tag service object
|
||||||
|
tag_association_svc: Tag association object
|
||||||
|
vm_mid: Dynamic object for virtual machine
|
||||||
|
|
||||||
|
Returns: List of tag names associated with the given virtual machine
|
||||||
|
|
||||||
|
"""
|
||||||
|
tags = []
|
||||||
|
if vm_mid is None:
|
||||||
|
return tags
|
||||||
|
dynamic_managed_object = DynamicID(type='VirtualMachine', id=vm_mid)
|
||||||
|
|
||||||
|
temp_tags_model = self.get_tags_for_object(tag_service, tag_association_svc, dynamic_managed_object)
|
||||||
|
for t in temp_tags_model:
|
||||||
|
tags.append(t.name)
|
||||||
|
return tags
|
||||||
|
|
|
@ -8,9 +8,11 @@ from __future__ import absolute_import, division, print_function
|
||||||
__metaclass__ = type
|
__metaclass__ = type
|
||||||
|
|
||||||
|
|
||||||
ANSIBLE_METADATA = {'metadata_version': '1.1',
|
ANSIBLE_METADATA = {
|
||||||
'status': ['preview'],
|
'metadata_version': '1.1',
|
||||||
'supported_by': 'community'}
|
'status': ['preview'],
|
||||||
|
'supported_by': 'community'
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
DOCUMENTATION = '''
|
DOCUMENTATION = '''
|
||||||
|
@ -18,7 +20,7 @@ DOCUMENTATION = '''
|
||||||
module: vmware_guest_facts
|
module: vmware_guest_facts
|
||||||
short_description: Gather facts about a single VM
|
short_description: Gather facts about a single VM
|
||||||
description:
|
description:
|
||||||
- Gather facts about a single VM on a VMware ESX cluster
|
- Gather facts about a single VM on a VMware ESX cluster.
|
||||||
version_added: 2.3
|
version_added: 2.3
|
||||||
author:
|
author:
|
||||||
- Loic Blot (@nerzhul) <loic.blot@unix-experience.fr>
|
- Loic Blot (@nerzhul) <loic.blot@unix-experience.fr>
|
||||||
|
@ -29,40 +31,48 @@ requirements:
|
||||||
- PyVmomi
|
- PyVmomi
|
||||||
options:
|
options:
|
||||||
name:
|
name:
|
||||||
description:
|
description:
|
||||||
- Name of the VM to work with
|
- Name of the VM to work with
|
||||||
- This is required if UUID is not supplied.
|
- This is required if UUID is not supplied.
|
||||||
name_match:
|
name_match:
|
||||||
description:
|
description:
|
||||||
- If multiple VMs matching the name, use the first or last found
|
- If multiple VMs matching the name, use the first or last found
|
||||||
default: 'first'
|
default: 'first'
|
||||||
choices: ['first', 'last']
|
choices: ['first', 'last']
|
||||||
uuid:
|
uuid:
|
||||||
description:
|
description:
|
||||||
- UUID of the instance to manage if known, this is VMware's unique identifier.
|
- UUID of the instance to manage if known, this is VMware's unique identifier.
|
||||||
- This is required if name is not supplied.
|
- This is required if name is not supplied.
|
||||||
folder:
|
folder:
|
||||||
description:
|
description:
|
||||||
- Destination folder, absolute or relative path to find an existing guest.
|
- Destination folder, absolute or relative path to find an existing guest.
|
||||||
- This is required if name is supplied.
|
- This is required if name is supplied.
|
||||||
- The folder should include the datacenter. ESX's datacenter is ha-datacenter
|
- The folder should include the datacenter. ESX's datacenter is ha-datacenter
|
||||||
- 'Examples:'
|
- 'Examples:'
|
||||||
- ' folder: /ha-datacenter/vm'
|
- ' folder: /ha-datacenter/vm'
|
||||||
- ' folder: ha-datacenter/vm'
|
- ' folder: ha-datacenter/vm'
|
||||||
- ' folder: /datacenter1/vm'
|
- ' folder: /datacenter1/vm'
|
||||||
- ' folder: datacenter1/vm'
|
- ' folder: datacenter1/vm'
|
||||||
- ' folder: /datacenter1/vm/folder1'
|
- ' folder: /datacenter1/vm/folder1'
|
||||||
- ' folder: datacenter1/vm/folder1'
|
- ' folder: datacenter1/vm/folder1'
|
||||||
- ' folder: /folder1/datacenter1/vm'
|
- ' folder: /folder1/datacenter1/vm'
|
||||||
- ' folder: folder1/datacenter1/vm'
|
- ' folder: folder1/datacenter1/vm'
|
||||||
- ' folder: /folder1/datacenter1/vm/folder2'
|
- ' folder: /folder1/datacenter1/vm/folder2'
|
||||||
- ' folder: vm/folder2'
|
- ' folder: vm/folder2'
|
||||||
- ' folder: folder2'
|
- ' folder: folder2'
|
||||||
default: /vm
|
|
||||||
datacenter:
|
datacenter:
|
||||||
description:
|
description:
|
||||||
- Destination datacenter for the deploy operation
|
- Destination datacenter for the deploy operation
|
||||||
required: True
|
required: True
|
||||||
|
tags:
|
||||||
|
description:
|
||||||
|
- Whether to show tags or not.
|
||||||
|
- If set C(True), shows tag facts.
|
||||||
|
- If set C(False), hides tags facts.
|
||||||
|
- vSphere Automation SDK and vCloud Suite SDK is required.
|
||||||
|
default: 'no'
|
||||||
|
type: bool
|
||||||
|
version_added: '2.8'
|
||||||
extends_documentation_fragment: vmware.documentation
|
extends_documentation_fragment: vmware.documentation
|
||||||
'''
|
'''
|
||||||
|
|
||||||
|
@ -84,12 +94,72 @@ instance:
|
||||||
description: metadata about the virtual machine
|
description: metadata about the virtual machine
|
||||||
returned: always
|
returned: always
|
||||||
type: dict
|
type: dict
|
||||||
sample: None
|
sample: {
|
||||||
|
"annotation": "",
|
||||||
|
"current_snapshot": null,
|
||||||
|
"customvalues": {},
|
||||||
|
"guest_consolidation_needed": false,
|
||||||
|
"guest_question": null,
|
||||||
|
"guest_tools_status": "guestToolsNotRunning",
|
||||||
|
"guest_tools_version": "10247",
|
||||||
|
"hw_cores_per_socket": 1,
|
||||||
|
"hw_datastores": [
|
||||||
|
"ds_226_3"
|
||||||
|
],
|
||||||
|
"hw_esxi_host": "10.76.33.226",
|
||||||
|
"hw_eth0": {
|
||||||
|
"addresstype": "assigned",
|
||||||
|
"ipaddresses": null,
|
||||||
|
"label": "Network adapter 1",
|
||||||
|
"macaddress": "00:50:56:87:a5:9a",
|
||||||
|
"macaddress_dash": "00-50-56-87-a5-9a",
|
||||||
|
"portgroup_key": null,
|
||||||
|
"portgroup_portkey": null,
|
||||||
|
"summary": "VM Network"
|
||||||
|
},
|
||||||
|
"hw_files": [
|
||||||
|
"[ds_226_3] ubuntu_t/ubuntu_t.vmx",
|
||||||
|
"[ds_226_3] ubuntu_t/ubuntu_t.nvram",
|
||||||
|
"[ds_226_3] ubuntu_t/ubuntu_t.vmsd",
|
||||||
|
"[ds_226_3] ubuntu_t/vmware.log",
|
||||||
|
"[ds_226_3] u0001/u0001.vmdk"
|
||||||
|
],
|
||||||
|
"hw_folder": "/DC0/vm/Discovered virtual machine",
|
||||||
|
"hw_guest_full_name": null,
|
||||||
|
"hw_guest_ha_state": null,
|
||||||
|
"hw_guest_id": null,
|
||||||
|
"hw_interfaces": [
|
||||||
|
"eth0"
|
||||||
|
],
|
||||||
|
"hw_is_template": false,
|
||||||
|
"hw_memtotal_mb": 1024,
|
||||||
|
"hw_name": "ubuntu_t",
|
||||||
|
"hw_power_status": "poweredOff",
|
||||||
|
"hw_processor_count": 1,
|
||||||
|
"hw_product_uuid": "4207072c-edd8-3bd5-64dc-903fd3a0db04",
|
||||||
|
"hw_version": "vmx-13",
|
||||||
|
"instance_uuid": "5007769d-add3-1e12-f1fe-225ae2a07caf",
|
||||||
|
"ipv4": null,
|
||||||
|
"ipv6": null,
|
||||||
|
"module_hw": true,
|
||||||
|
"snapshots": [],
|
||||||
|
"tags": [
|
||||||
|
"backup"
|
||||||
|
],
|
||||||
|
"vnc": {}
|
||||||
|
}
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from ansible.module_utils.basic import AnsibleModule
|
from ansible.module_utils.basic import AnsibleModule
|
||||||
from ansible.module_utils._text import to_text
|
from ansible.module_utils._text import to_text
|
||||||
from ansible.module_utils.vmware import PyVmomi, vmware_argument_spec
|
from ansible.module_utils.vmware import PyVmomi, vmware_argument_spec
|
||||||
|
from ansible.module_utils.vmware_rest_client import VmwareRestClient
|
||||||
|
try:
|
||||||
|
from com.vmware.vapi.std_client import DynamicID
|
||||||
|
from com.vmware.cis.tagging_client import Tag, TagAssociation
|
||||||
|
HAS_VCLOUD = True
|
||||||
|
except ImportError:
|
||||||
|
HAS_VCLOUD = False
|
||||||
|
|
||||||
|
|
||||||
class PyVmomiHelper(PyVmomi):
|
class PyVmomiHelper(PyVmomi):
|
||||||
|
@ -97,21 +167,30 @@ class PyVmomiHelper(PyVmomi):
|
||||||
super(PyVmomiHelper, self).__init__(module)
|
super(PyVmomiHelper, self).__init__(module)
|
||||||
|
|
||||||
|
|
||||||
|
class VmwareTag(VmwareRestClient):
|
||||||
|
def __init__(self, module):
|
||||||
|
super(VmwareTag, self).__init__(module)
|
||||||
|
self.tag_service = Tag(self.connect)
|
||||||
|
self.tag_association_svc = TagAssociation(self.connect)
|
||||||
|
|
||||||
|
|
||||||
def main():
|
def main():
|
||||||
argument_spec = vmware_argument_spec()
|
argument_spec = vmware_argument_spec()
|
||||||
argument_spec.update(
|
argument_spec.update(
|
||||||
name=dict(type='str'),
|
name=dict(type='str'),
|
||||||
name_match=dict(type='str', choices=['first', 'last'], default='first'),
|
name_match=dict(type='str', choices=['first', 'last'], default='first'),
|
||||||
uuid=dict(type='str'),
|
uuid=dict(type='str'),
|
||||||
folder=dict(type='str', default='/vm'),
|
folder=dict(type='str'),
|
||||||
datacenter=dict(type='str', required=True),
|
datacenter=dict(type='str', required=True),
|
||||||
|
tags=dict(type='bool', default=False)
|
||||||
)
|
)
|
||||||
module = AnsibleModule(argument_spec=argument_spec,
|
module = AnsibleModule(argument_spec=argument_spec,
|
||||||
required_one_of=[['name', 'uuid']])
|
required_one_of=[['name', 'uuid']])
|
||||||
|
|
||||||
# FindByInventoryPath() does not require an absolute path
|
if module.params.get('folder'):
|
||||||
# so we should leave the input folder path unmodified
|
# FindByInventoryPath() does not require an absolute path
|
||||||
module.params['folder'] = module.params['folder'].rstrip('/')
|
# so we should leave the input folder path unmodified
|
||||||
|
module.params['folder'] = module.params['folder'].rstrip('/')
|
||||||
|
|
||||||
pyv = PyVmomiHelper(module)
|
pyv = PyVmomiHelper(module)
|
||||||
# Check if the VM exists before continuing
|
# Check if the VM exists before continuing
|
||||||
|
@ -120,11 +199,25 @@ def main():
|
||||||
# VM already exists
|
# VM already exists
|
||||||
if vm:
|
if vm:
|
||||||
try:
|
try:
|
||||||
module.exit_json(instance=pyv.gather_facts(vm))
|
instance = pyv.gather_facts(vm)
|
||||||
|
if module.params.get('tags'):
|
||||||
|
if not HAS_VCLOUD:
|
||||||
|
module.fail_json(msg="Unable to find 'vCloud Suite SDK' Python library which is required."
|
||||||
|
" Please refer this URL for installation steps"
|
||||||
|
" - https://code.vmware.com/web/sdk/60/vcloudsuite-python")
|
||||||
|
|
||||||
|
vm_rest_client = VmwareTag(module)
|
||||||
|
instance.update(
|
||||||
|
tags=vm_rest_client.get_vm_tags(vm_rest_client.tag_service,
|
||||||
|
vm_rest_client.tag_association_svc,
|
||||||
|
vm_mid=vm._moId)
|
||||||
|
)
|
||||||
|
module.exit_json(instance=instance)
|
||||||
except Exception as exc:
|
except Exception as exc:
|
||||||
module.fail_json(msg="Fact gather failed with exception %s" % to_text(exc))
|
module.fail_json(msg="Fact gather failed with exception %s" % to_text(exc))
|
||||||
else:
|
else:
|
||||||
module.fail_json(msg="Unable to gather facts for non-existing VM %s" % module.params.get('uuid') or module.params.get('name'))
|
module.fail_json(msg="Unable to gather facts for non-existing VM %s" % (module.params.get('uuid') or
|
||||||
|
module.params.get('name')))
|
||||||
|
|
||||||
|
|
||||||
if __name__ == '__main__':
|
if __name__ == '__main__':
|
||||||
|
|
Loading…
Reference in a new issue