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

Extends
VStorageObjectManagerBase
See also
CryptoSpec, Datastore, DiskChangeInfo, DiskCryptoSpec, ID, KeyValue, RetrieveVStorageObjSpec, VirtualMachineProfileSpec, VslmCloneSpec, VslmCreateSpec, vslmInfrastructureObjectPolicy, vslmInfrastructureObjectPolicySpec, VslmRelocateSpec, VslmTagEntry, vslmVClockInfo, VStorageObject, VStorageObjectAssociations, VStorageObjectSnapshotDetails, VStorageObjectSnapshotInfo, VStorageObjectStateInfo
Since
vSphere API 6.5


Managed Object Description

Interface to manage virtual storage object on a vCenter. VStorageObjectManager and SPBM policy support: All of the VStorageObjectManager APIs requiring ESXi host uses "Programatically selected" host to perform the actual operation. If the selected host is of 6.5 version then policy would not be passed down to host. In that case, user operation would succeed but if user checks SPBM Entity Compliance, it will show "Mismatch" / "Non Compliant" as a compliance result.

Properties

Name Type Description
None
Properties inherited from VStorageObjectManagerBase
None

Methods

Methods defined in this Managed Object
AttachTagToVStorageObject, ClearVStorageObjectControlFlags, CloneVStorageObject_Task, CreateDisk_Task, CreateDiskFromSnapshot_Task, DeleteSnapshot_Task, DeleteVStorageObject_Task, DeleteVStorageObjectEx_Task, DetachTagFromVStorageObject, ExtendDisk_Task, InflateDisk_Task, ListTagsAttachedToVStorageObject, ListVStorageObject, ListVStorageObjectsAttachedToTag, ReconcileDatastoreInventory_Task, RegisterDisk, RelocateVStorageObject_Task, RenameVStorageObject, RetrieveSnapshotDetails, RetrieveSnapshotInfo, RetrieveVStorageInfrastructureObjectPolicy, RetrieveVStorageObject, RetrieveVStorageObjectAssociations, RetrieveVStorageObjectState, RevertVStorageObject_Task, ScheduleReconcileDatastoreInventory, SetVStorageObjectControlFlags, UpdateVStorageInfrastructureObjectPolicy_Task, UpdateVStorageObjectCrypto_Task, UpdateVStorageObjectPolicy_Task, VCenterUpdateVStorageObjectMetadataEx_Task, VStorageObjectCreateSnapshot_Task, VstorageObjectVCenterQueryChangedDiskAreas
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.
id PID

The identifier(ID) of the virtual storage object.

Since vSphere API 6.5
category Pxsd:string

The category to which the tag belongs.

Since vSphere API 6.5
tag Pxsd:string

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

Since vSphere API 6.5
PRequired privilege - see tooltip for details

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



ClearVStorageObjectControlFlags(clearVStorageObjectControlFlags)

Clear control flags on VStorageObject.

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

Required Privileges
System.View
Since
vSphere API 6.7

Parameters

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

The ID of the virtual storage object.

Since vSphere API 6.7
datastore PManagedObjectReference
to a Datastore

The datastore where the source virtual storage object is located.

Since vSphere API 6.7
controlFlags* Pxsd:string[]

control flags enum array to be cleared on the VStorageObject. All control flags not included in the array remain intact.

Since vSphere API 6.7
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

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



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.
id PID

The ID of the virtual storage object.

Since vSphere API 6.5
datastore PManagedObjectReference
to a Datastore

The datastore where the source virtual storage object is located.

Since vSphere API 6.5
spec PVslmCloneSpec

The specification for cloning the virtual storage object.

Since vSphere API 6.5
PRequired privilege - see tooltip for details

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

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

The specification of the virtual storage object to be created.

Since vSphere API 6.5
P Required privilege: spec

Return Value

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



CreateDiskFromSnapshot_Task(createDiskFromSnapshot)

Creates a new Disk from given snapshot of a VStorageObject.

Requires Datastore.FileManagement privilege.

Required Privileges
System.View
Since
vSphere API 6.7

Parameters

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

The ID of the virtual storage object.

Since vSphere API 6.7
datastore PManagedObjectReference
to a Datastore

