Scripting Object - VcCbrcManager

Scripting-object corresponding to
CbrcManager
Attribute of
VcInternalServiceInstanceContent

Scripting Object Description

CbrcManager is an interface to configure and manage virtual disk digests which are used for content based read caching.

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, configureDigest_Task, createTrigger, queryDigestInfo, queryDigestRuntimeStatus, recomputeDigest_Task

_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

queryDigestInfo

Returns the current configuration of digest for the given digest enabled virtual disks. This information is only available when the virtual machines are powered off.

This is a batch operation that takes as input multiple virtual disks and retrives the digest information for each disk independently. Faults encountered with individual operations are captured in the result object that is returned.

Faults that can be returned in the result object include:

@since vSphere API 5.0

Parameters

NameTypeDescription
arg0VcCbrcDeviceSpec []


Return Value

Type Description
VcCbrcDigestInfoResult []

configureDigest_Task

Controls the configuration of digests for virtual disks.

This is a batch operation that takes as input multiple virtual disks and applies the given setting on each disk independently. Faults encountered with individual operations are captured in the result object that is returned.

When enabled is set to true, a file containing content digest information is created for each disk unit of a virtual disk. When set to false, digest files are deleted for all disk units that do not have digest enabled in the context of any other virtual machine.

disableFullChain is valid only if enabled is set to false. When disableFullChain is set to true, digest files are deleted for full chain of disks. In this case digest configuration for any other VMs sharing disks from the chain will not change. However, CBRC might not be enabled when these VMs are powered on since digest files for some disk backings may be missing. When set to false or unset, digest is deleted only for the current running point in the disk chain.

Currently, only disks with {@link vim.vm.device.VirtualDisk.FlatVer2BackingInfo} and {@link vim.vm.device.VirtualDisk.SeSparseBackingInfo} backings are supported.

Faults that can be returned in the result object include:

@since vSphere API 5.0

Parameters

NameTypeDescription
arg0VcCbrcDeviceSpec []

arg1Boolean

arg2Boolean

arg3Boolean


Return Value

Type Description
VcTask

recomputeDigest_Task

Recomputes the digest if necessary for the given virtual disks.

This is a batch operation that takes as input multiple virtual disks and recomputes the digest for each disk independently. Faults encountered with individual operations are captured in the result object that is returned.

When fullRecompute is set to true, recomputes the digest for full disk. When set to false, recomputation is done only for invalid blocks.

Faults that can be returned in the result object include:

@since vSphere API 5.0

Parameters

NameTypeDescription
arg0VcCbrcDeviceSpec []

arg1Boolean


Return Value

Type Description
VcTask

queryDigestRuntimeStatus

Returns the status of runtime digest usage for the given digest enabled virtual disks. This information is only available for powered on virtual machines.

This is a batch operation that takes as input multiple virtual disks and retrives the runtime digest information for each disk independently. Faults encountered with individual operations are captured in the result object that is returned.

Faults that can be returned in the result object include:

@since vSphere API 5.0

Parameters

NameTypeDescription
arg0VcCbrcDeviceSpec []


Return Value

Type Description
VcCbrcDigestRuntimeInfoResult []