Scripting Object - VcVirtualDiskConfigSpec


Scripting Object Description

The VirtualDiskSpec data object type encapsulates change specifications for an individual virtual disk device. The virtual disk being added or modified must be fully specified.

Attributes

Name Type Description
backingVcVirtualDeviceConfigSpecBackingSpec

BackingInfo configuration options. Each BackingSpec corresponds to a BackingInfo object. The member {@link #backing} refers to the {@link #device}.{@link vim.vm.device.VirtualDevice#backing}. @since vSphere API 6.5
deviceVcVirtualDevice

Device specification, with all necessary properties set. @since VI API 2.5
diskMoveTypeString

Manner in which to move the virtual disk to the target datastore. The set of possible values is described in {@link vim.vm.RelocateSpec.DiskMoveOptions}.

This property can only be set if {@link vim.host.Capability#deltaDiskBackingsSupported} is true.

If left unset then {@link vim.vm.RelocateSpec.DiskMoveOptions#moveAllDiskBackingsAndDisallowSharing} is assumed. @since vSphere API 6.0

dynamicPropertyVcDynamicProperty []

@since Unknown
dynamicTypeString

@since Unknown
fileOperationVcVirtualDeviceConfigSpecFileOperation

Type of operation being performed on the backing of the specified virtual device. If no file operation is specified in the VirtualDeviceSpec, then any backing filenames in the {@link vim.vm.device.VirtualDevice VirtualDevice} must refer to files that already exist. The "replace" and "delete" values for this property are only applicable to virtual disk backing files. @since VI API 2.5
migrateCacheBoolean

Manner in which to transfer the cache associated with the virtual disk to the target host. If left unset then migrate is used when virtual flash resource on the source host is accessible and when the backing vFlash module version is compatible with the specific vFalsh module on the target host; otherwise flush is used for write back cache, or a no-op for write through cache. This setting can avoid VM migration failure due to incompatibility. If true then migrate is always used. VM migration may fail if the backing vFlash module version is incompatible with the module on the target host. If false then flush is used for write back cache. It is a no-op for write through cache. This setting can avoid VM migration failure due to incompatibility, but cache files have to be rebuilt on the target host. Default is unset.

@since vSphere API 5.5

operationVcVirtualDeviceConfigSpecOperation

Type of operation being performed on the specified virtual device. If no operation is specified, the spec. is ignored. @since VI API 2.5
profileVcVirtualMachineProfileSpec []

Virtual Device Profile requirement. Profiles are solution specifics. 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 service. This is an optional parameter and if user doesn't specify profile, the default behavior will apply. @since vSphere API 5.5

Methods

Methods defined in this Scripting Object
isMigrateCache

isMigrateCache

Manner in which to transfer the cache associated with the virtual disk to the target host. If left unset then migrate is used when virtual flash resource on the source host is accessible and when the backing vFlash module version is compatible with the specific vFalsh module on the target host; otherwise flush is used for write back cache, or a no-op for write through cache. This setting can avoid VM migration failure due to incompatibility. If true then migrate is always used. VM migration may fail if the backing vFlash module version is incompatible with the module on the target host. If false then flush is used for write back cache. It is a no-op for write through cache. This setting can avoid VM migration failure due to incompatibility, but cache files have to be rebuilt on the target host. Default is unset.

@since vSphere API 5.5

Parameters

NameTypeDescription
None

Return Value

Type Description
Boolean