Scripting Object - VcHostVStorageObjectManager

Scripting-object corresponding to
HostVStorageObjectManager

Scripting Object Description

Interface to manage virtual storage object on an ESXi host.

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, hostCloneVStorageObject_Task, hostCreateDisk_Task, hostDeleteVStorageObject_Task, hostExtendDisk_Task, hostInflateDisk_Task, hostListVStorageObject, hostReconcileDatastoreInventory_Task, hostRegisterDisk, hostRelocateVStorageObject_Task, hostRenameVStorageObject, hostRetrieveVStorageObject, hostRetrieveVStorageObjectState, hostScheduleReconcileDatastoreInventory, hostUpdateVStorageObjectPolicy_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

hostRetrieveVStorageObjectState

Retrieve a virtual storage object state.

Requires Datastore.FileManagement privilege on the datastore where the virtual storage object is located.

@since vSphere API 6.5

Parameters

NameTypeDescription
arg0VcID

arg1VcDatastore


Return Value

Type Description
VcVStorageObjectStateInfo

hostExtendDisk_Task

Expand the capacity of a virtual disk, which is a storage object with {@link vim.vslm.VStorageObject.ConsumptionType#disk}, to the new capacity. The extended disk region will be the same as the original disk: - For a zerothick disk, the extended disk region will be zeroedthick. - For an eagerzerothick disk, the extended disk region will be eagerzeroedthick - A thin-provisioned disk will always be extended as a thin-provisioned disk.

Requires Datastore.FileManagement privilege on the datastore where the virtual storage object is located.

@since vSphere API 6.5

Parameters

NameTypeDescription
arg0VcID

arg1VcDatastore

arg2Number


Return Value

Type Description
VcTask

hostCreateDisk_Task

Create a virtual disk, which is a storage object with {@link vim.vslm.VStorageObject.ConsumptionType#disk} as consumption type.

Requires Datastore.FileManagement privilege on the datastore where the virtual disk object is created.

@since vSphere API 6.5

Parameters

NameTypeDescription
arg0VcVslmCreateSpec


Return Value

Type Description
VcTask

hostRegisterDisk

Promote a virtual disk to a First Class Disk.

Requires Datastore.FileManagement privilege on the datastore where the virtual disk resides.

@since vSphere API 6.5

Parameters

NameTypeDescription
arg0String

arg1String


Return Value

Type Description
VcVStorageObject

hostInflateDisk_Task

Inflate a sparse or thin-provisioned virtual disk up to the full size. Additional space allocated to the disk as a result of this operation will be filled with zeroes.

Requires Datastore.FileManagement privilege on the datastore where the virtual storage object is located.

@since vSphere API 6.5

Parameters

NameTypeDescription
arg0VcID

arg1VcDatastore


Return Value

Type Description
VcTask

hostDeleteVStorageObject_Task

Delete a virtual storage object and its assoicated backings.

Requires Datastore.FileManagement privilege on the datastore where the virtual storage object is located.

@since vSphere API 6.5

Parameters

NameTypeDescription
arg0VcID

arg1VcDatastore


Return Value

Type Description
VcTask

hostRenameVStorageObject

Rename a virtual storage object.

Requires Datastore.FileManagement privilege on the datastore where the virtual storage object is located.

@since vSphere API 6.5

Parameters

NameTypeDescription
arg0VcID

arg1VcDatastore

arg2String


Return Value

Type Description
None

hostScheduleReconcileDatastoreInventory

Schedules reconcile of the datastore inventory info of virtual storage objects. This method just schedules the reconcile operation for the nearby future and returns. Note that since the reconcile operation will be executed after this method already returns the success of this method should not be considered as success of the actual reconcile operation.

Requires Datastore.FileManagement privilege.

@since vSphere API 6.5

Parameters

NameTypeDescription
arg0VcDatastore


Return Value

Type Description
None

hostReconcileDatastoreInventory_Task

Reconcile the datastore inventory info of virtual storage objects.

Requires Datastore.FileManagement privilege.

@since vSphere API 6.5

Parameters

NameTypeDescription
arg0VcDatastore


Return Value

Type Description
VcTask

hostRelocateVStorageObject_Task

Relocate a virtual storage object.

Requires Datastore.FileManagement privilege on both source and destination datastore.

@since vSphere API 6.5

Parameters

NameTypeDescription
arg0VcID

arg1VcDatastore

arg2VcVslmRelocateSpec


Return Value

Type Description
VcTask

hostRetrieveVStorageObject

Retrieve a virtual storage object.

Requires Datastore.FileManagement privilege on the datastore where the virtual storage object is located.

@since vSphere API 6.5

Parameters

NameTypeDescription
arg0VcID

arg1VcDatastore


Return Value

Type Description
VcVStorageObject

hostListVStorageObject

List all virtual storage objects located on a datastore.

Requires Datastore.FileManagement privilege on the datastore where the virtual storage object is located.

@since vSphere API 6.5

Parameters

NameTypeDescription
arg0VcDatastore


Return Value

Type Description
VcID []

hostCloneVStorageObject_Task

Clone a virtual storage object.

Requires Datastore.FileManagement privilege on both source and destination datastore.

@since vSphere API 6.5

Parameters

NameTypeDescription
arg0VcID

arg1VcDatastore

arg2VcVslmCloneSpec


Return Value

Type Description
VcTask

hostUpdateVStorageObjectPolicy_Task

Update the storage policy on a virtual storage object.

Requires Datastore.FileManagement privilege on the datastore where the virtual storage object is located.

@since vim unstable version

Parameters

NameTypeDescription
arg0VcID

arg1VcDatastore

arg2VcVirtualMachineProfileSpec []


Return Value

Type Description
VcTask