Managed Object - VcenterVStorageObjectManager(vim.vslm.vcenter.VStorageObjectManager)

Extends
VStorageObjectManagerBase
See also
Datastore, ID, VslmCloneSpec, VslmCreateSpec, VslmRelocateSpec, VslmTagEntry, VStorageObject, VStorageObjectStateInfo
Since
vSphere API 6.5


Managed Object Description

Interface to manage virtual storage object on a vCenter.

Properties

Name Type Description
None
Properties inherited from VStorageObjectManagerBase
None

Methods

Methods defined in this Managed Object
AttachTagToVStorageObject, CloneVStorageObject_Task, CreateDisk_Task, DeleteVStorageObject_Task, DetachTagFromVStorageObject, ExtendDisk_Task, InflateDisk_Task, ListTagsAttachedToVStorageObject, ListVStorageObject, ListVStorageObjectsAttachedToTag, ReconcileDatastoreInventory_Task, RegisterDisk, RelocateVStorageObject_Task, RenameVStorageObject, RetrieveVStorageObject, RetrieveVStorageObjectState, ScheduleReconcileDatastoreInventory
Methods inherited from VStorageObjectManagerBase
None

AttachTagToVStorageObject(attachTagToVStorageObject)

Attach a tag to a virtual storage object.

Requires privilege InventoryService.Tagging.AttachTag on root folder

Required Privileges
System.Read

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VcenterVStorageObjectManager used to make the method call.
idID

The identifier(ID) of the virtual storage object.
categoryxsd:string

The category to which the tag belongs.
tagxsd:string

The tag which has to be associated with the virtual storage object.

Return Value

Type Description
None

Faults

Type Description
NotFoundThrown if the specified category or tag cannot be found.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition



CloneVStorageObject_Task(cloneVStorageObject)

Clone a virtual storage object.

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

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VcenterVStorageObjectManager used to make the method call.
idID

The ID of the virtual storage object.
datastoreManagedObjectReference
to a Datastore

The datastore where the source virtual storage object is located.
specVslmCloneSpec

The specification for cloning the virtual storage object.

Return Value

Type Description
ManagedObjectReference
to a Task

Faults

Type Description
FileFaultThrown if an error occurs while cloning the virtual storage object.
InvalidDatastoreThrown if the operation cannot be performed on the datastore.
NotFoundThrown if specified virtual storage object cannot be found.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



CreateDisk_Task(createDisk)

Create a virtual disk, which is a storage object with disk as consumption type.

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

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VcenterVStorageObjectManager used to make the method call.
specVslmCreateSpec

The specification of the virtual storage object to be created.

Return Value

Type Description
ManagedObjectReference
to a Task
This method returns a Task object with which to monitor monitor the operation. The info.result property in the Task contains the newly created VStorageObject upon success.

Faults

Type Description
FileFaultThrown if an error occurs when creating the virtual disk.
InvalidDatastoreThrown if the operation cannot be performed on the datastore.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



DeleteVStorageObject_Task(deleteVStorageObject)

Delete a virtual storage object and its associated backings.

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

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VcenterVStorageObjectManager used to make the method call.
idID

The ID of the virtual storage object to be deleted.
datastoreManagedObjectReference
to a Datastore

The datastore where the virtual storage object is located.

Return Value

Type Description
ManagedObjectReference
to a Task
This method returns a Task object with which to monitor the operation.

Faults

Type Description
FileFaultThrown if an error occurs when deleting the virtual storage object.
InvalidDatastoreThrown if the operation cannot be performed on the datastore.
InvalidStateThrown if the operation cannot be performed on the disk. The disk may be consumed and cannot be deleted.
NotFoundThrown if the specified virtual storage object cannot be found.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgressThrown if the virtual storage object is busy.

Events

Type
None



DetachTagFromVStorageObject(detachTagFromVStorageObject)

Detach a tag from a virtual storage object.

Requires privilege InventoryService.Tagging.AttachTag on root folder

