Managed Object - HostVStorageObjectManager(vim.vslm.host.VStorageObjectManager)

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

Managed Object Description

Interface to manage virtual storage object on an ESXi host.

Properties

Name	Type	Description
None
Properties inherited from VStorageObjectManagerBase
None

Methods

Methods defined in this Managed Object
HostCloneVStorageObject_Task, HostCreateDisk_Task, HostDeleteVStorageObject_Task, HostExtendDisk_Task, HostInflateDisk_Task, HostListVStorageObject, HostReconcileDatastoreInventory_Task, HostRegisterDisk, HostRelocateVStorageObject_Task, HostRenameVStorageObject, HostRetrieveVStorageObject, HostRetrieveVStorageObjectState, HostScheduleReconcileDatastoreInventory
Methods inherited from VStorageObjectManagerBase
None

HostCloneVStorageObject_Task(cloneVStorageObject)

Clone a virtual storage object.

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

Required Privileges: System.View

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostVStorageObjectManager used to make the method call.
id	ID	The ID of the virtual storage object.
datastore	ManagedObjectReference to a Datastore	The datastore where the source virtual storage object is located.
spec	VslmCloneSpec	The specification for cloning the virtual storage object.

Return Value

Type	Description
ManagedObjectReference to a Task

Faults

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

Events

Type
None

HostCreateDisk_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

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostVStorageObjectManager used to make the method call.
spec	VslmCreateSpec	The specification of the virtual storage object to be created. 2

Return Value

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

Faults

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

Events

Type
None

HostDeleteVStorageObject_Task(deleteVStorageObject)

Delete a virtual storage object and its assoicated backings.

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

Required Privileges: System.View

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostVStorageObjectManager used to make the method call.
id	ID	The ID of the virtual storage object to be deleted.
datastore	ManagedObjectReference 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
FileFault	Thrown if an error occurs when deleting the virtual storage object.
InvalidDatastore	Thrown if the operation cannot be performed on the datastore.
InvalidState	Thrown if the operation cannot be performed on the disk. The disk may be consumed and cannot be deleted.
NotFound	Thrown if the specified virtual storage object cannot be found.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress	Thrown if the virtual storage object is busy.

Events

Type
None

HostExtendDisk_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.

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

Required Privileges: System.View

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostVStorageObjectManager used to make the method call.
id	ID	The ID of the virtual disk to be extended.
datastore	ManagedObjectReference to a Datastore	The datastore where the virtual disk is located.
newCapacityInMB	xsd: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
FileFault	Thrown if an error occurs while extending the virtual disk.
InvalidDatastore	Thrown if the operation cannot be performed on the datastore.
InvalidState	Thrown if the operation cannot be performed on the disk. The disk may be consumed and cannot be extended.
NotFound	Thrown if the specified virtual storage object cannot be found.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress	Thrown if the virtual storage object is busy.

Events

Type
None

HostInflateDisk_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 zeroes.

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

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostVStorageObjectManager used to make the method call.
id	ID	The ID of the virtual disk to be inflated.
datastore	ManagedObjectReference 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
FileFault	Thrown if an error occurs while inflating the virtual disk.
InvalidDatastore	Thrown if the operation cannot be performed on the datastore.
InvalidState	Thrown if the operation cannot be performed on the disk. The disk may be consumed and cannot be extended.
NotFound	Thrown if the specified virtual storage object cannot be found.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress	Thrown if the virtual storage object is busy.

Events

Type
None

