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

Extends: VStorageObjectManagerBase
See also: CryptoSpec, Datastore, ID, KeyValue, VirtualMachineProfileSpec, VslmCloneSpec, VslmCreateSpec, vslmInfrastructureObjectPolicy, VslmRelocateSpec, vslmVClockInfo, VStorageObject, VStorageObjectSnapshotInfo, VStorageObjectStateInfo
Since: vSphere API Release 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
HostClearVStorageObjectControlFlags, HostCloneVStorageObject_Task, HostCreateDisk_Task, HostDeleteVStorageObject_Task, HostDeleteVStorageObjectEx_Task, HostExtendDisk_Task, HostInflateDisk_Task, HostListVStorageObject, HostQueryVirtualDiskUuid, HostReconcileDatastoreInventory_Task, HostRegisterDisk, HostRelocateVStorageObject_Task, HostRenameVStorageObject, HostRetrieveVStorageInfrastructureObjectPolicy, HostRetrieveVStorageObject, HostRetrieveVStorageObjectMetadata, HostRetrieveVStorageObjectMetadataValue, HostRetrieveVStorageObjectState, HostScheduleReconcileDatastoreInventory, HostSetVirtualDiskUuid_Task, HostSetVStorageObjectControlFlags, HostUpdateVStorageObjectMetadata_Task, HostUpdateVStorageObjectMetadataEx_Task, HostVStorageObjectCreateDiskFromSnapshot_Task, HostVStorageObjectCreateSnapshot_Task, HostVStorageObjectDeleteSnapshot_Task, HostVStorageObjectRetrieveSnapshotInfo, HostVStorageObjectRevert_Task
Methods inherited from VStorageObjectManagerBase
RenameVStorageObjectEx, RevertVStorageObjectEx_Task, VStorageObjectCreateSnapshotEx_Task, VStorageObjectDeleteSnapshotEx_Task, VStorageObjectExtendDiskEx_Task

HostClearVStorageObjectControlFlags(clearVStorageObjectControlFlags)

Clear control flags on VStorageObject. The control flags are defined in vslmVStorageObjectControlFlag.

Required Privileges: System.View
Since: vSphere API Release 6.7

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. *Since* vSphere API Release 6.7
datastore P	ManagedObjectReference to a Datastore	The datastore where the source virtual storage object is located. *Since* vSphere API Release 6.7
controlFlags*	xsd:string[]	control flags enum array to be cleared on the VStorageObject. All control flags not included in the array remain intact. *Since* vSphere API Release 6.7

*Need not be set P Required privilege: Datastore.FileManagement

Return Value

Type	Description
None

Faults

Type	Description
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.
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:pbm="urn:pbm" name="HostClearVStorageObjectControlFlags" type="pbm:HostClearVStorageObjectControlFlagsRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:pbm="urn:pbm" name="HostClearVStorageObjectControlFlagsResponse">
                  <complexType/>
               </element>

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. *Since* vSphere API Release 6.5
datastore	ManagedObjectReference to a Datastore	The datastore where the source virtual storage object is located. *Since* vSphere API Release 6.5
spec	VslmCloneSpec	The specification for cloning the virtual storage object. *Since* vSphere API Release 6.5

Return Value

Type	Description
pbm.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 vim.vslm.VStorageObject.ConsumptionType#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

Since vSphere API Release 6.5

Return Value

Type	Description
pbm.Task	This method returns a Task object with which to monitor the operation. The 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.

The ID of the virtual storage object to be deleted.

Since vSphere API Release 6.5

datastore

ManagedObjectReference
to a Datastore

The datastore where the virtual storage object is located.

Since vSphere API Release 6.5

Return Value

Type	Description
pbm.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

HostDeleteVStorageObjectEx_Task(deleteVStorageObjectEx)

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
Since: vSphere API Release 7.0.2.0

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the HostVStorageObjectManager used to make the method call.

The ID of the virtual storage object to be deleted.

Since vSphere API Release 7.0.2.0

datastore

ManagedObjectReference
to a Datastore

The datastore where the virtual storage object is located.

Since vSphere API Release 7.0.2.0

Return Value