The datastore where the source virtual storage object is located.

Since vSphere API 6.7
snapshotId PID

The ID of the snapshot of the virtual storage object.

Since vSphere API 6.7
name Pxsd:string

A user friendly name to be associated with the new disk.

Since vSphere API 6.7
profile* PVirtualMachineProfileSpec[]

SPBM Profile requirement on the new virtual storage object. If not specified datastore default policy would be assigned.

Since vSphere API 6.7
crypto* PCryptoSpec

Crypto information of the new disk. If unset and if profile contains an encryption iofilter and if snapshto is unencrypted, then cyrpto will be of type CryptoSpecEncrypt, and filled with keyId that is automatically generated and keyProviderId that is the default kms cluster. If unset and if profile is a default policy and if snapshot is unenrypted, then crypto is treated as CryptoSpecNoOp. If unset and if profile contains an encryption iofilter and if snapshot is encrypted, then cyrpto is treated as CryptoSpecNoOp. If unset and if profile is a default policy and if snapshot is encrypted, then cyrpto is treated as CryptoSpecDecrypt. To recrypt the disk during creating disk, crypto has to be present.

Since vSphere API 6.7
path* Pxsd:string

Relative location in the specified datastore where disk needs to be created. If not specified disk gets created at the defualt VStorageObject location on the specified datastore.

Since vSphere API 6.7
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference
to a Task

Faults

Type Description
FileFaultThrown if an error occurs while snapshotting the virtual storage object.
InvalidDatastoreThrown if the operation cannot be performed on the datastore.
InvalidStateThrown if the operation cannot be performed on the disk.
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



DeleteSnapshot_Task(deleteSnapshot)

Deletes a given snapshot of a VStorageObject.

Requires Datastore.FileManagement privilege.

Required Privileges
System.View
Since
vSphere API 6.7

Parameters

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

The ID of the virtual storage object.

Since vSphere API 6.7
datastore PManagedObjectReference
to a Datastore

The datastore where the source virtual storage object is located.

Since vSphere API 6.7
snapshotId PID

The ID of the snapshot of a virtual storage object.

Since vSphere API 6.7
PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference
to a Task

Faults

Type Description
FileFaultThrown if an error occurs while snapshotting the virtual storage object.
InvalidDatastoreThrown if the operation cannot be performed on the datastore.
InvalidStateThrown if the operation cannot be performed on the disk.
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



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.
id PID

The ID of the virtual storage object to be deleted.

Since vSphere API 6.5
datastore PManagedObjectReference
to a Datastore

The datastore where the virtual storage object is located.

Since vSphere API 6.5
PRequired privilege - see tooltip for details

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



DeleteVStorageObjectEx_Task(deleteVStorageObjectEx)

Delete a virtual storage object and its associated backings. Returns the corresponding vclock upon succeess.

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

Required Privileges
System.View
Since
vSphere API 7.0.2.0

Parameters

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

The ID of the virtual storage object to be deleted.

Since vSphere API 7.0.2.0
datastore PManagedObjectReference
to a Datastore

The datastore where the virtual storage object is located.

Since vSphere API 7.0.2.0
PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference
to a Task

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.
id PID

The identifier(ID) of the virtual storage object.

Since vSphere API 6.5
category Pxsd:string

The category to which the tag belongs.

Since vSphere API 6.5
tag Pxsd:string

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

Since vSphere API 6.5
PRequired privilege - see tooltip for details

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 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.
Required Privileges
System.View

Parameters

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

The ID of the virtual disk to be extended.

Since vSphere API 6.5
datastore PManagedObjectReference
to a Datastore

The datastore where the virtual disk is located.

Since vSphere API 6.5
newCapacityInMB Pxsd:long

The new capacity of the virtual disk in MB.

Since vSphere API 6.5
PRequired privilege - see tooltip for details

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.
id PID

The ID of the virtual disk to be inflated.

Since vSphere API 6.5
datastore PManagedObjectReference
to a Datastore

The datastore where the virtual disk is located.

Since vSphere API 6.5
PRequired privilege - see tooltip for details

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.
id PID

The ID of the virtual storage object.

