Scripting Object - VcHostLowLevelProvisioningManager

Scripting-object corresponding to
HostLowLevelProvisioningManager
Attribute of
VcHostInternalConfigManager, VcInternalServiceInstanceContent

Scripting Object Description

This managed object type provides an interface for directly creating and removing virtual machines on a datastore without the virtual machines needing to be part of the inventory.

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, deleteVm_Task, deleteVmExceptDisks_Task, lLPMReconfigVM_Task, lowLevelConsolidateDisks_Task, lowLevelCreateVm_Task, lowLevelDeleteFiles, lowLevelExtractNvramContent_Task, lowLevelPromoteDisks_Task, lowLevelReserveFiles, relayoutSnapshots_Task, reloadDisks_Task, retrieveLastVmMigrationStatus_Task, retrieveVmRecoveryInfo_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

lowLevelReserveFiles

This method reserves files or directories on a datastore to be used for a provisioning operation. This method requires a privilege of Datastore.Filemanagement on the datastore for the directories specified. The API will attempt to make the operation transactional and either reserve all files required or rollback if any of the files cannot be reserved. @since vSphere API 6.0

Parameters

NameTypeDescription
arg0VcHostLowLevelProvisioningManagerFileReserveSpec []


Return Value

Type Description
VcHostLowLevelProvisioningManagerFileReserveResult []

lowLevelPromoteDisks_Task

Promotes disks for the powered on virtual machine. A linked clone will partially share its disk chain with another virtual machine. This API requests that the array of specified disks be unshared. The PromoteDisksSpec allows specifying which virtual disks devices must be unshared, and the filename of the link in the chain from which to promote. If multiple specs are provided and the promotion for one disk fails, a fault will be returned specifying the disk, and no attempt will be made to process the remaining disks. Note that already promoted disks will remain promoted. @since vim unstable version

Parameters

NameTypeDescription
arg0VcVirtualMachine

arg1VcHostLowLevelProvisioningManagerPromoteDisksSpec []


Return Value

Type Description
VcTask

lowLevelConsolidateDisks_Task

Consolidates disks on this virtual machine that have unnecessary delta disk backings.

An unnecessary delta disk backing is one in which the parent is not being shared, and the parent is not part of some snapshot. Consolidating such unneeded delta disk backings improves read performance and uses less disk space. Consolidation merges the parent backing into the child backing of the virtual disk.

It is the work of the caller to find out which backings are unshared and which belong to snapshots and give that information as input so that the backings are consolidated in the right way. Each VirtualDisk can have a list of delta backings on the original disk backing. The input specified here is such that the entire input backing chain given for each disk can be consolidated because the caller has already determined so. This means, if a virtual disk has an intermediate point which cannot be consolidated due to a snapshot, it will be specified twice in the input list, once with the backings upto the point which cannot be consolidated and one for the backings with after that point. For example, if virtual disk "foo" has backings a->b->c->d->e, where c is a snapshot point then there would be 2 instances of "foo" in the input list, one with backings a->b and another with backings c->d->e. The implementor of this method does not know if these backings can be consolidated or not. The only check done is to see that any backing which is asked to be consolidated is not a snapshot point. So if the user specifies input wrongly, it can corrupt virtual disks.

@since vSphere API 4.0

Parameters

NameTypeDescription
arg0VcVirtualMachine

arg1VcVirtualDisk []


Return Value

Type Description
VcTask

retrieveLastVmMigrationStatus_Task

Retrieve the last virtual machine migration status if available. The virtual machine can be either registered or unregistered.

@since vSphere API 5.1

Parameters

NameTypeDescription
arg0String


Return Value

Type Description
VcTask

lowLevelExtractNvramContent_Task

Extracts the NVRAM content from a checkpoint file. This is invoked as part of provisioning operations. This method requires a privilege of Datastore.Filemanagement on the datastore for the files specified. @since vSphere API 5.1

Parameters

NameTypeDescription
arg0String

arg1String

arg2String


Return Value

Type Description
VcTask

deleteVmExceptDisks_Task

Deletes a virtual machine from its storage, all virtual machine files are deleted except its associated virtual disks. This can be used to delete an unregistered virtual machine. When invoked on registered FT virtual machine (primary or secondary), a NotSupported fault is thrown. When invoked on unregistered FT primary virtual machine, both primary and secondary virtual machines are deleted. Invoking the API on unregistered FT secondary virtual machine will delete the secondary after detaching it from it's primary.

