openstack/deb-python-pyvmomi
Code Issues Proposed changes
Files
15f7be9a526d209fb7f0940cbf6b8e7cc481c0dd
deb-python-pyvmomi/docs/vim/vm/RelocateSpec.rst
Shawn Hartsock 15f7be9a52 pyVmomi reStructured Text Documentation 
This external documentation for pyVmomi was generated using Googly Docs
(aka Google Standard Documentation) which renders very cleanly in
GitHub. Internal documentation for a class should be done in Sphinx
format because tools like pyCharm and Eclipse can use that documentation
as a hint for code completion.

Note: External docs as Googly Docs, internal docs as Sphinx.

Closes bug#15
2014-06-17 14:07:42 -04:00

4.1 KiB
Raw Blame History

vim.vm.RelocateSpec

Specification for moving or copying a virtual machine to a different datastore or host.

extends

vmodl.DynamicData

Attributes:

datastore (vim.Datastore, optional):

The datastore where the virtual machine should be located. If not specified, the current datastore is used.

diskMoveType (str, optional):

Manner in which to move the virtual disk to the target datastore . The set of possible values is described in VirtualMachineRelocateDiskMoveOptions .This property applies to all the disks which the virtual machine has, but can be overridden on a per-disk basis using diskMoveType . This property can only be set if deltaDiskBackingsSupported is true.If left unset then moveAllDiskBackingsAndDisallowSharing is assumed.

pool (vim.ResourcePool, optional):

The resource pool to which this virtual machine should be attached. For a relocate or clone operation to a virtual machine, if the argument is not supplied, the current resource pool of virtual machine is used. For a clone operation to a template, this argument is ignored. For a clone operation from a template to a virtual machine, this argument is required.

host (vim.HostSystem, optional):

The target host for the virtual machine. If not specified,
  • if resource pool is not specified, current host is used.
  • if resource pool is specified, and the target pool represents a stand-alone host, the host is used.
  • if resource pool is specified, and the target pool represents a DRS-enabled cluster, a host selected by DRS is used.
  • if resource pool is specified and the target pool represents a cluster without DRS enabled, an InvalidArgument exception be thrown.

disk (vim.vm.RelocateSpec.DiskLocator, optional):

An optional list that allows specifying the datastore location for each virtual disk.

transform (vim.vm.RelocateSpec.Transformation, optional):

Transformation to perform on the disks. The backend is free to ignore this hint if it is not valid for the current operation. This can be used by clients, for example, to create sparse disks for templates.See VirtualMachineRelocateTransformation

deviceChange (vim.vm.device.VirtualDeviceSpec, optional):

An optional list of virtual device specs that allow specifying the migrate options for the relocate operation. The supported device type is VirtualDisk For VirtualDisk device, VirtualDiskConfigSpec has to be used to specify migrateCache option for disk with vFlash cache.

profile (vim.vm.ProfileSpec, optional):

Storage profile requirement for Virtual Machine's home directory. Profiles are solution specific. Storage Profile Based Management(SPBM) is a vSphere server extension. The API users who want to provision VMs using Storage Profiles, need to interact with SPBM. This is an optional parameter and if user doesn't specify profile, the default behavior will apply.