Scripting Object - VcHostDiskManagerLease

Scripting-object corresponding to
HostDiskManagerLease
Attribute of
VcHostDiskManagerLeaseInfo

Scripting Object Description

The DiskManager.Lease managed objects provide access to a per-session lease object on the disk blocks associated with a virtual disk.

It also provides clients with a way to have their ESX/VC peer allocate previously unallocated blocks or to turn off the lazy zero bit of certain blocks that they have written to.

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, createTrigger, leaseAllocateBlocks, leaseClearLazyZero, leaseMapDiskRegion, releaseLease, renewLease

_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

leaseMapDiskRegion

This function maps a specified region of a virtual disk. If the region to be mapped is broken up in too many extents, this function might return only a mapping for a portion of the area that a mapping was requested for. (Callers should check the {@link vim.host.DiskBlockInfo#mapLength} property in the structure returned.)

It is guaranteed that the {@link vim.host.DiskBlockInfo#mapStart} property will always match the corresponding mapStart argument. (i.e: the area for which a map is returned might be truncated, but will always start at mapStart). @since VI API 2.5

Parameters

NameTypeDescription
arg0Number

arg1Number


Return Value

Type Description
VcHostDiskBlockInfo

renewLease

Renews a lease to prevent it from timing out. - For efficiency reasons it is recommended that clients use {@link vim.host.DiskManager#renewAllLeases} instead of calling RenewLease on every outstanding lease. @since VI API 2.5

Parameters

NameTypeDescription
None

Return Value

Type Description
None

leaseAllocateBlocks

Prepare for writing to blocks that are either not present (i.e: not mentioned in this Lease's {@link vim.host.DiskBlockInfo DiskBlockInfo} data structure) or that are part of an extent that is read only.

Check {@link vim.host.DiskBlockInfo.Extent DiskBlockInfo.Extent} for more information. @since VI API 2.5

Parameters

NameTypeDescription
arg0Number

arg1Number

arg2Boolean


Return Value

Type Description
VcHostDiskBlockInfo

leaseClearLazyZero

Ask the server to honor the contents of a block range by turning off the "lazyZero" bit on all the blocks with in the range. This call will only turn off the lazyZero flag for blocks within the specified range that have both their readOnly and their lazyZero flag set to false.

Check {@link vim.host.DiskBlockInfo.Extent} for more information. @since VI API 2.5

Parameters

NameTypeDescription
arg0Number

arg1Number

arg2Boolean


Return Value

Type Description
None

releaseLease

Terminates the lease if it is still active. Because leases are per-session, a lease automatically terminates when a session ends (either by logout or session expiration). Clients should call this method unless they are about to call SessionManager.logout. @since VI API 2.5

Parameters

NameTypeDescription
None

Return Value

Type Description
None