Type	Description
pbm.Task

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 vim.vslm.VStorageObject.ConsumptionType#disk, to the new capacity. If new capacity is smaller than current disk capacity, then operation fails due to invalid capacity. If new capacity is greater than current disk capacity, then operation proceeds. If new capacity is equal to current disk ccapcity, then operation succeeds without any actual extension. 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. *Since* vSphere API Release 6.5
datastore	ManagedObjectReference to a Datastore	The datastore where the virtual disk is located. *Since* vSphere API Release 6.5
newCapacityInMB	xsd:long	The new capacity of the virtual disk in MB. *Since* vSphere API Release 6.5

Return Value

Type	Description
pbm.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.

The ID of the virtual disk to be inflated.

Since vSphere API Release 6.5

datastore

ManagedObjectReference
to a Datastore

The datastore where the virtual disk is located.

Since vSphere API Release 6.5

Return Value

Type	Description
pbm.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.

Since vSphere API Release 6.5

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:pbm="urn:pbm" name="HostListVStorageObject" type="pbm:HostListVStorageObjectRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:pbm="urn:pbm" name="HostListVStorageObjectResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="pbm:ID" minOccurs="0" maxOccurs="unbounded"/>
                     </sequence>
                  </complexType>
               </element>

HostQueryVirtualDiskUuid(queryVirtualDiskUuidEx)

Get the virtual disk UUID.

Required Privileges: System.View
Since: vSphere API Release 8.0.3.0

Parameters

Name Type Description

_this ManagedObjectReference A reference to the HostVStorageObjectManager used to make the method call.

name

xsd:string

The name of the disk, either a datastore path or a URL referring to the virtual disk whose uuid for the DDB entry needs to be queried. A URL has the form

scheme://authority/folder/path?dsName=dsName

where

scheme is http or https.
authority specifies the hostname or IP address of the VirtualCenter or ESX server and optionally the port.
dsName is the name of the Datastore.
path is a slash-delimited path from the root of the datastore.

A datastore path has the form

[datastore] path

where

datastore is the datastore name.
path is a slash-delimited path from the root of the datastore.

An example datastore path is "[storage] path/to/file.extension".

Since vSphere API Release 8.0.3.0

Return Value

Type	Description
xsd:string	The hex representation of the unique ID for this virtual disk.

Faults

Type	Description
FileFault	Thrown if an error occurs reading 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

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:pbm="urn:pbm" name="HostQueryVirtualDiskUuid" type="pbm:HostQueryVirtualDiskUuidRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:pbm="urn:pbm" name="HostQueryVirtualDiskUuidResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="xsd:string"/>
                     </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.

Since vSphere API Release 6.5

Return Value

Type	Description
pbm.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 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 name *Since* vSphere API Release 6.5
name*	xsd:string	The descriptive name of the disk object. If unset the name will be automatically determined from the path. See name *Since* vSphere API Release 6.5
modifyControlFlags*	xsd:boolean	Optional Parameter describing if the control Flags should be changed to default values See name *Since* vSphere API Release 6.5

*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 name
FileFault	Thrown if an error occurs while registering the virtual disk. See name
InvalidDatastore	Thrown if datastore cannot be found or the operation cannot be performed on the datastore. See 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:pbm="urn:pbm" name="HostRegisterDisk" type="pbm:HostRegisterDiskRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:pbm="urn:pbm" name="HostRegisterDiskResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="pbm: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. *Since* vSphere API Release 6.5
datastore	ManagedObjectReference to a Datastore	The datastore where the source virtual storage object is located. *Since* vSphere API Release 6.5
spec	VslmRelocateSpec	The specification for relocation of the virtual storage object. *Since* vSphere API Release 6.5

Return Value

Type	Description
pbm.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. *Since* vSphere API Release 6.5
datastore	ManagedObjectReference to a Datastore	The datastore where the virtual storage object is located. *Since* vSphere API Release 6.5
name	xsd:string	The new name for the virtual storage object. *Since* vSphere API Release 6.5

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:pbm="urn:pbm" name="HostRenameVStorageObject" type="pbm:HostRenameVStorageObjectRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:pbm="urn:pbm" name="HostRenameVStorageObjectResponse">
                  <complexType/>
               </element>