@since vSphere API 5.1

Parameters

NameTypeDescription
arg0String


Return Value

Type Description
VcTask

retrieveVmRecoveryInfo_Task

Retrieve virtual machine information for recovery. The virtual machine can be either registered or unregistered.

@since vSphere API 5.1

Parameters

NameTypeDescription
arg0String


Return Value

Type Description
VcTask

relayoutSnapshots_Task

Updates the snapshot layout information of a virtual machine and reloads its snapshots.

When the snapshot files and delta disks of a virtual machine are moved from one datastore to another, the paths of files and disks referenced in the snapshot files may no longer be valid. This method allows caller to update the file layouts of snapshots on a given virtual machine and reload the snapshot related information, including snapshot configs and file layouts. The method requires a privilege of Datastore.Filemanagement on the datastore for the destination files specified.

@since vSphere API 5.0

Parameters

NameTypeDescription
arg0String

arg1VcHostLowLevelProvisioningManagerSnapshotLayoutSpec []


Return Value

Type Description
VcTask

lowLevelDeleteFiles

This method removes a given list of file from a datastore. This is invoked as part of provisioning operations. This method requires a privilege of Datastore.Filemanagement on the datastore for the files specified. This API will not be transactional and will be a best-effort to delete the files in the list provided. @since vSphere API 6.0

Parameters

NameTypeDescription
arg0VcHostLowLevelProvisioningManagerFileDeleteSpec []


Return Value

Type Description
VcHostLowLevelProvisioningManagerFileDeleteResult []

deleteVm_Task

Deletes a virtual machine on disk. This can be used to delete an unregistered virtual machine.

The typical approach to deleting a virtual machine is through VirtualMachine.destroy.

@since VI API 2.5

Parameters

NameTypeDescription
arg0VcVirtualMachineConfigInfo


Return Value

Type Description
VcTask

lLPMReconfigVM_Task

Reconfigures a virtual machine. This can be used to destroy entire chain of disks.

The typical approach to reconfigure a virtual machine is through VirtualMachine.Reconfig. However, VirtualMachine.Reconfig would not destroy parent disks in a virtual disk chain because the parent disks could be shared by other virtual machines in a data center.

This method allows caller to specify links in a virtual disk chains to be destroyed. For example, if a virtual disk is composed of the following links Z<-Y<-X, where Z is parent of Y, and Y is parent of X, by specifying the chain {X, Y, Z} in the virtual disk backing with file operation "destroy" would delete disk links X, Y and Z.

If the disk links that are specified in the virtual disk backing belongs to a snapshot of the virtual machine, the link will not be destroyed, however, it would be unmarked as a readonly link.

Currently this method only supports destroy disk operation. All other reconfiguration specification would be ignored. @since vSphere API 4.0

Parameters

NameTypeDescription
arg0VcVirtualMachineConfigSpec


Return Value

Type Description
VcTask

reloadDisks_Task

Updates any information in the {@link VirtualMachine#config ConfigInfo} regarding virtual disks.

This is useful because disk information can get stale, even under "normal" operation in cases where two VMs were sharing some disks. So VC needs to actively refresh its disk information before doing provisioning operations.

This is preferable to {@link vim.ManagedEntity#reload} because this does not reload the entire VM and thus is lighter weight.

This does not reload information which is not in the {@link VirtualMachine#config ConfigInfo}, such as the {@link VirtualMachine#layout FileLayout}. @since vSphere API 4.0

Parameters

NameTypeDescription
arg0VcVirtualMachine

arg1String []


Return Value

Type Description
VcTask

lowLevelCreateVm_Task

Creates a new virtual machine from scratch on disk without registering it on the host. Makes the virtual machine part of the inventory.

The typical approach to creating a virtual machine is through the the createVM() method in the {@link vim.Folder Folder} managed object type.

This operation is supported only if connected directly to ESX Server or VMware Server hosts.

Note: In the configSpec, specify the datastore where the virtual machine is stored.

@since VI API 2.5

Parameters

NameTypeDescription
arg0VcVirtualMachineConfigSpec


Return Value

Type Description
VcTask