88464efdc4
* use connecion method from module_utils * use resource group related to host system Addresses #2911
943 lines
34 KiB
Python
943 lines
34 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
# This file is part of Ansible
|
|
#
|
|
# Ansible is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# Ansible is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
DOCUMENTATION = '''
|
|
---
|
|
module: vmware_guest
|
|
short_description: Manages virtualmachines in vcenter
|
|
description:
|
|
- Uses pyvmomi to ...
|
|
- copy a template to a new virtualmachine
|
|
- poweron/poweroff/restart a virtualmachine
|
|
- remove a virtualmachine
|
|
version_added: 2.2
|
|
author: James Tanner (@jctanner) <tanner.jc@gmail.com>
|
|
notes:
|
|
- Tested on vSphere 6.0
|
|
requirements:
|
|
- "python >= 2.6"
|
|
- PyVmomi
|
|
options:
|
|
state:
|
|
description:
|
|
- What state should the virtualmachine be in?
|
|
required: True
|
|
choices: ['present', 'absent', 'poweredon', 'poweredoff', 'restarted', 'suspended']
|
|
name:
|
|
description:
|
|
- Name of the newly deployed guest
|
|
required: True
|
|
name_match:
|
|
description:
|
|
- If multiple vms matching the name, use the first or last found
|
|
required: False
|
|
default: 'first'
|
|
choices: ['first', 'last']
|
|
uuid:
|
|
description:
|
|
- UUID of the instance to manage if known, this is vmware's unique identifier.
|
|
- This is required if name is not supplied.
|
|
required: False
|
|
template:
|
|
description:
|
|
- Name of the template to deploy, if needed to create the guest (state=present).
|
|
- If the guest exists already this setting will be ignored.
|
|
required: False
|
|
folder:
|
|
description:
|
|
- Destination folder path for the new guest
|
|
required: False
|
|
hardware:
|
|
description:
|
|
- Attributes such as cpus, memory, osid, and disk controller
|
|
required: False
|
|
disk:
|
|
description:
|
|
- A list of disks to add
|
|
required: False
|
|
nic:
|
|
description:
|
|
- A list of nics to add
|
|
required: False
|
|
wait_for_ip_address:
|
|
description:
|
|
- Wait until vcenter detects an IP address for the guest
|
|
required: False
|
|
force:
|
|
description:
|
|
- Ignore warnings and complete the actions
|
|
required: False
|
|
datacenter:
|
|
description:
|
|
- Destination datacenter for the deploy operation
|
|
required: True
|
|
esxi_hostname:
|
|
description:
|
|
- The esxi hostname where the VM will run.
|
|
required: True
|
|
extends_documentation_fragment: vmware.documentation
|
|
'''
|
|
|
|
EXAMPLES = '''
|
|
Example from Ansible playbook
|
|
#
|
|
# Crate VM from template
|
|
#
|
|
- name: create the VM
|
|
vmware_guest:
|
|
validate_certs: False
|
|
hostname: 192.0.2.44
|
|
username: administrator@vsphere.local
|
|
password: vmware
|
|
name: testvm_2
|
|
state: poweredon
|
|
folder: testvms
|
|
disk:
|
|
- size_gb: 10
|
|
type: thin
|
|
datastore: g73_datastore
|
|
nic:
|
|
- type: vmxnet3
|
|
network: VM Network
|
|
network_type: standard
|
|
hardware:
|
|
memory_mb: 512
|
|
num_cpus: 1
|
|
osid: centos64guest
|
|
scsi: paravirtual
|
|
datacenter: datacenter1
|
|
esxi_hostname: 192.0.2.117
|
|
template: template_el7
|
|
wait_for_ip_address: yes
|
|
register: deploy
|
|
|
|
#
|
|
# Gather facts only
|
|
#
|
|
- name: gather the VM facts
|
|
vmware_guest:
|
|
validate_certs: False
|
|
hostname: 192.168.1.209
|
|
username: administrator@vsphere.local
|
|
password: vmware
|
|
name: testvm_2
|
|
esxi_hostname: 192.168.1.117
|
|
register: facts
|
|
'''
|
|
|
|
RETURN = """
|
|
instance:
|
|
descripton: metadata about the new virtualmachine
|
|
returned: always
|
|
type: dict
|
|
sample: None
|
|
"""
|
|
|
|
try:
|
|
import json
|
|
except ImportError:
|
|
import simplejson as json
|
|
|
|
HAS_PYVMOMI = False
|
|
try:
|
|
import pyVmomi
|
|
from pyVmomi import vim
|
|
HAS_PYVMOMI = True
|
|
except ImportError:
|
|
pass
|
|
|
|
import os
|
|
import string
|
|
import time
|
|
|
|
from ansible.module_utils.urls import fetch_url
|
|
|
|
class PyVmomiHelper(object):
|
|
|
|
def __init__(self, module):
|
|
|
|
if not HAS_PYVMOMI:
|
|
module.fail_json(msg='pyvmomi module required')
|
|
|
|
self.module = module
|
|
self.params = module.params
|
|
self.si = None
|
|
self.smartconnect()
|
|
self.datacenter = None
|
|
self.folders = None
|
|
self.foldermap = None
|
|
|
|
def smartconnect(self):
|
|
self.content = connect_to_api(self.module)
|
|
|
|
def _build_folder_tree(self, folder, tree={}, treepath=None):
|
|
|
|
tree = {'virtualmachines': [],
|
|
'subfolders': {},
|
|
'vimobj': folder,
|
|
'name': folder.name}
|
|
|
|
children = None
|
|
if hasattr(folder, 'childEntity'):
|
|
children = folder.childEntity
|
|
|
|
if children:
|
|
for child in children:
|
|
if child == folder or child in tree:
|
|
continue
|
|
if type(child) == vim.Folder:
|
|
ctree = self._build_folder_tree(child)
|
|
tree['subfolders'][child] = dict.copy(ctree)
|
|
elif type(child) == vim.VirtualMachine:
|
|
tree['virtualmachines'].append(child)
|
|
else:
|
|
if type(folder) == vim.VirtualMachine:
|
|
return folder
|
|
return tree
|
|
|
|
|
|
def _build_folder_map(self, folder, vmap={}, inpath='/'):
|
|
|
|
''' Build a searchable index for vms+uuids+folders '''
|
|
|
|
if type(folder) == tuple:
|
|
folder = folder[1]
|
|
|
|
if not 'names' in vmap:
|
|
vmap['names'] = {}
|
|
if not 'uuids' in vmap:
|
|
vmap['uuids'] = {}
|
|
if not 'paths' in vmap:
|
|
vmap['paths'] = {}
|
|
|
|
if inpath == '/':
|
|
thispath = '/vm'
|
|
else:
|
|
thispath = os.path.join(inpath, folder['name'])
|
|
|
|
if thispath not in vmap['paths']:
|
|
vmap['paths'][thispath] = []
|
|
|
|
# helpful for isolating folder objects later on
|
|
if not 'path_by_fvim' in vmap:
|
|
vmap['path_by_fvim'] = {}
|
|
if not 'fvim_by_path' in vmap:
|
|
vmap['fvim_by_path'] = {}
|
|
# store object by path and store path by object
|
|
vmap['fvim_by_path'][thispath] = folder['vimobj']
|
|
vmap['path_by_fvim'][folder['vimobj']] = thispath
|
|
|
|
# helpful for isolating vm objects later on
|
|
if not 'path_by_vvim' in vmap:
|
|
vmap['path_by_vvim'] = {}
|
|
if not 'vvim_by_path' in vmap:
|
|
vmap['vvim_by_path'] = {}
|
|
if thispath not in vmap['vvim_by_path']:
|
|
vmap['vvim_by_path'][thispath] = []
|
|
|
|
|
|
for item in folder.items():
|
|
k = item[0]
|
|
v = item[1]
|
|
|
|
if k == 'name':
|
|
pass
|
|
elif k == 'subfolders':
|
|
for x in v.items():
|
|
vmap = self._build_folder_map(x, vmap=vmap, inpath=thispath)
|
|
elif k == 'virtualmachines':
|
|
for x in v:
|
|
if not x.config.name in vmap['names']:
|
|
vmap['names'][x.config.name] = []
|
|
vmap['names'][x.config.name].append(x.config.uuid)
|
|
vmap['uuids'][x.config.uuid] = x.config.name
|
|
vmap['paths'][thispath].append(x.config.uuid)
|
|
|
|
if x not in vmap['vvim_by_path'][thispath]:
|
|
vmap['vvim_by_path'][thispath].append(x)
|
|
if x not in vmap['path_by_vvim']:
|
|
vmap['path_by_vvim'][x] = thispath
|
|
return vmap
|
|
|
|
def getfolders(self):
|
|
|
|
if not self.datacenter:
|
|
self.get_datacenter()
|
|
self.folders = self._build_folder_tree(self.datacenter.vmFolder)
|
|
self.folder_map = self._build_folder_map(self.folders)
|
|
return (self.folders, self.folder_map)
|
|
|
|
def get_datacenter(self):
|
|
self.datacenter = get_obj(self.content, [vim.Datacenter],
|
|
self.params['datacenter'])
|
|
|
|
def getvm(self, name=None, uuid=None, folder=None, name_match=None):
|
|
|
|
# https://www.vmware.com/support/developer/vc-sdk/visdk2xpubs/ReferenceGuide/vim.SearchIndex.html
|
|
# self.si.content.searchIndex.FindByInventoryPath('DC1/vm/test_folder')
|
|
|
|
vm = None
|
|
folder_path = None
|
|
|
|
if uuid:
|
|
vm = self.si.content.searchIndex.FindByUuid(uuid=uuid, vmSearch=True)
|
|
|
|
elif folder:
|
|
|
|
if self.params['folder'].endswith('/'):
|
|
self.params['folder'] = self.params['folder'][0:-1]
|
|
|
|
# Build the absolute folder path to pass into the search method
|
|
searchpath = None
|
|
if self.params['folder'].startswith('/vm'):
|
|
searchpath = '%s' % self.params['datacenter']
|
|
searchpath += self.params['folder']
|
|
elif self.params['folder'].startswith('/'):
|
|
searchpath = '%s' % self.params['datacenter']
|
|
searchpath += '/vm' + self.params['folder']
|
|
else:
|
|
# need to look for matching absolute path
|
|
if not self.folders:
|
|
self.getfolders()
|
|
paths = self.folder_map['paths'].keys()
|
|
paths = [x for x in paths if x.endswith(self.params['folder'])]
|
|
if len(paths) > 1:
|
|
self.module.fail_json(msg='%s matches more than one folder. Please use the absolute path starting with /vm/' % self.params['folder'])
|
|
elif paths:
|
|
searchpath = paths[0]
|
|
|
|
if searchpath:
|
|
# get all objects for this path ...
|
|
fObj = self.content.searchIndex.FindByInventoryPath(searchpath)
|
|
if fObj:
|
|
if isinstance(fObj, vim.Datacenter):
|
|
fObj = fObj.vmFolder
|
|
for cObj in fObj.childEntity:
|
|
if not type(cObj) == vim.VirtualMachine:
|
|
continue
|
|
if cObj.name == name:
|
|
vm = cObj
|
|
break
|
|
|
|
else:
|
|
# FIXME - this is unused if folder has a default value
|
|
vmList = get_all_objs(self.content, [vim.VirtualMachine])
|
|
if name_match:
|
|
if name_match == 'first':
|
|
vm = get_obj(self.content, [vim.VirtualMachine], name)
|
|
elif name_match == 'last':
|
|
matches = []
|
|
vmList = get_all_objs(self.content, [vim.VirtualMachine])
|
|
for thisvm in vmList:
|
|
if thisvm.config.name == name:
|
|
matches.append(thisvm)
|
|
if matches:
|
|
vm = matches[-1]
|
|
else:
|
|
matches = []
|
|
vmList = get_all_objs(self.content, [vim.VirtualMachine])
|
|
for thisvm in vmList:
|
|
if thisvm.config.name == name:
|
|
matches.append(thisvm)
|
|
if len(matches) > 1:
|
|
module.fail_json(msg='more than 1 vm exists by the name %s. Please specify a uuid, or a folder, or a datacenter or name_match' % name)
|
|
if matches:
|
|
vm = matches[0]
|
|
|
|
return vm
|
|
|
|
|
|
def set_powerstate(self, vm, state, force):
|
|
"""
|
|
Set the power status for a VM determined by the current and
|
|
requested states. force is forceful
|
|
"""
|
|
facts = self.gather_facts(vm)
|
|
expected_state = state.replace('_', '').lower()
|
|
current_state = facts['hw_power_status'].lower()
|
|
result = {}
|
|
|
|
# Need Force
|
|
if not force and current_state not in ['poweredon', 'poweredoff']:
|
|
return "VM is in %s power state. Force is required!" % current_state
|
|
|
|
# State is already true
|
|
if current_state == expected_state:
|
|
result['changed'] = False
|
|
result['failed'] = False
|
|
else:
|
|
task = None
|
|
try:
|
|
if expected_state == 'poweredoff':
|
|
task = vm.PowerOff()
|
|
|
|
elif expected_state == 'poweredon':
|
|
task = vm.PowerOn()
|
|
|
|
elif expected_state == 'restarted':
|
|
if current_state in ('poweredon', 'poweringon', 'resetting'):
|
|
task = vm.Reset()
|
|
else:
|
|
result = {'changed': False, 'failed': True,
|
|
'msg': "Cannot restart VM in the current state %s" % current_state}
|
|
|
|
except Exception:
|
|
result = {'changed': False, 'failed': True,
|
|
'msg': get_exception()}
|
|
|
|
if task:
|
|
self.wait_for_task(task)
|
|
if task.info.state == 'error':
|
|
result = {'changed': False, 'failed': True, 'msg': task.info.error.msg}
|
|
else:
|
|
result = {'changed': True, 'failed': False}
|
|
|
|
# need to get new metadata if changed
|
|
if result['changed']:
|
|
newvm = self.getvm(uuid=vm.config.uuid)
|
|
facts = self.gather_facts(newvm)
|
|
result['instance'] = facts
|
|
return result
|
|
|
|
|
|
def gather_facts(self, vm):
|
|
|
|
''' Gather facts from vim.VirtualMachine object. '''
|
|
|
|
facts = {
|
|
'module_hw': True,
|
|
'hw_name': vm.config.name,
|
|
'hw_power_status': vm.summary.runtime.powerState,
|
|
'hw_guest_full_name': vm.summary.guest.guestFullName,
|
|
'hw_guest_id': vm.summary.guest.guestId,
|
|
'hw_product_uuid': vm.config.uuid,
|
|
'hw_processor_count': vm.config.hardware.numCPU,
|
|
'hw_memtotal_mb': vm.config.hardware.memoryMB,
|
|
'hw_interfaces':[],
|
|
'ipv4': None,
|
|
'ipv6': None,
|
|
}
|
|
|
|
netDict = {}
|
|
for device in vm.guest.net:
|
|
mac = device.macAddress
|
|
ips = list(device.ipAddress)
|
|
netDict[mac] = ips
|
|
for k,v in netDict.iteritems():
|
|
for ipaddress in v:
|
|
if ipaddress:
|
|
if '::' in ipaddress:
|
|
facts['ipv6'] = ipaddress
|
|
else:
|
|
facts['ipv4'] = ipaddress
|
|
|
|
for idx,entry in enumerate(vm.config.hardware.device):
|
|
if not hasattr(entry, 'macAddress'):
|
|
continue
|
|
|
|
factname = 'hw_eth' + str(idx)
|
|
facts[factname] = {
|
|
'addresstype': entry.addressType,
|
|
'label': entry.deviceInfo.label,
|
|
'macaddress': entry.macAddress,
|
|
'ipaddresses': netDict.get(entry.macAddress, None),
|
|
'macaddress_dash': entry.macAddress.replace(':', '-'),
|
|
'summary': entry.deviceInfo.summary,
|
|
}
|
|
facts['hw_interfaces'].append('eth'+str(idx))
|
|
|
|
return facts
|
|
|
|
|
|
def remove_vm(self, vm):
|
|
# https://www.vmware.com/support/developer/converter-sdk/conv60_apireference/vim.ManagedEntity.html#destroy
|
|
task = vm.Destroy()
|
|
self.wait_for_task(task)
|
|
|
|
if task.info.state == 'error':
|
|
return ({'changed': False, 'failed': True, 'msg': task.info.error.msg})
|
|
else:
|
|
return ({'changed': True, 'failed': False})
|
|
|
|
|
|
def deploy_template(self, poweron=False, wait_for_ip=False):
|
|
|
|
# https://github.com/vmware/pyvmomi-community-samples/blob/master/samples/clone_vm.py
|
|
# https://www.vmware.com/support/developer/vc-sdk/visdk25pubs/ReferenceGuide/vim.vm.CloneSpec.html
|
|
# https://www.vmware.com/support/developer/vc-sdk/visdk25pubs/ReferenceGuide/vim.vm.ConfigSpec.html
|
|
# https://www.vmware.com/support/developer/vc-sdk/visdk41pubs/ApiReference/vim.vm.RelocateSpec.html
|
|
|
|
# FIXME:
|
|
# - clusters
|
|
# - multiple datacenters
|
|
# - resource pools
|
|
# - multiple templates by the same name
|
|
# - multiple disks
|
|
# - changing the esx host is ignored?
|
|
# - static IPs
|
|
|
|
# FIXME: need to search for this in the same way as guests to ensure accuracy
|
|
template = get_obj(self.content, [vim.VirtualMachine], self.params['template'])
|
|
if not template:
|
|
self.module.fail_json(msg="Could not find a template named %s" % self.params['template'])
|
|
|
|
datacenters = get_all_objs(self.content, [vim.Datacenter])
|
|
datacenter = get_obj(self.content, [vim.Datacenter],
|
|
self.params['datacenter'])
|
|
if not datacenter:
|
|
self.module.fail_json(msg='No datacenter named %s was found' % self.params['datacenter'])
|
|
|
|
if not self.foldermap:
|
|
self.folders, self.foldermap = self.getfolders()
|
|
|
|
# find matching folders
|
|
if self.params['folder'].startswith('/'):
|
|
folders = [x for x in self.foldermap['fvim_by_path'].items() if x[0] == self.params['folder']]
|
|
else:
|
|
folders = [x for x in self.foldermap['fvim_by_path'].items() if x[0].endswith(self.params['folder'])]
|
|
|
|
# throw error if more than one match or no matches
|
|
if len(folders) == 0:
|
|
self.module.fail_json(msg='no folder matched the path: %s' % self.params['folder'])
|
|
elif len(folders) > 1:
|
|
self.module.fail_json(msg='too many folders matched "%s", please give the full path starting with /vm/' % self.params['folder'])
|
|
|
|
# grab the folder vim object
|
|
destfolder = folders[0][1]
|
|
|
|
# FIXME: cluster or hostsystem ... ?
|
|
#cluster = get_obj(self.content, [vim.ClusterComputeResource], self.params['esxi']['hostname'])
|
|
hostsystem = get_obj(self.content, [vim.HostSystem], self.params['esxi_hostname'])
|
|
|
|
# set the destination datastore in the relocation spec
|
|
if self.params['disk']:
|
|
datastore_name = self.params['disk'][0]['datastore']
|
|
datastore = get_obj(self.content, [vim.Datastore], datastore_name)
|
|
else:
|
|
# use the template's existing DS
|
|
disks = [x for x in template.config.hardware.device if isinstance(x, vim.vm.device.VirtualDisk)]
|
|
datastore = disks[0].backing.datastore
|
|
datastore_name = datastore.name
|
|
|
|
# create the relocation spec
|
|
relospec = vim.vm.RelocateSpec()
|
|
relospec.host = hostsystem
|
|
relospec.datastore = datastore
|
|
|
|
# Find the associated resourcepool for the host system
|
|
# * FIXME: find resourcepool for clusters too
|
|
resource_pool = None
|
|
resource_pools = get_all_objs(self.content, [vim.ResourcePool])
|
|
for rp in resource_pools.items():
|
|
if rp[0].parent == hostsystem.parent:
|
|
resource_pool = rp[0]
|
|
break
|
|
if resource_pool:
|
|
relospec.pool = resource_pool
|
|
else:
|
|
self.module.fail_json(msg="Failed to find a resource group for %s" \
|
|
% hostsystem.name)
|
|
|
|
clonespec_kwargs = {}
|
|
clonespec_kwargs['location'] = relospec
|
|
|
|
# create disk spec if not default
|
|
if self.params['disk']:
|
|
# grab the template's first disk and modify it for this customization
|
|
disks = [x for x in template.config.hardware.device if isinstance(x, vim.vm.device.VirtualDisk)]
|
|
diskspec = vim.vm.device.VirtualDeviceSpec()
|
|
# set the operation to edit so that it knows to keep other settings
|
|
diskspec.operation = vim.vm.device.VirtualDeviceSpec.Operation.edit
|
|
diskspec.device = disks[0]
|
|
|
|
# get the first disk attributes
|
|
pspec = self.params.get('disk')[0]
|
|
|
|
# is it thin?
|
|
if pspec.get('type', '').lower() == 'thin':
|
|
diskspec.device.backing.thinProvisioned = True
|
|
|
|
# which datastore?
|
|
if pspec.get('datastore'):
|
|
# This is already handled by the relocation spec,
|
|
# but it needs to eventually be handled for all the
|
|
# other disks defined
|
|
pass
|
|
|
|
# what size is it?
|
|
if [x for x in pspec.keys() if x.startswith('size_') or x == 'size']:
|
|
# size_tb, size_gb, size_mb, size_kb, size_b ...?
|
|
if 'size' in pspec:
|
|
# http://stackoverflow.com/a/1451407
|
|
trans = string.maketrans('', '')
|
|
chars = trans.translate(trans, string.digits)
|
|
expected = pspec['size'].translate(trans, chars)
|
|
expected = expected
|
|
unit = pspec['size'].replace(expected, '').lower()
|
|
expected = int(expected)
|
|
else:
|
|
param = [x for x in pspec.keys() if x.startswith('size_')][0]
|
|
unit = param.split('_')[-1].lower()
|
|
expected = [x[1] for x in pspec.items() if x[0].startswith('size_')][0]
|
|
expected = int(expected)
|
|
|
|
kb = None
|
|
if unit == 'tb':
|
|
kb = expected * 1024 * 1024 * 1024
|
|
elif unit == 'gb':
|
|
kb = expected * 1024 * 1024
|
|
elif unit ==' mb':
|
|
kb = expected * 1024
|
|
elif unit == 'kb':
|
|
kb = expected
|
|
else:
|
|
self.module.fail_json(msg='%s is not a supported unit for disk size' % unit)
|
|
diskspec.device.capacityInKB = kb
|
|
|
|
# tell the configspec that the disk device needs to change
|
|
configspec = vim.vm.ConfigSpec(deviceChange=[diskspec])
|
|
clonespec_kwargs['config'] = configspec
|
|
|
|
clonespec = vim.vm.CloneSpec(**clonespec_kwargs)
|
|
task = template.Clone(folder=destfolder, name=self.params['name'], spec=clonespec)
|
|
self.wait_for_task(task)
|
|
|
|
if task.info.state == 'error':
|
|
# https://kb.vmware.com/selfservice/microsites/search.do?language=en_US&cmd=displayKC&externalId=2021361
|
|
# https://kb.vmware.com/selfservice/microsites/search.do?language=en_US&cmd=displayKC&externalId=2173
|
|
return ({'changed': False, 'failed': True, 'msg': task.info.error.msg})
|
|
else:
|
|
|
|
vm = task.info.result
|
|
if wait_for_ip:
|
|
self.set_powerstate(vm, 'poweredon', force=False)
|
|
self.wait_for_vm_ip(vm)
|
|
vm_facts = self.gather_facts(vm)
|
|
return ({'changed': True, 'failed': False, 'instance': vm_facts})
|
|
|
|
|
|
def wait_for_task(self, task):
|
|
# https://www.vmware.com/support/developer/vc-sdk/visdk25pubs/ReferenceGuide/vim.Task.html
|
|
# https://www.vmware.com/support/developer/vc-sdk/visdk25pubs/ReferenceGuide/vim.TaskInfo.html
|
|
# https://github.com/virtdevninja/pyvmomi-community-samples/blob/master/samples/tools/tasks.py
|
|
while task.info.state not in ['success', 'error']:
|
|
time.sleep(1)
|
|
|
|
def wait_for_vm_ip(self, vm, poll=100, sleep=5):
|
|
ips = None
|
|
facts = {}
|
|
thispoll = 0
|
|
while not ips and thispoll <= poll:
|
|
newvm = self.getvm(uuid=vm.config.uuid)
|
|
facts = self.gather_facts(newvm)
|
|
if facts['ipv4'] or facts['ipv6']:
|
|
ips = True
|
|
else:
|
|
time.sleep(sleep)
|
|
thispoll += 1
|
|
|
|
return facts
|
|
|
|
|
|
def fetch_file_from_guest(self, vm, username, password, src, dest):
|
|
|
|
''' Use VMWare's filemanager api to fetch a file over http '''
|
|
|
|
result = {'failed': False}
|
|
|
|
tools_status = vm.guest.toolsStatus
|
|
if (tools_status == 'toolsNotInstalled' or
|
|
tools_status == 'toolsNotRunning'):
|
|
result['failed'] = True
|
|
result['msg'] = "VMwareTools is not installed or is not running in the guest"
|
|
return result
|
|
|
|
# https://github.com/vmware/pyvmomi/blob/master/docs/vim/vm/guest/NamePasswordAuthentication.rst
|
|
creds = vim.vm.guest.NamePasswordAuthentication(
|
|
username=username, password=password
|
|
)
|
|
|
|
# https://github.com/vmware/pyvmomi/blob/master/docs/vim/vm/guest/FileManager/FileTransferInformation.rst
|
|
fti = self.content.guestOperationsManager.fileManager. \
|
|
InitiateFileTransferFromGuest(vm, creds, src)
|
|
|
|
result['size'] = fti.size
|
|
result['url'] = fti.url
|
|
|
|
# Use module_utils to fetch the remote url returned from the api
|
|
rsp, info = fetch_url(self.module, fti.url, use_proxy=False,
|
|
force=True, last_mod_time=None,
|
|
timeout=10, headers=None)
|
|
|
|
# save all of the transfer data
|
|
for k,v in info.iteritems():
|
|
result[k] = v
|
|
|
|
# exit early if xfer failed
|
|
if info['status'] != 200:
|
|
result['failed'] = True
|
|
return result
|
|
|
|
# attempt to read the content and write it
|
|
try:
|
|
with open(dest, 'wb') as f:
|
|
f.write(rsp.read())
|
|
except Exception as e:
|
|
result['failed'] = True
|
|
result['msg'] = str(e)
|
|
|
|
return result
|
|
|
|
|
|
def push_file_to_guest(self, vm, username, password, src, dest, overwrite=True):
|
|
|
|
''' Use VMWare's filemanager api to push a file over http '''
|
|
|
|
result = {'failed': False}
|
|
|
|
tools_status = vm.guest.toolsStatus
|
|
if (tools_status == 'toolsNotInstalled' or
|
|
tools_status == 'toolsNotRunning'):
|
|
result['failed'] = True
|
|
result['msg'] = "VMwareTools is not installed or is not running in the guest"
|
|
return result
|
|
|
|
# https://github.com/vmware/pyvmomi/blob/master/docs/vim/vm/guest/NamePasswordAuthentication.rst
|
|
creds = vim.vm.guest.NamePasswordAuthentication(
|
|
username=username, password=password
|
|
)
|
|
|
|
# the api requires a filesize in bytes
|
|
filesize = None
|
|
fdata = None
|
|
try:
|
|
#filesize = os.path.getsize(src)
|
|
filesize = os.stat(src).st_size
|
|
fdata = None
|
|
with open(src, 'rb') as f:
|
|
fdata = f.read()
|
|
result['local_filesize'] = filesize
|
|
except Exception as e:
|
|
result['failed'] = True
|
|
result['msg'] = "Unable to read src file: %s" % str(e)
|
|
return result
|
|
|
|
# https://www.vmware.com/support/developer/converter-sdk/conv60_apireference/vim.vm.guest.FileManager.html#initiateFileTransferToGuest
|
|
file_attribute = vim.vm.guest.FileManager.FileAttributes()
|
|
url = self.content.guestOperationsManager.fileManager. \
|
|
InitiateFileTransferToGuest(vm, creds, dest, file_attribute,
|
|
filesize, overwrite)
|
|
|
|
# PUT the filedata to the url ...
|
|
rsp, info = fetch_url(self.module, url, method="put", data=fdata,
|
|
use_proxy=False, force=True, last_mod_time=None,
|
|
timeout=10, headers=None)
|
|
|
|
result['msg'] = str(rsp.read())
|
|
|
|
# save all of the transfer data
|
|
for k,v in info.iteritems():
|
|
result[k] = v
|
|
|
|
return result
|
|
|
|
|
|
def run_command_in_guest(self, vm, username, password, program_path, program_args, program_cwd, program_env):
|
|
|
|
result = {'failed': False}
|
|
|
|
tools_status = vm.guest.toolsStatus
|
|
if (tools_status == 'toolsNotInstalled' or
|
|
tools_status == 'toolsNotRunning'):
|
|
result['failed'] = True
|
|
result['msg'] = "VMwareTools is not installed or is not running in the guest"
|
|
return result
|
|
|
|
# https://github.com/vmware/pyvmomi/blob/master/docs/vim/vm/guest/NamePasswordAuthentication.rst
|
|
creds = vim.vm.guest.NamePasswordAuthentication(
|
|
username=username, password=password
|
|
)
|
|
|
|
res = None
|
|
pdata = None
|
|
try:
|
|
# https://github.com/vmware/pyvmomi/blob/master/docs/vim/vm/guest/ProcessManager.rst
|
|
pm = self.content.guestOperationsManager.processManager
|
|
# https://www.vmware.com/support/developer/converter-sdk/conv51_apireference/vim.vm.guest.ProcessManager.ProgramSpec.html
|
|
ps = vim.vm.guest.ProcessManager.ProgramSpec(
|
|
#programPath=program,
|
|
#arguments=args
|
|
programPath=program_path,
|
|
arguments=program_args,
|
|
workingDirectory=program_cwd,
|
|
)
|
|
res = pm.StartProgramInGuest(vm, creds, ps)
|
|
result['pid'] = res
|
|
pdata = pm.ListProcessesInGuest(vm, creds, [res])
|
|
|
|
# wait for pid to finish
|
|
while not pdata[0].endTime:
|
|
time.sleep(1)
|
|
pdata = pm.ListProcessesInGuest(vm, creds, [res])
|
|
result['owner'] = pdata[0].owner
|
|
result['startTime'] = pdata[0].startTime.isoformat()
|
|
result['endTime'] = pdata[0].endTime.isoformat()
|
|
result['exitCode'] = pdata[0].exitCode
|
|
if result['exitCode'] != 0:
|
|
result['failed'] = True
|
|
result['msg'] = "program exited non-zero"
|
|
else:
|
|
result['msg'] = "program completed successfully"
|
|
|
|
except Exception as e:
|
|
result['msg'] = str(e)
|
|
result['failed'] = True
|
|
|
|
return result
|
|
|
|
def get_obj(content, vimtype, name):
|
|
"""
|
|
Return an object by name, if name is None the
|
|
first found object is returned
|
|
"""
|
|
obj = None
|
|
container = content.viewManager.CreateContainerView(
|
|
content.rootFolder, vimtype, True)
|
|
for c in container.view:
|
|
if name:
|
|
if c.name == name:
|
|
obj = c
|
|
break
|
|
else:
|
|
obj = c
|
|
break
|
|
|
|
container.Destroy()
|
|
return obj
|
|
|
|
|
|
def main():
|
|
|
|
vm = None
|
|
|
|
module = AnsibleModule(
|
|
argument_spec=dict(
|
|
hostname=dict(
|
|
type='str',
|
|
default=os.environ.get('VMWARE_HOST')
|
|
),
|
|
username=dict(
|
|
type='str',
|
|
default=os.environ.get('VMWARE_USER')
|
|
),
|
|
password=dict(
|
|
type='str', no_log=True,
|
|
default=os.environ.get('VMWARE_PASSWORD')
|
|
),
|
|
state=dict(
|
|
required=False,
|
|
choices=[
|
|
'poweredon',
|
|
'poweredoff',
|
|
'present',
|
|
'absent',
|
|
'restarted',
|
|
'reconfigured'
|
|
],
|
|
default='present'),
|
|
validate_certs=dict(required=False, type='bool', default=True),
|
|
template_src=dict(required=False, type='str', aliases=['template']),
|
|
name=dict(required=True, type='str'),
|
|
name_match=dict(required=False, type='str', default='first'),
|
|
uuid=dict(required=False, type='str'),
|
|
folder=dict(required=False, type='str', default='/vm', aliases=['folder']),
|
|
disk=dict(required=False, type='list'),
|
|
nic=dict(required=False, type='list'),
|
|
hardware=dict(required=False, type='dict', default={}),
|
|
force=dict(required=False, type='bool', default=False),
|
|
datacenter=dict(required=False, type='str', default=None),
|
|
esxi_hostname=dict(required=False, type='str', default=None),
|
|
wait_for_ip_address=dict(required=False, type='bool', default=True)
|
|
),
|
|
supports_check_mode=True,
|
|
mutually_exclusive=[],
|
|
required_together=[
|
|
['state', 'force'],
|
|
['template'],
|
|
],
|
|
)
|
|
|
|
pyv = PyVmomiHelper(module)
|
|
|
|
# Check if the VM exists before continuing
|
|
vm = pyv.getvm(name=module.params['name'],
|
|
folder=module.params['folder'],
|
|
uuid=module.params['uuid'],
|
|
name_match=module.params['name_match'])
|
|
|
|
# VM already exists
|
|
if vm:
|
|
|
|
if module.params['state'] == 'absent':
|
|
# destroy it
|
|
if module.params['force']:
|
|
# has to be poweredoff first
|
|
result = pyv.set_powerstate(vm, 'poweredoff', module.params['force'])
|
|
result = pyv.remove_vm(vm)
|
|
elif module.params['state'] in ['poweredon', 'poweredoff', 'restarted']:
|
|
# set powerstate
|
|
result = pyv.set_powerstate(vm, module.params['state'], module.params['force'])
|
|
else:
|
|
# Run for facts only
|
|
try:
|
|
module.exit_json(instance=pyv.gather_facts(vm))
|
|
except Exception:
|
|
e = get_exception()
|
|
module.fail_json(
|
|
msg="Fact gather failed with exception %s" % e)
|
|
|
|
# VM doesn't exist
|
|
else:
|
|
create_states = ['poweredon', 'poweredoff', 'present', 'restarted']
|
|
if module.params['state'] in create_states:
|
|
poweron = (module.params['state'] != 'poweredoff')
|
|
# Create it ...
|
|
result = pyv.deploy_template(
|
|
poweron=poweron,
|
|
wait_for_ip=module.params['wait_for_ip_address']
|
|
)
|
|
result['changed'] = True
|
|
elif module.params['state'] == 'absent':
|
|
result = {'changed': False, 'failed': False}
|
|
else:
|
|
result = {'changed': False, 'failed': False}
|
|
|
|
# FIXME
|
|
if not 'failed' in result:
|
|
result['failed'] = False
|
|
|
|
if result['failed']:
|
|
module.fail_json(**result)
|
|
else:
|
|
module.exit_json(**result)
|
|
|
|
|
|
from ansible.module_utils.vmware import *
|
|
from ansible.module_utils.basic import *
|
|
|
|
if __name__ == '__main__':
|
|
main()
|