HostRetrieveVStorageInfrastructureObjectPolicy(retrieveVStorageInfrastructureObjectPolicy)

Retrieve virtual storage infrastructure object SBPM policy on given datastore. Only support VSAN datastore.

Requires Datastore.FileManagement privilege on the datastore specified.

Required Privileges: System.View
Since: vSphere API Release 6.7

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the HostVStorageObjectManager used to make the method call.

datastore

ManagedObjectReference
to a Datastore

Datastore on which policy needs to be retrieved.

Since vSphere API Release 6.7

Return Value

Type	Description
vslmInfrastructureObjectPolicy[]	The policy object of virtual storage object.

Faults

Type	Description
InvalidDatastore	Thrown if the operation cannot be performed on the datastore.
InvalidState	Thrown if the operation cannot be performed on the disk.
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:pbm="urn:pbm" name="HostRetrieveVStorageInfrastructureObjectPolicy" type="pbm:HostRetrieveVStorageInfrastructureObjectPolicyRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:pbm="urn:pbm" name="HostRetrieveVStorageInfrastructureObjectPolicyResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="pbm:vslmInfrastructureObjectPolicy" minOccurs="0" maxOccurs="unbounded"/>
                     </sequence>
                  </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. *Since* vSphere API Release 6.5
datastore	ManagedObjectReference to a Datastore	The datastore where the virtual storage object is located. *Since* vSphere API Release 6.5
diskInfoFlags*	xsd:string[]	Flags indicating the FCD information to be retrieved. If diskInfoFlags is unset, then all FCD information will be retrieved. See vslmDiskInfoFlag for the list of supported values. *Since* vSphere API Release 6.5

*Need not be set

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:pbm="urn:pbm" name="HostRetrieveVStorageObject" type="pbm:HostRetrieveVStorageObjectRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:pbm="urn:pbm" name="HostRetrieveVStorageObjectResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="pbm:VStorageObject"/>
                     </sequence>
                  </complexType>
               </element>

HostRetrieveVStorageObjectMetadata(retrieveVStorageObjectMetadata)

Retrieve metadata KV pairs from a virtual storage object.

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

Required Privileges: System.View
Since: vSphere API Release 6.7.2

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. *Since* vSphere API Release 6.7.2
datastore	ManagedObjectReference to a Datastore	The datastore to query for the virtual storage objects. *Since* vSphere API Release 6.7.2
snapshotId*	ID	The ID of the snapshot of virtual storage object. *Since* vSphere API Release 6.7.2
prefix*	xsd:string	The prefix of the metadata key that needs to be retrieved *Since* vSphere API Release 6.7.2

*Need not be set

Return Value

Type	Description
KeyValue[]	returns the array of key value pair

Faults

Type	Description
InvalidDatastore	Thrown if the operation cannot be performed on the datastore, such as datastore cannot be found or inaccessible.
InvalidState	Thrown if the operation cannot be performed on the disk.
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:pbm="urn:pbm" name="HostRetrieveVStorageObjectMetadata" type="pbm:HostRetrieveVStorageObjectMetadataRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:pbm="urn:pbm" name="HostRetrieveVStorageObjectMetadataResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="pbm:KeyValue" minOccurs="0" maxOccurs="unbounded"/>
                     </sequence>
                  </complexType>
               </element>

HostRetrieveVStorageObjectMetadataValue(retrieveVStorageObjectMetadataValue)

Retrieve the metadata value by key from a virtual storage object.

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

Required Privileges: System.View
Since: vSphere API Release 6.7.2

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. *Since* vSphere API Release 6.7.2
datastore	ManagedObjectReference to a Datastore	The datastore to query for the virtual storage objects. *Since* vSphere API Release 6.7.2
snapshotId*	ID	The ID of the snapshot of virtual storage object. *Since* vSphere API Release 6.7.2
key	xsd:string	The key for the the virtual storage object *Since* vSphere API Release 6.7.2

*Need not be set

Return Value

Type	Description
xsd:string	returns the value for the key

Faults