HostListVStorageObject(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

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostVStorageObjectManager used to make the method call.
datastore	ManagedObjectReference 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
InvalidDatastore	Thrown if the operation cannot be performed on the datastore, such as datastore cannot be found or inaccessible.
RuntimeFault	Thrown 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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="HostListVStorageObject" type="vim25:HostListVStorageObjectRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="HostListVStorageObjectResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:ID" minOccurs="0" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

HostReconcileDatastoreInventory_Task(reconcileDatastoreInventory)

Reconcile the datastore inventory info of virtual storage objects.

Requires Datastore.FileManagement privilege.

Required Privileges: System.View

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostVStorageObjectManager used to make the method call.
datastore	ManagedObjectReference to a Datastore	The datastore that needs to be reconciled.

Return Value

Type	Description
ManagedObjectReference to a Task

Faults

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

Events

Type
None

HostRegisterDisk(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

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostVStorageObjectManager used to make the method call.
path	xsd:string	URL or datastore 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
VStorageObject	The registered virtual storage object for the disk.

Faults

Type	Description
AlreadyExists	Thrown if disk is already registered as a virtual storage object. See vim.vslm.BaseConfigInfo.name
FileFault	Thrown if an error occurs while registering the virtual disk. See vim.vslm.BaseConfigInfo.name
InvalidDatastore	Thrown if datastore cannot be found or the operation cannot be performed on the datastore. See vim.vslm.BaseConfigInfo.name
RuntimeFault	Thrown 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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="HostRegisterDisk" type="vim25:HostRegisterDiskRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="HostRegisterDiskResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:VStorageObject"/>
               </sequence>
            </complexType>
         </element>

HostRelocateVStorageObject_Task(relocateVStorageObject)

Relocate a virtual storage object.

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

Required Privileges: System.View

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostVStorageObjectManager used to make the method call.
id	ID	The ID of the virtual storage object.
datastore	ManagedObjectReference to a Datastore	The datastore where the source virtual storage object is located.
spec	VslmRelocateSpec	The specification for relocation of the virtual storage object.

Return Value

Type	Description
ManagedObjectReference to a Task

Faults

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

Events

Type
None

HostRenameVStorageObject(renameVStorageObject)

Rename a virtual storage object.

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

Required Privileges: System.View

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostVStorageObjectManager used to make the method call.
id	ID	The ID of the virtual storage object to be renamed.
datastore	ManagedObjectReference to a Datastore	The datastore where the virtual storage object is located.
name	xsd:string	The new name for the virtual storage object.

Return Value

Type	Description
None

Faults

Type	Description
FileFault	Thrown if an error occurs while renaming the virtual storage object.
InvalidDatastore	Thrown if the operation cannot be performed on the datastore.
NotFound	Thrown if the specified virtual storage object cannot be found.
RuntimeFault	Thrown 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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="HostRenameVStorageObject" type="vim25:HostRenameVStorageObjectRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="HostRenameVStorageObjectResponse">
            <complexType/>
         </element>

HostRetrieveVStorageObject(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

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostVStorageObjectManager used to make the method call.
id	ID	The ID of the virtual storage object to be retrieved.
datastore	ManagedObjectReference to a Datastore	The datastore where the virtual storage object is located.

Return Value

Type	Description
VStorageObject	The required virtual storage object.

Faults

Type	Description
FileFault	Thrown if an error occurs when retrieving the virtual object.
InvalidDatastore	Thrown if the operation cannot be performed on the datastore.
NotFound	Thrown if specified virtual storage object cannot be found.
RuntimeFault	Thrown 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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="HostRetrieveVStorageObject" type="vim25:HostRetrieveVStorageObjectRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="HostRetrieveVStorageObjectResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:VStorageObject"/>
               </sequence>
            </complexType>
         </element>

HostRetrieveVStorageObjectState(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

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostVStorageObjectManager used to make the method call.
id	ID	The ID of the virtual storage object the state to be retrieved.
datastore	ManagedObjectReference to a Datastore	The datastore where the virtual storage object is located.

Return Value

Type	Description
VStorageObjectStateInfo	The required virtual storage object state.

Faults

Type	Description
FileFault	Thrown if an error occurs when retrieving the virtual object state.
InvalidDatastore	Thrown if the operation cannot be performed on the datastore.
NotFound	Thrown if specified virtual storage object cannot be found.
RuntimeFault	Thrown 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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="HostRetrieveVStorageObjectState" type="vim25:HostRetrieveVStorageObjectStateRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="HostRetrieveVStorageObjectStateResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:VStorageObjectStateInfo"/>
               </sequence>
            </complexType>
         </element>

HostScheduleReconcileDatastoreInventory(scheduleReconcileDatastoreInventory)

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.

Required Privileges: System.View

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostVStorageObjectManager used to make the method call.
datastore	ManagedObjectReference to a Datastore	The datastore that needs to be reconciled.

Return Value

Type	Description
None

Faults

Type	Description
InvalidDatastore	Thrown if the operation cannot be performed on the datastore.
NotFound
RuntimeFault	Thrown 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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="HostScheduleReconcileDatastoreInventory" type="vim25:HostScheduleReconcileDatastoreInventoryRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="HostScheduleReconcileDatastoreInventoryResponse">
            <complexType/>
         </element>