def _create_filter(self, property_names=[],
from_node=None, obj_type='ManagedEntity', partial_updates=True):
"""Creates filter with given parameters and returns its MOR"""
try:
if not from_node:
from_node = self._do_service_content.RootFolder
elif isinstance(from_node, tuple) and len(from_node) == 2:
from_node = VIMor(from_node[0], from_node[1])
elif not VIMor.is_mor(from_node):
raise VIException("from_node must be a MOR object or a "
"(<str> mor_id, <str> mor_type) tuple",
FaultTypes.PARAMETER_ERROR)
request = VI.CreateFilterRequestMsg()
_this = request.new__this(self._do_service_content.PropertyCollector)
_this.set_attribute_type(MORTypes.PropertyCollector)
request.set_element__this(_this)
request.set_element_partialUpdates(partial_updates)
spec = request.new_spec()
propSet = spec.new_propSet()
propSet.set_element_type(obj_type)
propSet.set_element_pathSet(property_names)
spec.set_element_propSet([propSet])
objects_set = self._get_traversal_objects_set(spec, from_node)
spec.set_element_objectSet(objects_set)
request.set_element_spec(spec)
mor = self._proxy.CreateFilter(request)._returnval
return mor
except (VI.ZSI.FaultException), e:
raise VIApiException(e)
def register_vm(self, path, name=None, sync_run=True, folder=None,
template=False, resourcepool=None, host=None):
"""Adds an existing virtual machine to the folder.
@path: a datastore path to the virtual machine.
Example "[datastore] path/to/machine.vmx".
@name: the name to be assigned to the virtual machine.
If this parameter is not set, the displayName configuration
parameter of the virtual machine is used.
@sync_run: if True (default) waits for the task to finish, and returns
a VIVirtualMachine instance with the new VM (raises an exception if
the task didn't succeed). If @sync_run is set to False the task is
started and a VITask instance is returned
@folder_name: folder in which to register the virtual machine.
@template: Flag to specify whether or not the virtual machine
should be marked as a template.
@resourcepool: MOR of the resource pool to which the virtual machine should
be attached. If imported as a template, this parameter is not set.
@host: The target host on which the virtual machine will run. This
parameter must specify a host that is a member of the ComputeResource
indirectly specified by the pool. For a stand-alone host or a cluster
with DRS, the parameter can be omitted, and the system selects a default.
"""
if not folder:
folders = self._get_managed_objects(MORTypes.Folder)
folder = [_mor for _mor, _name in folders.iteritems()
if _name == 'vm'][0]
try:
request = VI.RegisterVM_TaskRequestMsg()
_this = request.new__this(folder)
_this.set_attribute_type(folder.get_attribute_type())
request.set_element__this(_this)
request.set_element_path(path)
if name:
request.set_element_name(name)
request.set_element_asTemplate(template)
if resourcepool:
pool = request.new_pool(resourcepool)
pool.set_attribute_type(resourcepool.get_attribute_type())
request.set_element_pool(pool)
if host:
if not VIMor.is_mor(host):
host = VIMor(host, MORTypes.HostSystem)
hs = request.new_host(host)
hs.set_attribute_type(host.get_attribute_type())
request.set_element_host(hs)
task = self._proxy.RegisterVM_Task(request)._returnval
vi_task = VITask(task, self)
if sync_run:
status = vi_task.wait_for_state([vi_task.STATE_SUCCESS,
vi_task.STATE_ERROR])
if status == vi_task.STATE_ERROR:
raise VITaskException(vi_task.info.error)
return
return vi_task
except (VI.ZSI.FaultException), e:
raise VIApiException(e)
def _retrieve_properties_traversal(self, property_names=[],
from_node=None, obj_type='ManagedEntity'):
"""Uses VI API's property collector to retrieve the properties defined
in @property_names of Managed Objects of type @obj_type ('ManagedEntity'
by default). Starts the search from the managed object reference
@from_node (RootFolder by default). Returns the corresponding
objectContent data object."""
try:
if not from_node:
from_node = self._do_service_content.RootFolder
elif isinstance(from_node, tuple) and len(from_node) == 2:
from_node = VIMor(from_node[0], from_node[1])
elif not VIMor.is_mor(from_node):
raise VIException("from_node must be a MOR object or a "
"(<str> mor_id, <str> mor_type) tuple",
FaultTypes.PARAMETER_ERROR)
request, request_call = self._retrieve_property_request()
_this = request.new__this(
self._do_service_content.PropertyCollector)
_this.set_attribute_type(MORTypes.PropertyCollector)
request.set_element__this(_this)
do_PropertyFilterSpec_specSet = request.new_specSet()
props_set = []
do_PropertySpec_propSet = do_PropertyFilterSpec_specSet.new_propSet()
do_PropertySpec_propSet.set_element_type(obj_type)
do_PropertySpec_propSet.set_element_pathSet(property_names)
props_set.append(do_PropertySpec_propSet)
objects_set = self._get_traversal_objects_set(do_PropertyFilterSpec_specSet, from_node)
do_PropertyFilterSpec_specSet.set_element_propSet(props_set)
do_PropertyFilterSpec_specSet.set_element_objectSet(objects_set)
request.set_element_specSet([do_PropertyFilterSpec_specSet])
return request_call(request)
except (VI.ZSI.FaultException), e:
raise VIApiException(e)
def _retrieve_properties_traversal(self,
property_names=[],
from_node=None,
obj_type='ManagedEntity'):
"""Uses VI API's property collector to retrieve the properties defined
in @property_names of Managed Objects of type @obj_type ('ManagedEntity'
by default). Starts the search from the managed object reference
@from_node (RootFolder by default). Returns the corresponding
objectContent data object."""
try:
if not from_node:
from_node = self._do_service_content.RootFolder
elif isinstance(from_node, tuple) and len(from_node) == 2:
from_node = VIMor(from_node[0], from_node[1])
elif not VIMor.is_mor(from_node):
raise VIException(
"from_node must be a MOR object or a "
"(<str> mor_id, <str> mor_type) tuple",
FaultTypes.PARAMETER_ERROR)
request, request_call = self._retrieve_property_request()
_this = request.new__this(
self._do_service_content.PropertyCollector)
_this.set_attribute_type(MORTypes.PropertyCollector)
request.set_element__this(_this)
do_PropertyFilterSpec_specSet = request.new_specSet()
props_set = []
do_PropertySpec_propSet = do_PropertyFilterSpec_specSet.new_propSet(
)
do_PropertySpec_propSet.set_element_type(obj_type)
do_PropertySpec_propSet.set_element_pathSet(property_names)
props_set.append(do_PropertySpec_propSet)
objects_set = []
do_ObjectSpec_objSet = do_PropertyFilterSpec_specSet.new_objectSet(
)
mor_obj = do_ObjectSpec_objSet.new_obj(from_node)
mor_obj.set_attribute_type(from_node.get_attribute_type())
do_ObjectSpec_objSet.set_element_obj(mor_obj)
do_ObjectSpec_objSet.set_element_skip(False)
#Recurse through all ResourcePools
rp_to_rp = VI.ns0.TraversalSpec_Def('rpToRp').pyclass()
rp_to_rp.set_element_name('rpToRp')
rp_to_rp.set_element_type(MORTypes.ResourcePool)
rp_to_rp.set_element_path('resourcePool')
rp_to_rp.set_element_skip(False)
rp_to_vm = VI.ns0.TraversalSpec_Def('rpToVm').pyclass()
rp_to_vm.set_element_name('rpToVm')
rp_to_vm.set_element_type(MORTypes.ResourcePool)
rp_to_vm.set_element_path('vm')
rp_to_vm.set_element_skip(False)
spec_array_resource_pool = [
do_ObjectSpec_objSet.new_selectSet(),
do_ObjectSpec_objSet.new_selectSet()
]
spec_array_resource_pool[0].set_element_name('rpToRp')
spec_array_resource_pool[1].set_element_name('rpToVm')
rp_to_rp.set_element_selectSet(spec_array_resource_pool)
#Traversal through resource pool branch
cr_to_rp = VI.ns0.TraversalSpec_Def('crToRp').pyclass()
cr_to_rp.set_element_name('crToRp')
cr_to_rp.set_element_type(MORTypes.ComputeResource)
cr_to_rp.set_element_path('resourcePool')
cr_to_rp.set_element_skip(False)
spec_array_computer_resource = [
do_ObjectSpec_objSet.new_selectSet(),
do_ObjectSpec_objSet.new_selectSet()
]
spec_array_computer_resource[0].set_element_name('rpToRp')
spec_array_computer_resource[1].set_element_name('rpToVm')
cr_to_rp.set_element_selectSet(spec_array_computer_resource)
#Traversal through host branch
cr_to_h = VI.ns0.TraversalSpec_Def('crToH').pyclass()
cr_to_h.set_element_name('crToH')
cr_to_h.set_element_type(MORTypes.ComputeResource)
cr_to_h.set_element_path('host')
cr_to_h.set_element_skip(False)
#Traversal through hostFolder branch
dc_to_hf = VI.ns0.TraversalSpec_Def('dcToHf').pyclass()
dc_to_hf.set_element_name('dcToHf')
dc_to_hf.set_element_type(MORTypes.Datacenter)
dc_to_hf.set_element_path('hostFolder')
dc_to_hf.set_element_skip(False)
spec_array_datacenter_host = [do_ObjectSpec_objSet.new_selectSet()]
spec_array_datacenter_host[0].set_element_name('visitFolders')
dc_to_hf.set_element_selectSet(spec_array_datacenter_host)
#Traversal through vmFolder branch
dc_to_vmf = VI.ns0.TraversalSpec_Def('dcToVmf').pyclass()
dc_to_vmf.set_element_name('dcToVmf')
dc_to_vmf.set_element_type(MORTypes.Datacenter)
dc_to_vmf.set_element_path('vmFolder')
dc_to_vmf.set_element_skip(False)
spec_array_datacenter_vm = [do_ObjectSpec_objSet.new_selectSet()]
spec_array_datacenter_vm[0].set_element_name('visitFolders')
dc_to_vmf.set_element_selectSet(spec_array_datacenter_vm)
#Traversal through datastore branch
dc_to_ds = VI.ns0.TraversalSpec_Def('dcToDs').pyclass()
dc_to_ds.set_element_name('dcToDs')
dc_to_ds.set_element_type(MORTypes.Datacenter)
dc_to_ds.set_element_path('datastore')
dc_to_ds.set_element_skip(False)
spec_array_datacenter_ds = [do_ObjectSpec_objSet.new_selectSet()]
spec_array_datacenter_ds[0].set_element_name('visitFolders')
dc_to_ds.set_element_selectSet(spec_array_datacenter_ds)
#Recurse through all hosts
h_to_vm = VI.ns0.TraversalSpec_Def('hToVm').pyclass()
h_to_vm.set_element_name('hToVm')
h_to_vm.set_element_type(MORTypes.HostSystem)
h_to_vm.set_element_path('vm')
h_to_vm.set_element_skip(False)
spec_array_host_vm = [do_ObjectSpec_objSet.new_selectSet()]
spec_array_host_vm[0].set_element_name('visitFolders')
h_to_vm.set_element_selectSet(spec_array_host_vm)
#Recurse through all datastores
ds_to_vm = VI.ns0.TraversalSpec_Def('dsToVm').pyclass()
ds_to_vm.set_element_name('dsToVm')
ds_to_vm.set_element_type(MORTypes.Datastore)
ds_to_vm.set_element_path('vm')
ds_to_vm.set_element_skip(False)
spec_array_datastore_vm = [do_ObjectSpec_objSet.new_selectSet()]
spec_array_datastore_vm[0].set_element_name('visitFolders')
ds_to_vm.set_element_selectSet(spec_array_datastore_vm)
#Recurse through the folders
visit_folders = VI.ns0.TraversalSpec_Def('visitFolders').pyclass()
visit_folders.set_element_name('visitFolders')
visit_folders.set_element_type(MORTypes.Folder)
visit_folders.set_element_path('childEntity')
visit_folders.set_element_skip(False)
spec_array_visit_folders = [
do_ObjectSpec_objSet.new_selectSet(),
do_ObjectSpec_objSet.new_selectSet(),
do_ObjectSpec_objSet.new_selectSet(),
do_ObjectSpec_objSet.new_selectSet(),
do_ObjectSpec_objSet.new_selectSet(),
do_ObjectSpec_objSet.new_selectSet(),
do_ObjectSpec_objSet.new_selectSet(),
do_ObjectSpec_objSet.new_selectSet(),
do_ObjectSpec_objSet.new_selectSet()
]
spec_array_visit_folders[0].set_element_name('visitFolders')
spec_array_visit_folders[1].set_element_name('dcToHf')
spec_array_visit_folders[2].set_element_name('dcToVmf')
spec_array_visit_folders[3].set_element_name('crToH')
spec_array_visit_folders[4].set_element_name('crToRp')
spec_array_visit_folders[5].set_element_name('dcToDs')
spec_array_visit_folders[6].set_element_name('hToVm')
spec_array_visit_folders[7].set_element_name('dsToVm')
spec_array_visit_folders[8].set_element_name('rpToVm')
visit_folders.set_element_selectSet(spec_array_visit_folders)
#Add all of them here
spec_array = [
visit_folders, dc_to_vmf, dc_to_ds, dc_to_hf, cr_to_h,
cr_to_rp, rp_to_rp, h_to_vm, ds_to_vm, rp_to_vm
]
do_ObjectSpec_objSet.set_element_selectSet(spec_array)
objects_set.append(do_ObjectSpec_objSet)
do_PropertyFilterSpec_specSet.set_element_propSet(props_set)
do_PropertyFilterSpec_specSet.set_element_objectSet(objects_set)
request.set_element_specSet([do_PropertyFilterSpec_specSet])
return request_call(request)
except (VI.ZSI.FaultException), e:
raise VIApiException(e)