Type	Description
InvalidDatastore	Thrown if the operation cannot be performed on the datastore, such as datastore cannot be found or inaccessible.
InvalidState	Thrown if the operation cannot be performed on the disk.
KeyNotFound	Thrown if specified key cannot be found.
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:pbm="urn:pbm" name="HostRetrieveVStorageObjectMetadataValue" type="pbm:HostRetrieveVStorageObjectMetadataValueRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:pbm="urn:pbm" name="HostRetrieveVStorageObjectMetadataValueResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="xsd:string"/>
                     </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.

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

Since vSphere API Release 6.5

datastore

ManagedObjectReference
to a Datastore

The datastore where the virtual storage object is located.

Since vSphere API Release 6.5

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:pbm="urn:pbm" name="HostRetrieveVStorageObjectState" type="pbm:HostRetrieveVStorageObjectStateRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:pbm="urn:pbm" name="HostRetrieveVStorageObjectStateResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="pbm: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.

Since vSphere API Release 6.5

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:pbm="urn:pbm" name="HostScheduleReconcileDatastoreInventory" type="pbm:HostScheduleReconcileDatastoreInventoryRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:pbm="urn:pbm" name="HostScheduleReconcileDatastoreInventoryResponse">
                  <complexType/>
               </element>

HostSetVirtualDiskUuid_Task(setVirtualDiskUuidEx)

Set the virtual disk Uuid.

Required Privileges: System.View
Since: vSphere API Release 8.0.3.0

Parameters

Name Type Description

_this ManagedObjectReference A reference to the HostVStorageObjectManager used to make the method call.

name

xsd:string

The name of the disk, either a datastore path or a URL referring to the virtual disk whose uuid for the DDB entry needs to be set. A URL has the form

scheme://authority/folder/path?dsName=dsName

where

scheme is http or https.
authority specifies the hostname or IP address of the VirtualCenter or ESX server and optionally the port.
dsName is the name of the Datastore.
path is a slash-delimited path from the root of the datastore.

A datastore path has the form

[datastore] path

where

datastore is the datastore name.
path is a slash-delimited path from the root of the datastore.

An example datastore path is "[storage] path/to/file.extension".

Since vSphere API Release 8.0.3.0

uuid*

xsd:string

The hex representation of the unique ID for this virtual disk. If uuid is not set or missing, a random UUID is generated and assigned.

Since vSphere API Release 8.0.3.0

*Need not be set

Return Value

Type	Description
pbm.Task

Faults

Type	Description
FileFault	Thrown if an error occurs updating 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

HostSetVStorageObjectControlFlags(setVStorageObjectControlFlags)

Set control flags on VStorageObject. The control flags are defined in vslmVStorageObjectControlFlag.

Required Privileges: System.View
Since: vSphere API Release 6.7

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. *Since* vSphere API Release 6.7
datastore P	ManagedObjectReference to a Datastore	The datastore where the source virtual storage object is located. *Since* vSphere API Release 6.7
controlFlags*	xsd:string[]	control flags enum array to be set on the VStorageObject. All control flags not included in the array remain intact. *Since* vSphere API Release 6.7

*Need not be set P Required privilege: Datastore.FileManagement

Return Value

Type	Description
None

Faults

Type	Description
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.
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:pbm="urn:pbm" name="HostSetVStorageObjectControlFlags" type="pbm:HostSetVStorageObjectControlFlagsRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:pbm="urn:pbm" name="HostSetVStorageObjectControlFlagsResponse">
                  <complexType/>
               </element>

HostUpdateVStorageObjectMetadata_Task(updateVStorageObjectMetadata)

Update metadata KV pairs to a virtual storage object. And this API is by design supposed to be used for all of the addition, modification and deletion operations of metadata KV pairs.

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

Required Privileges: System.View
Since: vSphere API Release 6.7.2

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. *Since* vSphere API Release 6.7.2
datastore	ManagedObjectReference to a Datastore	The datastore to query for the virtual storage objects. *Since* vSphere API Release 6.7.2
metadata*	KeyValue[]	array of key/value strings. (keys must be unique within the list) *Since* vSphere API Release 6.7.2
deleteKeys*	xsd:string[]	array of keys need to be deleted *Since* vSphere API Release 6.7.2

