Scripting Object - VcVcenterVStorageObjectManager

Scripting-object corresponding to
VcenterVStorageObjectManager

Scripting Object Description

Interface to manage virtual storage object on a vCenter.

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, attachTagToVStorageObject, cloneVStorageObject_Task, createDisk_Task, createTrigger, deleteVStorageObject_Task, detachTagFromVStorageObject, extendDisk_Task, inflateDisk_Task, listTagsAttachedToVStorageObject, listVStorageObject, listVStorageObjectsAttachedToTag, reconcileDatastoreInventory_Task, registerDisk, relocateVStorageObject_Task, renameVStorageObject, retrieveVStorageObject, retrieveVStorageObjectState, scheduleReconcileDatastoreInventory, updateVStorageObjectPolicy_Task

_getRef

@since Unknown

Parameters

NameTypeDescription
None

Return Value

Type Description
VcManagedObjectReference

extendDisk_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. @since vSphere API 6.5

Parameters

NameTypeDescription
arg0VcID

arg1VcDatastore

arg2Number


Return Value

Type Description
VcTask

attachTagToVStorageObject

Attach a tag to a virtual storage object.

Requires privilege InventoryService.Tagging.AttachTag on root folder

@since vSphere API 6.5

Parameters

NameTypeDescription
arg0VcID

arg1String

arg2String


Return Value

Type Description
None

deleteVStorageObject_Task

Delete a virtual storage object and its associated 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

cloneVStorageObject_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

listTagsAttachedToVStorageObject

Lists all tags attached to virtual storage object. @since vSphere API 6.5

Parameters

NameTypeDescription
arg0VcID


Return Value

Type Description
VcVslmTagEntry []

createTrigger

@since Unknown

Parameters

NameTypeDescription
timeoutNumber

filterString

conditionString

filterToSyncString


Return Value

Type Description
Trigger

retrieveVStorageObjectState

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

createDisk_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

registerDisk

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

detachTagFromVStorageObject

Detach a tag from a virtual storage object.

Requires privilege InventoryService.Tagging.AttachTag on root folder

@since vSphere API 6.5

Parameters

NameTypeDescription
arg0VcID

arg1String

arg2String


Return Value

Type Description
None

inflateDisk_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 zeros.

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

renameVStorageObject

Rename a virtual storage object. @since vSphere API 6.5

Parameters

NameTypeDescription
arg0VcID

arg1VcDatastore

arg2String


Return Value

Type Description
None

scheduleReconcileDatastoreInventory

Schedules reconcile of the inventory info of virtual storage objects on one of the hosts that is connected with the datastore. 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

reconcileDatastoreInventory_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

relocateVStorageObject_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

retrieveVStorageObject

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

listVStorageObject

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 []

listVStorageObjectsAttachedToTag

Lists all virtual storage objects attached to the tag. @since vSphere API 6.5

Parameters

NameTypeDescription
arg0String

arg1String


Return Value

Type Description
VcID []

updateVStorageObjectPolicy_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