Since vSphere API 6.5
P Required privilege: id

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.
datastore PManagedObjectReference
to a Datastore

The datastore to query for the virtual storage objects.

Since vSphere API 6.5
P Required privilege: datastore

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 is 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.
category Pxsd:string

The category to which the tag belongs.

Since vSphere API 6.5
tag Pxsd:string

The tag to be queried.

Since vSphere API 6.5
PRequired privilege - see tooltip for details

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.
datastore PManagedObjectReference
to a Datastore

The datastore that needs to be reconciled.

Since vSphere API 6.5
P Required privilege: datastore

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.
path Pxsd:string

URL path to the virtual disk.
See vim.vslm.BaseConfigInfo.name

Since vSphere API 6.5
name* Pxsd:string

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

Since vSphere API 6.5
*Need not be set PRequired privilege - see tooltip for details

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.
id PID

The ID of the virtual storage object.

Since vSphere API 6.5
datastore PManagedObjectReference
to a Datastore

The datastore where the source virtual storage object is located.

Since vSphere API 6.5
spec PVslmRelocateSpec

The specification for relocation of the virtual storage object.

Since vSphere API 6.5
PRequired privilege - see tooltip for details

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.
id PID

The ID of the virtual storage object to be renamed.

Since vSphere API 6.5
datastore PManagedObjectReference
to a Datastore

The datastore where the virtual storage object is located.

Since vSphere API 6.5
name Pxsd:string

The new name for the virtual storage object.

Since vSphere API 6.5
PRequired privilege - see tooltip for details

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



RetrieveSnapshotDetails(retrieveSnapshotDetails)

Retrieves snapshot disk details of a given snapshot.
Required Privileges
System.View
Since
vSphere API 7.0

Parameters

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

The ID of the virtual storage object.

Since vSphere API 6.7
datastore PManagedObjectReference
to a Datastore

The datastore where the source virtual storage object is located.

Since vSphere API 6.7
snapshotId PID

The ID of the snapshot of a virtual storage object.

Since vSphere API 6.7
PRequired privilege - see tooltip for details

Return Value

Type Description
VStorageObjectSnapshotDetails

Faults

Type Description
FileFaultThrown if an error occurs while snapshotting the virtual storage object.
InvalidDatastoreThrown if the operation cannot be performed on the datastore.
InvalidStateThrown if the operation cannot be performed on the disk.
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



RetrieveSnapshotInfo(retrieveSnapshotInfo)

Retrieves snapshot information of a given VStorageObject.

Requires Datastore.FileManagement privilege.

Required Privileges
System.View
Since
vSphere API 6.7

Parameters

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

The ID of the virtual storage object.

Since vSphere API 6.7
datastore PManagedObjectReference
to a Datastore

The datastore where the source virtual storage object is located.

Since vSphere API 6.7
PRequired privilege - see tooltip for details

Return Value

Type Description
VStorageObjectSnapshotInfo

Faults

Type Description
FileFaultThrown if an error occurs while snapshotting the virtual storage object.
InvalidDatastoreThrown if the operation cannot be performed on the datastore.
InvalidStateThrown if the operation cannot be performed on the disk.
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



RetrieveVStorageInfrastructureObjectPolicy(retrieveVStorageInfrastructureObjectPolicy)

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

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

Required Privileges
System.View
Since
vSphere API 6.7

Parameters

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

Datastore on which policy needs to be retrieved.

Since vSphere API 6.7
P Required privilege: datastore

Return Value

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

Faults

Type Description
InvalidDatastoreThrown if the operation cannot be performed on the datastore.
InvalidStateThrown if the operation cannot be performed on the disk.
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



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.
id PID

The ID of the virtual storage object to be retrieved.

Since vSphere API 6.5
datastore PManagedObjectReference
to a Datastore

The datastore where the virtual storage object is located.

Since vSphere API 6.5
PRequired privilege - see tooltip for details

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



RetrieveVStorageObjectAssociations(retrieveVStorageObjectAssociations)

Retrieve vm associations for each virtual storage object in the query.
Required Privileges
System.View
Since
vSphere API 6.7

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VcenterVStorageObjectManager used to make the method call.
ids* PRetrieveVStorageObjSpec[]