*Need not be set

Return Value

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

Faults

Type	Description
InvalidDatastore	Thrown if the operation cannot be performed on the datastore, such as datastore cannot be found or inaccessible.
InvalidState	Thrown if the operation cannot be performed on the disk.
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

HostUpdateVStorageObjectMetadataEx_Task(updateVStorageObjectMetadataEx)

Update metadata KV pairs to a virtual storage object. And this API is by design supposed to be used for all of the addition, modification and deletion operations of metadata KV pairs.

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

Required Privileges: System.View
Since: vSphere API Release 7.0.2.0

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. *Since* vSphere API Release 7.0.2.0
datastore	ManagedObjectReference to a Datastore	The datastore to query for the virtual storage objects. *Since* vSphere API Release 7.0.2.0
metadata*	KeyValue[]	array of key/value strings. (keys must be unique within the list) *Since* vSphere API Release 7.0.2.0
deleteKeys*	xsd:string[]	array of keys need to be deleted *Since* vSphere API Release 7.0.2.0

*Need not be set

Return Value

Type	Description
pbm.Task

Faults

Type	Description
InvalidDatastore	Thrown if the operation cannot be performed on the datastore, such as datastore cannot be found or inaccessible.
InvalidState	Thrown if the operation cannot be performed on the disk.
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

HostVStorageObjectCreateDiskFromSnapshot_Task(createDiskFromSnapshot)

Creates a new Disk from given snapshot of a VStorageObject.

Required Privileges: System.View
Since: vSphere API Release 6.7

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. *Since* vSphere API Release 6.7
datastore	ManagedObjectReference to a Datastore	The datastore where the source virtual storage object is located. *Since* vSphere API Release 6.7
snapshotId	ID	The ID of the snapshot of the virtual storage object. *Since* vSphere API Release 6.7
name	xsd:string	A user friendly name to be associated with the new disk. *Since* vSphere API Release 6.7
profile*	VirtualMachineProfileSpec[]	SPBM Profile requirement on the new virtual storage object. If not specified datastore default policy would be assigned. *Since* vSphere API Release 6.7
crypto*	CryptoSpec	Crypto information of the new disk. *Since* vSphere API Release 6.7
path*	xsd:string	Relative location in the specified datastore where disk needs to be created. If not specified disk gets created at defualt VStorageObject location on the specified datastore. *Since* vSphere API Release 6.7
provisioningType*	xsd:string	Provisioining type of the disk as specified in above mentioned profile. The list of supported values can be found in BaseConfigInfoDiskFileBackingInfoProvisioningType *Since* vSphere API Release 6.7

*Need not be set

Return Value

Type	Description
pbm.Task

Faults

Type	Description
FileFault	Thrown if an error occurs while snapshotting 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.
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

HostVStorageObjectCreateSnapshot_Task(createSnapshot)

Creates a snapshot of a given VStorageObject.

Required Privileges: System.View
Since: vSphere API Release 6.7

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. *Since* vSphere API Release 6.7
datastore	ManagedObjectReference to a Datastore	The datastore where the source virtual storage object is located. *Since* vSphere API Release 6.7
description	xsd:string	A short description to be associated with the snapshot. *Since* vSphere API Release 6.7

Return Value

Type	Description
pbm.Task

Faults

Type	Description
FileFault	Thrown if an error occurs while snapshotting 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.
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

HostVStorageObjectDeleteSnapshot_Task(deleteSnapshot)

Deletes a given snapshot of a VStorageObject.

Required Privileges: System.View
Since: vSphere API Release 6.7

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. *Since* vSphere API Release 6.7
datastore	ManagedObjectReference to a Datastore	The datastore where the source virtual storage object is located. *Since* vSphere API Release 6.7
snapshotId	ID	The ID of the snapshot of a virtual storage object. *Since* vSphere API Release 6.7

Return Value

Type	Description
pbm.Task

Faults

Type	Description
FileFault	Thrown if an error occurs while snapshotting 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.
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

HostVStorageObjectRetrieveSnapshotInfo(retrieveSnapshotInfo)