Required Privileges
System.Read

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VcenterVStorageObjectManager used to make the method call.
idID

The identifier(ID) of the virtual storage object.
categoryxsd:string

The category to which the tag belongs.
tagxsd:string

The tag which has to be disassociated with the virtual storage object.

Return Value

Type Description
None

Faults

Type Description
NotFoundThrown if the specified category or tag cannot be found.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition



ExtendDisk_Task(extendDisk)

Expand the capacity of a virtual disk, which is a storage object with 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.
Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VcenterVStorageObjectManager used to make the method call.
idID

The ID of the virtual disk to be extended.
datastoreManagedObjectReference
to a Datastore

The datastore where the virtual disk is located.
newCapacityInMBxsd:long

The new capacity of the virtual disk in MB.

Return Value

Type Description
ManagedObjectReference
to a Task
This method returns a Task object with which to monitor the operation.

Faults

Type Description
FileFaultThrown if an error occurs while extending the virtual disk.
InvalidDatastoreThrown if the operation cannot be performed on the datastore.
InvalidStateThrown if the operation cannot be performed on the disk. The disk may be consumed and cannot be extended.
NotFoundThrown if the specified virtual storage object cannot be found.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgressThrown if the virtual storage object is busy.

Events

Type
None



InflateDisk_Task(inflateDisk)

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.

Currently inflateDisk API only supports the following combinations: Valid provisioning type: THIN; Valid Datastore: VMFS, NFS. Inflating a disk is not applicable for VVol/VSAN datastore.

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

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VcenterVStorageObjectManager used to make the method call.
idID

The ID of the virtual disk to be inflated.
datastoreManagedObjectReference
to a Datastore

The datastore where the virtual disk is located.

Return Value

Type Description
ManagedObjectReference
to a Task
This method returns a Task object with which to monitor the operation.

Faults

Type Description
FileFaultThrown if an error occurs while inflating the virtual disk.
InvalidDatastoreThrown if the operation cannot be performed on the datastore.
InvalidStateThrown if the operation cannot be performed on the disk. The disk may be consumed and cannot be extended.
NotFoundThrown if the specified virtual storage object cannot be found.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgressThrown if the virtual storage object is busy.

Events

Type
None



ListTagsAttachedToVStorageObject(listTagsAttachedToVStorageObject)

Lists all tags attached to virtual storage object.
Required Privileges
System.Read

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VcenterVStorageObjectManager used to make the method call.
idID

The ID of the virtual storage object.

Return Value

Type Description
VslmTagEntry[]The list of Tag-association tuples associated with the virtual storage object.

Faults

Type Description
NotFoundThrown if the specified category or tag cannot be found.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition



ListVStorageObject(listVStorageObject)

List all virtual storage objects located on a datastore.

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

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VcenterVStorageObjectManager used to make the method call.
datastoreManagedObjectReference
to a Datastore

The datastore to query for the virtual storage objects.

Return Value

Type Description
ID[]The list of IDs of the virtual storage objects located on the datastore.

Faults

Type Description
InvalidDatastoreThrown if the operation cannot be performed on the datastore, such as datastore cannot be found or inaccessible.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition



ListVStorageObjectsAttachedToTag(listVStorageObjectsAttachedToTag)

Lists all virtual storage objects attached to the tag.
Required Privileges
System.Read

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VcenterVStorageObjectManager used to make the method call.
categoryxsd:string

The category to which the tag belongs.
tagxsd:string

The tag to be queried.

Return Value

Type Description
ID[]The list of IDs of the virtual storage objects.

Faults

Type Description
NotFoundThrown if the specified category or tag cannot be found.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition



ReconcileDatastoreInventory_Task(reconcileDatastoreInventory)

Reconcile the datastore inventory info of virtual storage objects.

Requires Datastore.FileManagement privilege.

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VcenterVStorageObjectManager used to make the method call.
datastoreManagedObjectReference
to a Datastore

The datastore that needs to be reconciled.

Return Value

Type Description
ManagedObjectReference
to a Task

Faults

