Scripting Object - VcHostDiskManager

Scripting-object corresponding to
HostDiskManager
Attribute of
VcInternalServiceInstanceContent

Scripting Object Description

The DiskManager managed object provides methods to access the (physical) disk block information associated with a virtual disk.

Attributes

Name Type Description
idString

@since Unknown
morefVcManagedObjectReference

returns the ManagedObjectReference of this ManagedObject @since Unknown
sdkConnectionVcSdkConnection

@since Unknown
sdkIdString

@since Unknown
typeStringDeprecated.

Returns the name for the this managed object's vim type @since Unknown
vimHostVcSdkConnection

@since Unknown
vimIdString

@since Unknown
vimTypeString

@since Unknown

Methods

Methods defined in this Scripting Object
_getRef, acquireLease, acquireLeaseExt, createTrigger, renewAllLeases

_getRef

@since Unknown

Parameters

NameTypeDescription
None

Return Value

Type Description
VcManagedObjectReference

createTrigger

@since Unknown

Parameters

NameTypeDescription
timeoutNumber

filterString

conditionString

filterToSyncString


Return Value

Type Description
Trigger

acquireLease

@since VI API 2.5

Parameters

NameTypeDescription
arg0VcVirtualMachineSnapshot

arg1String


Return Value

Type Description
VcHostDiskManagerLeaseInfo

renewAllLeases

Renew all {@link vim.host.DiskManager.Lease} objects that were obtained in the current Session. If lease objects are not renewed, they will time out and a Lease obtained with {@link vim.host.DiskManager#acquireLeaseExt} or {@link vim.host.DiskManager#acquireLease} will become invalid. The timeout for a lease is specified in the {@link vim.host.DiskManager.LeaseInfo#leaseTimeout} property that is returned by {@link vim.host.DiskManager#acquireLeaseExt} or {@link vim.host.DiskManager#acquireLease}. Even though this property is optional, it will be set in all {@link vim.host.DiskManager.LeaseInfo} structures returned by {@link vim.host.DiskManager#acquireLeaseExt} calls. The {@link vim.host.DiskManager#acquireLease} method might not set this property, but this call is deprecated and hence should not be used anymore. @since VI API 2.5

Parameters

NameTypeDescription
None

Return Value

Type Description
None

acquireLeaseExt

Acquires a lease for the file or files associated with the virtual disk of a virtual machine. This function is to be used on disks belonging to snapshots of the virtual machine. -- In that case, a lease on the entire hierarchy of redo logs and the base disk leading up to this snapshot is returned.

If the virtual machine has a prior snapshot, the disk might be considerably fragmented and the mapping described in {@link vim.host.DiskManager.LeaseInfo#blockInfo} might not span the entire disk. Callers should check the {@link vim.host.DiskBlockInfo#mapLength} property against the size of the virtual disk as returned in {@link vim.host.DiskBlockInfo#size} to see if a complete mapping was returned.

If the call did not return a complete mapping, block mappings for the remainder of the disk can be obtained by calls to {@link vim.host.DiskManager.Lease#MapDiskRegion}. @since VI API 2.5

Parameters

NameTypeDescription
arg0VcVirtualMachineSnapshot

arg1String

arg2Boolean


Return Value

Type Description
VcHostDiskManagerLeaseInfo