The IDs of the virtual storage objects of the query.

Since vSphere API 6.7
*Need not be set P Required privilege: ids

Return Value

Type Description
VStorageObjectAssociations[]The list of VStorageObjectVmAssociations which provides virtual storage object id to vm associations mapping.

Faults

Type Description
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.
id PID

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

Since vSphere API 6.5
datastore PManagedObjectReference
to a Datastore

The datastore where the virtual storage object is located.

Since vSphere API 6.5
PRequired privilege - see tooltip for details

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



RevertVStorageObject_Task

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

Requires Datastore.FileManagement privilege.

Required Privileges
System.View
Since
vSphere API 6.7

Parameters

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

The ID of the virtual storage object.

Since vSphere API 6.7
datastore PManagedObjectReference
to a Datastore

The datastore where the source virtual storage object is located.

Since vSphere API 6.7
snapshotId PID

The ID of the snapshot of a virtual storage object.

Since vSphere API 6.7
PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference
to a Task

Faults

Type Description
FileFaultThrown if an error occurs while snapshotting the virtual storage object.
InvalidDatastoreThrown if the operation cannot be performed on the datastore.
InvalidStateThrown if the operation cannot be performed on the disk.
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



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.
datastore PManagedObjectReference
to a Datastore

The datastore that needs to be reconciled.

Since vSphere API 6.5
P Required privilege: datastore

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



SetVStorageObjectControlFlags(setVStorageObjectControlFlags)

Set control flags on VStorageObject.

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

Required Privileges
System.View
Since
vSphere API 6.7

Parameters

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

The ID of the virtual storage object.

Since vSphere API 6.7
datastore PManagedObjectReference
to a Datastore

The datastore where the source virtual storage object is located.

Since vSphere API 6.7
controlFlags* Pxsd:string[]

control flags enum array to be set on the VStorageObject. All control flags not included in the array remain intact.

Since vSphere API 6.7
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

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



UpdateVStorageInfrastructureObjectPolicy_Task(updateVStorageInfrastructureObjectPolicy)

Assigns specified SBPM policy to the given virtual storage infrastructure object. Only support VSAN datastore.

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

Required Privileges
System.View
Since
vSphere API 6.7

Parameters

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

specification to assign a SPBM policy to virtual storage infrastructure object.

Since vSphere API 6.7
P Required privilege: spec

Return Value

Type Description
ManagedObjectReference
to a Task

Faults

Type Description
InvalidDatastoreThrown if the operation cannot be performed on the datastore.
InvalidStateThrown if there is issue with profile spec.
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.
TaskInProgress

Events

Type
None



UpdateVStorageObjectCrypto_Task(updateVStorageObjectCrypto)

Update the crypto on a virtual storage object. This is also intended for disk encryption, decryption and re-encryption. To encrypt the disk, profile must contain an encryption component. disksCrypto can be left as blank, which means caller doesn't care which key is used to encrypt the disk. If it's not blank, it has to be of type CryptoSpecEncrypt. To decrypt the disk, profile must not contain an encryption component. disksCrypto can be left as blank, if not, it has be of type CryptoSpecDecrypt. To re-encrypt the disk, profile must contain an encryption component. disksCrypto cannot be left as blank. It has to be of type either CryptoSpecShallowRecrypt or CryptoSpecDeepRecrypt.

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

Required Privileges
System.View
Since
vSphere API 7.0

Parameters

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

The ID of the virtual storage object.

Since vSphere API 7.0
datastore PManagedObjectReference
to a Datastore

The datastore where the virtual storage object is located.

Since vSphere API 7.0
profile* PVirtualMachineProfileSpec[]

New profile requirement on the virtual storage object.

Since vSphere API 7.0
disksCrypto* PDiskCryptoSpec

The crypto information of each disk on the chain.

Since vSphere API 7.0
*Need not be set PRequired privilege - see tooltip for details

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 updating the virtual storage object policy.
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.
TaskInProgressThrown if the virtual storage object is busy.

Events

Type
None



UpdateVStorageObjectPolicy_Task(updateVStorageObjectPolicy)

Update the storage policy on 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 6.7

Parameters

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

The ID of the virtual storage object.

Since vSphere API 6.7
datastore PManagedObjectReference
to a Datastore

The datastore where the virtual storage object is located.

Since vSphere API 6.7
profile* PVirtualMachineProfileSpec[]

New profile requirement on the virtual storage object.

Since vSphere API 6.7
*Need not be set PRequired privilege - see tooltip for details

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 updating the virtual storage object policy.
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.
TaskInProgressThrown if the virtual storage object is busy.

Events

Type
None



VCenterUpdateVStorageObjectMetadataEx_Task(updateVStorageObjectMetadataEx)

Update metadata KV pairs to a virtual storage object and returns the corresponding vclock upon success.
Required Privileges
System.View
Since
vSphere API 7.0.2.0

Parameters

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

The ID of the virtual storage object.

Since vSphere API 7.0.2.0
datastore PManagedObjectReference
to a Datastore

The datastore to query for the virtual storage objects.

Since vSphere API 7.0.2.0
metadata* PKeyValue[]

array of key/value strings. (keys must be unique within the list)

Since vSphere API 7.0.2.0
deleteKeys* Pxsd:string[]

array of keys need to be deleted

Since vSphere API 7.0.2.0
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference
to a Task

Faults

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



VStorageObjectCreateSnapshot_Task(createSnapshot)

Creates a snapshot of a given VStorageObject.

Requires Datastore.FileManagement privilege.

Required Privileges
System.View
Since
vSphere API 6.7

Parameters

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

The ID of the virtual storage object.

Since vSphere API 6.7
datastore PManagedObjectReference
to a Datastore

The datastore where the source virtual storage object is located.

Since vSphere API 6.7
description Pxsd:string

A short description to be associated with the snapshot.

Since vSphere API 6.7
PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference
to a Task

Faults

Type Description
FileFaultThrown if an error occurs while snapshotting the virtual storage object.
InvalidDatastoreThrown if the operation cannot be performed on the datastore.
InvalidStateThrown if the operation cannot be performed on the disk.
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



VstorageObjectVCenterQueryChangedDiskAreas(queryChangedDiskAreas)

Get a list of areas of a virtual disk that have been modified since a well-defined point in the past. The beginning of the change interval is identified by "changeId", while the end of the change interval is implied by the snapshot ID passed in.

Note that the result of this function may contain "false positives" (i.e: flag areas of the disk as modified that are not). However, it is guaranteed that no changes will be missed.

Required Privileges
System.View
Since
vSphere API 7.0

Parameters

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

The ID of the virtual storage object.

Since vSphere API 6.7
datastore PManagedObjectReference
to a Datastore

The datastore where the source virtual storage object is located.

Since vSphere API 6.7
snapshotId PID

The ID of the snapshot of a virtual storage object for which changes that have been made since "changeId" should be computed.

Since vSphere API 6.7
startOffset Pxsd:long

Start Offset in bytes at which to start computing changes. Typically, callers will make multiple calls to this function, starting with startOffset 0 and then examine the "length" property in the returned DiskChangeInfo structure, repeatedly calling queryChangedDiskAreas until a map for the entire virtual disk has been obtained.

Since vSphere API 6.7
changeId Pxsd:string

Identifier referring to a point in the past that should be used as the point in time at which to begin including changes to the disk in the result. A typical use case would be a backup application obtaining a changeId from a virtual disk's backing info when performing a backup. When a subsequent incremental backup is to be performed, this change Id can be used to obtain a list of changed areas on disk.

Since vSphere API 6.7
PRequired privilege - see tooltip for details

Return Value

Type Description
DiskChangeInfoReturns a data structure specifying extents of the virtual disk that have changed since the thime the changeId string was obtained.

Faults

Type Description
FileFaultThrown if the virtual disk files cannot be accessed/queried.
InvalidArgumentThrown if startOffset is beyond the end of the virtual disk or changeId is invalid.
InvalidDatastoreThrown if the operation cannot be performed on the datastore.
InvalidStateThrown if change tracking is not supported for this particular disk.
NotFoundThrown if specified virtual storage object or snapshot 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