Retrieves snapshot information of a given VStorageObject.

Required Privileges: System.View
Since: vSphere API Release 6.7

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the HostVStorageObjectManager used to make the method call.

The ID of the virtual storage object.

Since vSphere API Release 6.7

datastore

ManagedObjectReference
to a Datastore

The datastore where the source virtual storage object is located.

Since vSphere API Release 6.7

Return Value

Type	Description
VStorageObjectSnapshotInfo

Faults

Type	Description
FileFault	Thrown if an error occurs while snapshotting 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.
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:pbm="urn:pbm" name="HostVStorageObjectRetrieveSnapshotInfo" type="pbm:HostVStorageObjectRetrieveSnapshotInfoRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:pbm="urn:pbm" name="HostVStorageObjectRetrieveSnapshotInfoResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="pbm:VStorageObjectSnapshotInfo"/>
                     </sequence>
                  </complexType>
               </element>

HostVStorageObjectRevert_Task(RevertVStorageObject)

Reverts to a given snapshot of a VStorageObject. This operation is supported on detached VirtualDisks During revert all the snapshots which were taken after the specified snapshot would get deleted.

E.g. Consider Disk with 4 snapshots

BaseDisk -> Snap-2 -> Snap-3 -> Snap-4 -> Running-Point

If user chooses to revert to snap-2 then snap-4 and snap-3 would also be deleted. After revert operation disk would have below configuration:

BaseDisk -> Snap-2 -> Running-Point

Required Privileges: System.View
Since: vSphere API Release 6.7

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. *Since* vSphere API Release 6.7
datastore	ManagedObjectReference to a Datastore	The datastore where the source virtual storage object is located. *Since* vSphere API Release 6.7
snapshotId	ID	The ID of the snapshot of a virtual storage object. *Since* vSphere API Release 6.7

Return Value

Type	Description
pbm.Task

Faults

Type	Description
FileFault	Thrown if an error occurs while snapshotting 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.
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

VMware Storage Policy API

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

Managed Object Description

HostClearVStorageObjectControlFlags(clearVStorageObjectControlFlags)

HostCloneVStorageObject_Task(cloneVStorageObject)

HostCreateDisk_Task(createDisk)

HostDeleteVStorageObject_Task(deleteVStorageObject)

HostDeleteVStorageObjectEx_Task(deleteVStorageObjectEx)

HostExtendDisk_Task(extendDisk)

HostInflateDisk_Task(inflateDisk)

HostListVStorageObject(listVStorageObject)

HostQueryVirtualDiskUuid(queryVirtualDiskUuidEx)

HostReconcileDatastoreInventory_Task(reconcileDatastoreInventory)

HostRegisterDisk(registerDisk)

HostRelocateVStorageObject_Task(relocateVStorageObject)

HostRenameVStorageObject(renameVStorageObject)

HostRetrieveVStorageInfrastructureObjectPolicy(retrieveVStorageInfrastructureObjectPolicy)

HostRetrieveVStorageObject(retrieveVStorageObject)

HostRetrieveVStorageObjectMetadata(retrieveVStorageObjectMetadata)

HostRetrieveVStorageObjectMetadataValue(retrieveVStorageObjectMetadataValue)

HostRetrieveVStorageObjectState(retrieveVStorageObjectState)

HostScheduleReconcileDatastoreInventory(scheduleReconcileDatastoreInventory)

HostSetVirtualDiskUuid_Task(setVirtualDiskUuidEx)

HostSetVStorageObjectControlFlags(setVStorageObjectControlFlags)

HostUpdateVStorageObjectMetadata_Task(updateVStorageObjectMetadata)

HostUpdateVStorageObjectMetadataEx_Task(updateVStorageObjectMetadataEx)

HostVStorageObjectCreateDiskFromSnapshot_Task(createDiskFromSnapshot)

HostVStorageObjectCreateSnapshot_Task(createSnapshot)

HostVStorageObjectDeleteSnapshot_Task(deleteSnapshot)

HostVStorageObjectRetrieveSnapshotInfo(retrieveSnapshotInfo)

HostVStorageObjectRevert_Task(RevertVStorageObject)