Type Description
InvalidDatastoreThrown if the operation cannot be performed on the datastore.
NotFound
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



RegisterDisk(registerDisk)

Promote a virtual disk to a First Class Disk.

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


See vim.vslm.BaseConfigInfo.name

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VcenterVStorageObjectManager used to make the method call.
pathxsd:string

URL path to the virtual disk.
See vim.vslm.BaseConfigInfo.name
name*xsd:string

The descriptive name of the disk object. If unset the name will be automatically determined from the path.
See vim.vslm.BaseConfigInfo.name
*Need not be set

Return Value

Type Description
VStorageObjectThe registered virtual storage object for the disk.

Faults

Type Description
AlreadyExistsThrown if disk is already registered as a virtual storage object.
See vim.vslm.BaseConfigInfo.name
FileFaultThrown if an error occurs while registering the virtual disk.
See vim.vslm.BaseConfigInfo.name
InvalidDatastoreThrown if datastore cannot be found or the operation cannot be performed on the datastore.
See vim.vslm.BaseConfigInfo.name
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition



RelocateVStorageObject_Task(relocateVStorageObject)

Relocate a virtual storage object.

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

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VcenterVStorageObjectManager used to make the method call.
idID

The ID of the virtual storage object.
datastoreManagedObjectReference
to a Datastore

The datastore where the source virtual storage object is located.
specVslmRelocateSpec

The specification for relocation of the virtual storage object.

Return Value

Type Description
ManagedObjectReference
to a Task

Faults

Type Description
FileFaultThrown if an error occurs while relocating the virtual storage object.
InvalidDatastoreThrown if the operation cannot be performed on the datastore.
InvalidStateThrown if the operation cannot be performed on the disk. The disk may be consumed and cannot be relocated.
NotFoundThrown if specified virtual storage object cannot be found.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



RenameVStorageObject(renameVStorageObject)

Rename a virtual storage object.
Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VcenterVStorageObjectManager used to make the method call.
idID

The ID of the virtual storage object to be renamed.
datastoreManagedObjectReference
to a Datastore

The datastore where the virtual storage object is located.
namexsd:string

The new name for the virtual storage object.

Return Value

Type Description
None

Faults

Type Description
FileFaultThrown if an error occurs while renaming the virtual storage object.
InvalidDatastoreThrown if the operation cannot be performed on the datastore.
NotFoundThrown if the specified virtual storage object cannot be found.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition



RetrieveVStorageObject(retrieveVStorageObject)

Retrieve a virtual storage object.

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

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VcenterVStorageObjectManager used to make the method call.
idID

The ID of the virtual storage object to be retrieved.
datastoreManagedObjectReference
to a Datastore

The datastore where the virtual storage object is located.

Return Value

Type Description
VStorageObjectThe required virtual storage object.

Faults

Type Description
FileFaultThrown if an error occurs when retrieving the virtual object.
InvalidDatastoreThrown if the operation cannot be performed on the datastore.
NotFoundThrown if specified virtual storage object cannot be found.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition



RetrieveVStorageObjectState(retrieveVStorageObjectState)

Retrieve a virtual storage object state.

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

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VcenterVStorageObjectManager used to make the method call.
idID

The ID of the virtual storage object the state to be retrieved.
datastoreManagedObjectReference
to a Datastore

The datastore where the virtual storage object is located.

Return Value

Type Description
VStorageObjectStateInfoThe required virtual storage object state.

Faults

Type Description
FileFaultThrown if an error occurs when retrieving the virtual object state.
InvalidDatastoreThrown if the operation cannot be performed on the datastore.
NotFoundThrown if specified virtual storage object cannot be found.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition



ScheduleReconcileDatastoreInventory(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.

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VcenterVStorageObjectManager used to make the method call.
datastoreManagedObjectReference
to a Datastore

The datastore that needs to be reconciled.

Return Value

Type Description
None

Faults

Type Description
InvalidDatastoreThrown if the operation cannot be performed on the datastore.
NotFound
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition