Managed Object - VslmVStorageObjectManager(vslm.vso.VStorageObjectManager)

Property of: VslmServiceInstanceContent
See also: CryptoSpec, Datastore, DiskChangeInfo, DiskCryptoSpec, ID, KeyValue, VirtualMachine, VirtualMachineProfileSpec, VslmCloneSpec, VslmCreateSpec, VslmDatastoreSyncStatus, vslmInfrastructureObjectPolicy, vslmInfrastructureObjectPolicySpec, VslmRelocateSpec, VslmTagEntry, VslmVsoVStorageObjectAssociations, VslmVsoVStorageObjectQueryResult, VslmVsoVStorageObjectQuerySpec, VslmVsoVStorageObjectResult, VStorageObject, VStorageObjectSnapshotDetails, VStorageObjectSnapshotInfo, VStorageObjectStateInfo
Since: VSLM API 6.7.2

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

Methods

Methods defined in this Managed Object
VslmAttachDisk_Task, VslmAttachTagToVStorageObject, VslmClearVStorageObjectControlFlags, VslmCloneVStorageObject_Task, VslmCreateDisk_Task, VslmCreateDiskFromSnapshot_Task, VslmCreateSnapshot_Task, VslmDeleteSnapshot_Task, VslmDeleteVStorageObject_Task, VslmDetachTagFromVStorageObject, VslmExtendDisk_Task, VslmInflateDisk_Task, VslmListTagsAttachedToVStorageObject, VslmListVStorageObjectForSpec, VslmListVStorageObjectsAttachedToTag, VslmQueryChangedDiskAreas, VslmQueryGlobalCatalogSyncStatus, VslmQueryGlobalCatalogSyncStatusForDatastore, VslmReconcileDatastoreInventory_Task, VslmRegisterDisk, VslmRelocateVStorageObject_Task, VslmRenameVStorageObject, VslmRetrieveSnapshotDetails, VslmRetrieveSnapshotInfo, VslmRetrieveVStorageInfrastructureObjectPolicy, VslmRetrieveVStorageObject, VslmRetrieveVStorageObjectAssociations, VslmRetrieveVStorageObjectMetadata, VslmRetrieveVStorageObjectMetadataValue, VslmRetrieveVStorageObjects, VslmRetrieveVStorageObjectState, VslmRevertVStorageObject_Task, VslmScheduleReconcileDatastoreInventory, VslmSetVStorageObjectControlFlags, VslmUpdateVStorageInfrastructureObjectPolicy_Task, VslmUpdateVstorageObjectCrypto_Task, VslmUpdateVStorageObjectMetadata_Task, VslmUpdateVstorageObjectPolicy_Task

Methods defined in this Managed Object

VslmAttachDisk_Task, VslmAttachTagToVStorageObject, VslmClearVStorageObjectControlFlags, VslmCloneVStorageObject_Task, VslmCreateDisk_Task, VslmCreateDiskFromSnapshot_Task, VslmCreateSnapshot_Task, VslmDeleteSnapshot_Task, VslmDeleteVStorageObject_Task, VslmDetachTagFromVStorageObject, VslmExtendDisk_Task, VslmInflateDisk_Task, VslmListTagsAttachedToVStorageObject, VslmListVStorageObjectForSpec, VslmListVStorageObjectsAttachedToTag, VslmQueryChangedDiskAreas, VslmQueryGlobalCatalogSyncStatus, VslmQueryGlobalCatalogSyncStatusForDatastore, VslmReconcileDatastoreInventory_Task, VslmRegisterDisk, VslmRelocateVStorageObject_Task, VslmRenameVStorageObject, VslmRetrieveSnapshotDetails, VslmRetrieveSnapshotInfo, VslmRetrieveVStorageInfrastructureObjectPolicy, VslmRetrieveVStorageObject, VslmRetrieveVStorageObjectAssociations, VslmRetrieveVStorageObjectMetadata, VslmRetrieveVStorageObjectMetadataValue, VslmRetrieveVStorageObjects, VslmRetrieveVStorageObjectState, VslmRevertVStorageObject_Task, VslmScheduleReconcileDatastoreInventory, VslmSetVStorageObjectControlFlags, VslmUpdateVStorageInfrastructureObjectPolicy_Task, VslmUpdateVstorageObjectCrypto_Task, VslmUpdateVStorageObjectMetadata_Task, VslmUpdateVstorageObjectPolicy_Task

VslmAttachDisk_Task(attachDisk)

Attach an existing disk to this virtual machine. A minimum virtual machine version of 'vmx-13' is required for this operation to succeed. If a compatible VM version is not satisfied, a DeviceUnsupportedForVmVersion fault will be thrown.

VslmSyncFault will set in the task error if the the FCD was attached successfully in the backend, however, there was a failure in syncing the datastore or FCD. The attach disk operation is not idempotent, implying, any attempt to re-attach the FCD to the same VM would cause an error. The sync fault can be ignored safely as Pandora DB does not track FCDs attached to VMs as of vSphere 7.0.

Required Privileges: VirtualMachine.Config.AddExistingDisk

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VslmVStorageObjectManager used to make the method call.
id P	ID	The ID of the virtual disk to be operated. See ID *Since* VSLM API 6.7.2
vm P	ManagedObjectReference to a VirtualMachine	The virtual machine where the virtual disk is to be attached. *Since* VSLM API 6.7.2
controllerKey* P	xsd:int	Key of the controller the disk will connect to. It can be unset if there is only one controller (SCSI or SATA) with the available slot in the virtual machine. If there are multiple SCSI or SATA controllers available, user must specify the controller; if there is no available controllers, a MissingController fault will be thrown. *Since* VSLM API 6.7.2
unitNumber* P	xsd:int	The unit number of the attached disk on its controller. If unset, the next available slot on the specified controller or the only available controller will be assigned to the attached disk. *Since* VSLM API 6.7.2

*Need not be set PRequired privilege - see tooltip for details

Return Value

Type	Description
ManagedObjectReference to a VslmTask

Faults

Type	Description
DeviceUnsupportedForVmVersion	Thrown if the virtual machine's version is incompatible for the given device.
FileFault	Thrown if there is a problem creating or accessing the virtual machine's files for this operation.
InvalidController	Thrown if the specified controller cannot be found or the specified unitNumber is already taken, or the controller has no free slots.
InvalidDatastore	Thrown if the datastore cannot be found or inaccessible.
InvalidState	Thrown if the operation cannot be performed in the current state of the virtual machine. For example, because the virtual machine's configuration is not available.
MissingController	Thrown if the virtual machine has no or more than one available controllers when controllerKey is unset.
NotFound	Thrown if the disk 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.
VmConfigFault	Thrown if the virtual machine's configuration is invalid.
VslmFault	Thrown if a VSLM internal server error occurred.

Events

Type
None

VslmAttachTagToVStorageObject(attachTagToVStorageObject)

Attach a tag to a virtual storage object.

Requires privilege InventoryService.Tagging.AttachTag on root folder

Required Privileges: System.Read

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VslmVStorageObjectManager used to make the method call.
id P	ID	The identifier(ID) of the virtual storage object. *Since* VSLM API 6.7.2
category P	xsd:string	The category to which the tag belongs. *Since* VSLM API 6.7.2
tag P	xsd:string	The tag which has to be associated with the virtual storage object. *Since* VSLM API 6.7.2

PRequired privilege - see tooltip for details

Return Value

Type	Description
None

Faults

Type	Description
NotFound	Thrown if the specified category or tag 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.
VslmFault	Thrown if a VSLM internal server error occurred.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vslm="urn:vslm" name="VslmAttachTagToVStorageObject" type="vslm:VslmAttachTagToVStorageObjectRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vslm="urn:vslm" name="VslmAttachTagToVStorageObjectResponse">
                  <complexType/>
               </element>

VslmClearVStorageObjectControlFlags(clearVStorageObjectControlFlags)

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

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

Required Privileges: System.View

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

id P

The ID of the virtual storage object.

Since VSLM API 6.7.2

controlFlags* P

xsd:string[]

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

Since VSLM API 6.7.2

*Need not be set PRequired privilege - see tooltip for details

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.
VslmFault	Thrown if a VSLM internal server error occurred.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vslm="urn:vslm" name="VslmClearVStorageObjectControlFlags" type="vslm:VslmClearVStorageObjectControlFlagsRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vslm="urn:vslm" name="VslmClearVStorageObjectControlFlagsResponse">
                  <complexType/>
               </element>

VslmCloneVStorageObject_Task(cloneVStorageObject)

Clone a virtual storage object.

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

VslmSyncFault will set in the task error if the cloneVStorageObject completed successfully but the datastore synchronization failed.

Required Privileges: System.View

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

id P

The ID of the virtual storage object.

Since VSLM API 6.7.2

spec P

VslmCloneSpec

The specification for cloning the virtual storage object.

Since VSLM API 6.7.2

PRequired privilege - see tooltip for details

Return Value

Type	Description
ManagedObjectReference to a VslmTask

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.
VslmFault	Thrown if a VSLM internal server error occurred.

Events

Type
None

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

VslmSyncFault will set in the task error if the createDisk completed successfully in the backed but the datastore synchronization or FCD retrieval failed. The sync fault can be ignored with the risk of Pandora not recognizing the FCD or Pandora DB missing the FCD, consequently, affecting the return of VslmListVStorageObjectForSpec and VslmRetrieveVStorageObjects APIs.

Required Privileges: System.View

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

spec P

VslmCreateSpec

The specification of the virtual storage object to be created.

Since VSLM API 6.7.2

P Required privilege: spec

Return Value

Type	Description
ManagedObjectReference to a VslmTask	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
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.
VslmFault	Thrown if a VSLM internal server error occurred.

Events

Type
None

VslmCreateDiskFromSnapshot_Task(createDiskFromSnapshot)

Creates a new Disk from given snapshot of a VStorageObject.

Requires Datastore.FileManagement privilege.

VslmSyncFault will set in the task error if the createDiskFromSnapshot completed successfully but the datastore synchronization failed.

Required Privileges: System.View

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VslmVStorageObjectManager used to make the method call.
id P	ID	The ID of the virtual storage object. *Since* VSLM API 6.7.2
snapshotId P	ID	The ID of the snapshot of the virtual storage object. *Since* VSLM API 6.7.2
name P	xsd:string	A user friendly name to be associated with the new disk. *Since* VSLM API 6.7.2
profile* P	VirtualMachineProfileSpec[]	SPBM Profile requirement on the new virtual storage object. If not specified datastore default policy would be assigned. *Since* VSLM API 6.7.2
crypto* P	CryptoSpec	Crypto information of the new disk. *Since* VSLM API 6.7.2
path* P	xsd: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* VSLM API 6.7.2

*Need not be set PRequired privilege - see tooltip for details

Return Value

Type	Description
ManagedObjectReference to a VslmTask

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.
VslmFault	Thrown if a VSLM internal server error occurred.

Events

Type
None

VslmCreateSnapshot_Task(createSnapshot)

Creates a snapshot of a given VStorageObject.

Requires Datastore.FileManagement privilege.

Required Privileges: System.View

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

id P

The ID of the virtual storage object.

Since VSLM API 6.7.2

description P

xsd:string

A short description to be associated with the snapshot.

Since VSLM API 6.7.2

PRequired privilege - see tooltip for details

Return Value

Type	Description
ManagedObjectReference to a VslmTask

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.
VslmFault	Thrown if a VSLM internal server error occurred.

Events

Type
None

VslmDeleteSnapshot_Task(deleteSnapshot)

Deletes a given snapshot of a VStorageObject.

Requires Datastore.FileManagement privilege.

Required Privileges: System.View

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

id P

The ID of the virtual storage object.

Since VSLM API 6.7.2

snapshotId P

The ID of the snapshot of a virtual storage object.

Since VSLM API 6.7.2

PRequired privilege - see tooltip for details

Return Value

Type	Description
ManagedObjectReference to a VslmTask

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.
VslmFault	Thrown if a VSLM internal server error occurred.

Events

Type
None

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

VslmSyncFault will set in the task error if the delete of the FCD succeeded in the backend, however, there was a issue with syncing the datastore. The error can be ignored with the anticipation of Pandora resolving this automatically and the risk of Pandora DB having stale FCDs consequently affecting the return of VslmListVStorageObjectForSpec and VslmRetrieveVStorageObjects APIs. Any subsequent operation on the FCD is guranteed to fail.

Required Privileges: System.View

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

id P

The ID of the virtual storage object to be deleted.

Since VSLM API 6.7.2

P Required privilege: id

Return Value

Type	Description
ManagedObjectReference to a VslmTask	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.
VslmFault	Thrown if a VSLM internal server error occurred.

Events

Type
None

VslmDetachTagFromVStorageObject(detachTagFromVStorageObject)

Detach a tag from a virtual storage object.

Requires privilege InventoryService.Tagging.AttachTag on root folder

Required Privileges: System.Read

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VslmVStorageObjectManager used to make the method call.
id P	ID	The identifier(ID) of the virtual storage object. *Since* VSLM API 6.7.2
category P	xsd:string	The category to which the tag belongs. *Since* VSLM API 6.7.2
tag P	xsd:string	The tag which has to be disassociated with the virtual storage object. *Since* VSLM API 6.7.2

PRequired privilege - see tooltip for details

Return Value

Type	Description
None

Faults

Type	Description
NotFound	Thrown if the specified category or tag 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.
VslmFault	Thrown if a VSLM internal server error occurred.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vslm="urn:vslm" name="VslmDetachTagFromVStorageObject" type="vslm:VslmDetachTagFromVStorageObjectRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vslm="urn:vslm" name="VslmDetachTagFromVStorageObjectResponse">
                  <complexType/>
               </element>

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

VslmSyncFault will set in the task error if the extendDisk completed successfully but the datastore synchronization failed.

Required Privileges: System.View

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

id P

The ID of the virtual disk to be extended.

Since VSLM API 6.7.2

newCapacityInMB P

xsd:long

The new capacity of the virtual disk in MB.

Since VSLM API 6.7.2

PRequired privilege - see tooltip for details

Return Value

Type	Description
ManagedObjectReference to a VslmTask	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.
VslmFault	Thrown if a VSLM internal server error occurred.

Events

Type
None

VslmInflateDisk_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

Name

Type

Description

_this

ManagedObjectReference

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

id P

The ID of the virtual disk to be inflated.

Since VSLM API 6.7.2

P Required privilege: id

Return Value

Type	Description
ManagedObjectReference to a VslmTask	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.
VslmFault	Thrown if a VSLM internal server error occurred.

Events

Type
None

VslmListTagsAttachedToVStorageObject(listTagsAttachedToVStorageObject)

Lists all tags attached to virtual storage object.

Required Privileges: System.Read

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

id P

The ID of the virtual storage object.

Since VSLM API 6.7.2

P Required privilege: id

Return Value

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

Faults

Type	Description
NotFound	Thrown if the specified category or tag 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.
VslmFault	Thrown if a VSLM internal server error occurred.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vslm="urn:vslm" name="VslmListTagsAttachedToVStorageObject" type="vslm:VslmListTagsAttachedToVStorageObjectRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vslm="urn:vslm" name="VslmListTagsAttachedToVStorageObjectResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vslm:VslmTagEntry" minOccurs="0" maxOccurs="unbounded"/>
                     </sequence>
                  </complexType>
               </element>

VslmListVStorageObjectForSpec(listVStorageObjectsForSpec)

List virtual storage objects matching all the VslmVsoVStorageObjectQuerySpec. The results are determined by ANDing the VslmVsoVStorageObjectQuerySpec while ORing each of the values specified as a part of the queryValue field. Currently, only a single value in queryValue is supported. Expect that not all results will be returned. If all results are not returned, allRecordsReturned flag will be set to false. Results will be returned in id order. To query for addtional objects, "add ID > last ID returned" to the query and call VslmListVStorageObjectForSpec again.

Required Privileges: System.View

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

query* P

VslmVsoVStorageObjectQuerySpec[]

Query defined using array of VslmVsoVStorageObjectQuerySpec objects.

Since VSLM API 6.7.2

maxResult P

xsd:int

Maximum number of virtual storage object IDs to return.

Since VSLM API 6.7.2

*Need not be set PRequired privilege - see tooltip for details

Return Value

Type	Description
VslmVsoVStorageObjectQueryResult	VslmVsoVStorageObjectQueryResult array containing the list of IDs of the virtual storage objects sorted in ascending order and matching the query.

Faults

Type	Description
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:vslm="urn:vslm" name="VslmListVStorageObjectForSpec" type="vslm:VslmListVStorageObjectForSpecRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vslm="urn:vslm" name="VslmListVStorageObjectForSpecResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vslm:VslmVsoVStorageObjectQueryResult" minOccurs="0"/>
                     </sequence>
                  </complexType>
               </element>

VslmListVStorageObjectsAttachedToTag(listVStorageObjectsAttachedToTag)

Lists all virtual storage objects attached to the tag.

Required Privileges: System.Read

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

category P

xsd:string

The category to which the tag belongs.

Since VSLM API 6.7.2

tag P

xsd:string

The tag to be queried.

Since VSLM API 6.7.2

PRequired privilege - see tooltip for details

Return Value

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

Faults

Type	Description
NotFound	Thrown if the specified category or tag 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.
VslmFault	Thrown if a VSLM internal server error occurred.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vslm="urn:vslm" name="VslmListVStorageObjectsAttachedToTag" type="vslm:VslmListVStorageObjectsAttachedToTagRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vslm="urn:vslm" name="VslmListVStorageObjectsAttachedToTagResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vslm:ID" minOccurs="0" maxOccurs="unbounded"/>
                     </sequence>
                  </complexType>
               </element>

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

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VslmVStorageObjectManager used to make the method call.
id P	ID	The ID of the virtual storage object. *Since* VSLM API 6.7.2
snapshotId P	ID	The ID of the snapshot of a virtual storage object for which changes that have been made since "changeId" should be computed. *Since* VSLM API 6.7.2
startOffset P	xsd: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* VSLM API 6.7.2
changeId P	xsd: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* VSLM API 6.7.2

PRequired privilege - see tooltip for details

Return Value

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

Faults

Type	Description
FileFault	Thrown if the virtual disk files cannot be accessed/queried.
InvalidArgument	Thrown if startOffset is beyond the end of the virtual disk or changeId is invalid.
InvalidDatastore	Thrown if the operation cannot be performed on the datastore.
InvalidState	Thrown if change tracking is not supported for this particular disk.
NotFound	Thrown if specified virtual storage object or snapshot 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.
VslmFault

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vslm="urn:vslm" name="VslmQueryChangedDiskAreas" type="vslm:VslmQueryChangedDiskAreasRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vslm="urn:vslm" name="VslmQueryChangedDiskAreasResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vslm:DiskChangeInfo"/>
                     </sequence>
                  </complexType>
               </element>

VslmQueryGlobalCatalogSyncStatus(queryGlobalCatalogSyncStatus)

Gets the synchronization status of the Global Catalog. This API returns an array of DatastoreSyncStatuses showing the synchronization status for each datastore currently being tracked by the Global Catalog. This can be used to see if the Global Catalog search results are fully up-to-date and also to check if the Global Catalog is making progress on bringing a datastore's information up to date.

Required Privileges: System.View

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VslmVStorageObjectManager used to make the method call.

Return Value

Type	Description
VslmDatastoreSyncStatus[]	s Returns an array of DatastoreSyncStatus, one for each datastore tracked by the global catalog

Faults

Type	Description
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:vslm="urn:vslm" name="VslmQueryGlobalCatalogSyncStatus" type="vslm:VslmQueryGlobalCatalogSyncStatusRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vslm="urn:vslm" name="VslmQueryGlobalCatalogSyncStatusResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vslm:VslmDatastoreSyncStatus" minOccurs="0" maxOccurs="unbounded"/>
                     </sequence>
                  </complexType>
               </element>

VslmQueryGlobalCatalogSyncStatusForDatastore(queryGlobalCatalogSyncStatusForDatastore)

Gets the synchronization state of the Global Catalog for the specified datastore.

Required Privileges: System.View

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

datastoreURL P

xsd:string

URL of the datastore to check synchronization status for

Since VSLM API 6.7.2

P Required privilege: datastoreURL

Return Value

Type	Description
VslmDatastoreSyncStatus	The sync status of the datastore

Faults

Type	Description
NotFound	Thrown if the specified datastore 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.
VslmFault	Thrown if a VSLM internal server error occurred.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vslm="urn:vslm" name="VslmQueryGlobalCatalogSyncStatusForDatastore" type="vslm:VslmQueryGlobalCatalogSyncStatusForDatastoreRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vslm="urn:vslm" name="VslmQueryGlobalCatalogSyncStatusForDatastoreResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vslm:VslmDatastoreSyncStatus" minOccurs="0"/>
                     </sequence>
                  </complexType>
               </element>

VslmReconcileDatastoreInventory_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 VslmVStorageObjectManager used to make the method call.

datastore P

ManagedObjectReference
to a Datastore

The datastore that needs to be reconciled.

Since VSLM API 6.7.2

P Required privilege: datastore

Return Value

Type	Description
ManagedObjectReference to a VslmTask

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.
VslmFault	Thrown if a VSLM internal server error occurred.

Events

Type
None

VslmRegisterDisk(registerDisk)

Promote a virtual disk to a First Class Disk.

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

See vim.vslm.BaseConfigInfo.name

Required Privileges: System.View

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

path P

xsd:string

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

Since VSLM API 6.7.2

name* P

xsd:string

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

Since VSLM API 6.7.2

*Need not be set PRequired privilege - see tooltip for details

Return Value

Type	Description
VStorageObject	The registered virtual storage object for the disk.

Faults

Type	Description
AlreadyExists	Thrown if disk is already registered as a virtual storage object. See vim.vslm.BaseConfigInfo.name
FileFault	Thrown if an error occurs while registering the virtual disk. See vim.vslm.BaseConfigInfo.name
InvalidDatastore	Thrown if datastore cannot be found or the operation cannot be performed on the datastore. See vim.vslm.BaseConfigInfo.name
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
VslmFault	Thrown if a VSLM internal server error occurred. See vim.vslm.BaseConfigInfo.name
VslmSyncFault	Thrown if an error occurs during datastore synchornization, implies the registerDisk completed successfully, however, there was an exception during datastore synchornization. See vim.vslm.BaseConfigInfo.name

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vslm="urn:vslm" name="VslmRegisterDisk" type="vslm:VslmRegisterDiskRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vslm="urn:vslm" name="VslmRegisterDiskResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vslm:VStorageObject"/>
                     </sequence>
                  </complexType>
               </element>

VslmRelocateVStorageObject_Task(relocateVStorageObject)

Relocate a virtual storage object.

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

VslmSyncFault will set in the task error if the relocateVStorageObject completed successfully but the datastore synchronization failed.

Required Privileges: System.View

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

id P

The ID of the virtual storage object.

Since VSLM API 6.7.2

spec P

VslmRelocateSpec

The specification for relocation of the virtual storage object.

Since VSLM API 6.7.2

PRequired privilege - see tooltip for details

Return Value

Type	Description
ManagedObjectReference to a VslmTask

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.
VslmFault	Thrown if a VSLM internal server error occurred.

Events

Type
None

VslmRenameVStorageObject(renameVStorageObject)

Rename a virtual storage object.

VslmSyncFault is thrown when the underlying rename operation of the FCD succeeded, however, there was a issue with syncing the datastore or FCD. Rename operation of the FCD is not idempotent, implying, any attempt to rename the FCD with it's current name would result in a error. The sync fault can be ignored with the risk of Pandora DB having stale name, consequently, affecting the return of VslmListVStorageObjectForSpec and VslmRetrieveVStorageObjects APIs.

Required Privileges: System.View

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

id P

The ID of the virtual storage object to be renamed.

Since VSLM API 6.7.2

name P

xsd:string

The new name for the virtual storage object.

Since VSLM API 6.7.2

PRequired privilege - see tooltip for details

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.
VslmFault	Thrown if a VSLM internal server error occurred.
VslmSyncFault	Thrown if an error occurs during datastore synchornization, implies the renameVStorageObject completed successfully, however, there was an exception during datastore synchornization.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vslm="urn:vslm" name="VslmRenameVStorageObject" type="vslm:VslmRenameVStorageObjectRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vslm="urn:vslm" name="VslmRenameVStorageObjectResponse">
                  <complexType/>
               </element>

VslmRetrieveSnapshotDetails(retrieveSnapshotDetails)

Retrieves snapshot disk details of a given snapshot.

Required Privileges: System.View
Since: VSLM API 6.7.3

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

id P

The ID of the virtual storage object.

Since VSLM API 6.7.2

snapshotId P

The ID of the snapshot of a virtual storage object.

Since VSLM API 6.7.2

PRequired privilege - see tooltip for details

Return Value

Type	Description
VStorageObjectSnapshotDetails

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.
VslmFault	Thrown if a VSLM internal server error occurred.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vslm="urn:vslm" name="VslmRetrieveSnapshotDetails" type="vslm:VslmRetrieveSnapshotDetailsRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vslm="urn:vslm" name="VslmRetrieveSnapshotDetailsResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vslm:VStorageObjectSnapshotDetails"/>
                     </sequence>
                  </complexType>
               </element>

VslmRetrieveSnapshotInfo(retrieveSnapshotInfo)

Retrieves snapshot information of a given VStorageObject.

Requires Datastore.FileManagement privilege.

Required Privileges: System.View

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

id P

The ID of the virtual storage object.

Since VSLM API 6.7.2

P Required privilege: id

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.
VslmFault	Thrown if a VSLM internal server error occurred.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vslm="urn:vslm" name="VslmRetrieveSnapshotInfo" type="vslm:VslmRetrieveSnapshotInfoRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vslm="urn:vslm" name="VslmRetrieveSnapshotInfoResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vslm:VStorageObjectSnapshotInfo"/>
                     </sequence>
                  </complexType>
               </element>

VslmRetrieveVStorageInfrastructureObjectPolicy(retrieveVStorageInfrastructureObjectPolicy)

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

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

datastore P

ManagedObjectReference
to a Datastore

Datastore on which policy needs to be retrieved.

Since VSLM API 6.7.2

P Required privilege: datastore

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.
VslmFault	Thrown if a VSLM internal server error occurred.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vslm="urn:vslm" name="VslmRetrieveVStorageInfrastructureObjectPolicy" type="vslm:VslmRetrieveVStorageInfrastructureObjectPolicyRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vslm="urn:vslm" name="VslmRetrieveVStorageInfrastructureObjectPolicyResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vslm:vslmInfrastructureObjectPolicy" minOccurs="0" maxOccurs="unbounded"/>
                     </sequence>
                  </complexType>
               </element>

VslmRetrieveVStorageObject(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 VslmVStorageObjectManager used to make the method call.

id P

The ID of the virtual storage object to be retrieved.

Since VSLM API 6.7.2

P Required privilege: id

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.
VslmFault	Thrown if a VSLM internal server error occurred.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vslm="urn:vslm" name="VslmRetrieveVStorageObject" type="vslm:VslmRetrieveVStorageObjectRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vslm="urn:vslm" name="VslmRetrieveVStorageObjectResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vslm:VStorageObject"/>
                     </sequence>
                  </complexType>
               </element>

VslmRetrieveVStorageObjectAssociations(retrieveVStorageObjectAssociations)

Retrieve vm associations for each virtual storage object in the query.

Required Privileges: System.View

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

ids* P

ID[]

The IDs of the virtual storage objects of the query.

Since VSLM API 6.7.2

*Need not be set P Required privilege: ids

Return Value

Type	Description
VslmVsoVStorageObjectAssociations[]	The list of VStorageObjectVmAssociations which provides FCD id to vm associations mapping.

Faults

Type	Description
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:vslm="urn:vslm" name="VslmRetrieveVStorageObjectAssociations" type="vslm:VslmRetrieveVStorageObjectAssociationsRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vslm="urn:vslm" name="VslmRetrieveVStorageObjectAssociationsResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vslm:VslmVsoVStorageObjectAssociations" minOccurs="0" maxOccurs="unbounded"/>
                     </sequence>
                  </complexType>
               </element>

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

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VslmVStorageObjectManager used to make the method call.
id P	ID	The ID of the virtual storage object. *Since* VSLM API 6.7.2
snapshotId* P	ID	The ID of the snapshot of virtual storage object. *Since* VSLM API 6.7.2
prefix* P	xsd:string	The prefix of the metadata key that needs to be retrieved *Since* VSLM API 6.7.2

*Need not be set PRequired privilege - see tooltip for details

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.
VslmFault	Thrown if a VSLM internal server error occurred.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vslm="urn:vslm" name="VslmRetrieveVStorageObjectMetadata" type="vslm:VslmRetrieveVStorageObjectMetadataRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vslm="urn:vslm" name="VslmRetrieveVStorageObjectMetadataResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vslm:KeyValue" minOccurs="0" maxOccurs="unbounded"/>
                     </sequence>
                  </complexType>
               </element>

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

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VslmVStorageObjectManager used to make the method call.
id P	ID	The ID of the virtual storage object. *Since* VSLM API 6.7.2
snapshotId* P	ID	The ID of the snapshot of virtual storage object. *Since* VSLM API 6.7.2
key P	xsd:string	The key for the the virtual storage object *Since* VSLM API 6.7.2

*Need not be set PRequired privilege - see tooltip for details

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.
VslmFault	Thrown if a VSLM internal server error occurred.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vslm="urn:vslm" name="VslmRetrieveVStorageObjectMetadataValue" type="vslm:VslmRetrieveVStorageObjectMetadataValueRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vslm="urn:vslm" name="VslmRetrieveVStorageObjectMetadataValueResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="xsd:string"/>
                     </sequence>
                  </complexType>
               </element>

VslmRetrieveVStorageObjects(retrieveVStorageObjects)

Retrieves details of a list of virtual storage objects from cache.

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 VslmVStorageObjectManager used to make the method call.

ids* P

ID[]

The array of IDs of the virtual storage object to be retrieved.

Since VSLM API 6.7.2

*Need not be set P Required privilege: ids

Return Value

Type	Description
VslmVsoVStorageObjectResult[]	The array of vim.vslm.VStorageObjectResult virtual storage objects corresponding to the input.

Faults

Type	Description
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:vslm="urn:vslm" name="VslmRetrieveVStorageObjects" type="vslm:VslmRetrieveVStorageObjectsRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vslm="urn:vslm" name="VslmRetrieveVStorageObjectsResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vslm:VslmVsoVStorageObjectResult" minOccurs="0" maxOccurs="unbounded"/>
                     </sequence>
                  </complexType>
               </element>

VslmRetrieveVStorageObjectState(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 VslmVStorageObjectManager used to make the method call.

id P

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

Since VSLM API 6.7.2

P Required privilege: id

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.
VslmFault	Thrown if a VSLM internal server error occurred.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vslm="urn:vslm" name="VslmRetrieveVStorageObjectState" type="vslm:VslmRetrieveVStorageObjectStateRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vslm="urn:vslm" name="VslmRetrieveVStorageObjectStateResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vslm:VStorageObjectStateInfo"/>
                     </sequence>
                  </complexType>
               </element>

VslmRevertVStorageObject_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

Requires Datastore.FileManagement privilege.

VslmSyncFault will set in the task error if the revertVStorageObject completed successfully but the datastore synchronization failed.

Required Privileges: System.View

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

id P

The ID of the virtual storage object.

Since VSLM API 6.7.2

snapshotId P

The ID of the snapshot of a virtual storage object.

Since VSLM API 6.7.2

PRequired privilege - see tooltip for details

Return Value

Type	Description
ManagedObjectReference to a VslmTask

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.
VslmFault	Thrown if a VSLM internal server error occurred.

Events

Type
None

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

Name

Type

Description

_this

ManagedObjectReference

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

datastore P

ManagedObjectReference
to a Datastore

The datastore that needs to be reconciled.

Since VSLM API 6.7.2

P Required privilege: datastore

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.
VslmFault	Thrown if a VSLM internal server error occurred.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vslm="urn:vslm" name="VslmScheduleReconcileDatastoreInventory" type="vslm:VslmScheduleReconcileDatastoreInventoryRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vslm="urn:vslm" name="VslmScheduleReconcileDatastoreInventoryResponse">
                  <complexType/>
               </element>

VslmSetVStorageObjectControlFlags(setVStorageObjectControlFlags)

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

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

Required Privileges: System.View

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

id P

The ID of the virtual storage object.

Since VSLM API 6.7.2

controlFlags* P

xsd:string[]

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

Since VSLM API 6.7.2

*Need not be set PRequired privilege - see tooltip for details

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.
VslmFault	Thrown if a VSLM internal server error occurred.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vslm="urn:vslm" name="VslmSetVStorageObjectControlFlags" type="vslm:VslmSetVStorageObjectControlFlagsRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vslm="urn:vslm" name="VslmSetVStorageObjectControlFlagsResponse">
                  <complexType/>
               </element>

VslmUpdateVStorageInfrastructureObjectPolicy_Task(updateVStorageInfrastructureObjectPolicy)

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

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

VslmSyncFault will set in the task error if the updateVStorageInfrastructureObjectPolicy completed successfully but the datastore synchronization failed.

Required Privileges: System.View

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

spec P

vslmInfrastructureObjectPolicySpec

specification to assign a SPBM policy to FCD infrastructure object.

Since VSLM API 6.7.2

P Required privilege: spec

Return Value

Type	Description
ManagedObjectReference to a VslmTask

Faults

Type	Description
InvalidDatastore	Thrown if the operation cannot be performed on the datastore.
InvalidState	Thrown if there is issue with profile spec.
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.
TaskInProgress
VslmFault	Thrown if a VSLM internal server error occurred.

Events

Type
None

VslmUpdateVstorageObjectCrypto_Task(updateVStorageObjectCrypto)

Update the storage crypto on a virtual storage object.

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

Required Privileges: None
Since: VSLM API 7.0

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VslmVStorageObjectManager used to make the method call.
id P	ID	The ID of the virtual storage object. *Since* VSLM API 7.0
profile* P	VirtualMachineProfileSpec[]	New profile requirement on the virtual storage object. *Since* VSLM API 7.0
disksCrypto* P	DiskCryptoSpec	The crypto information of each disk on the chain. *Since* VSLM API 7.0

*Need not be set PRequired privilege - see tooltip for details

Return Value

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

Faults

Type	Description
FileFault	Thrown if an error occurs while updating the virtual storage object policy.
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.
TaskInProgress	Thrown if the virtual storage object is busy.
VslmFault	Thrown if a VSLM internal server error occurred.

Events

Type
None

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

VslmSyncFault will set in the task error if the updateVStorageObjectMetadata completed successfully but the datastore synchronization or FCD retrieval failed. The sync fault can be ignored with the risk of Pandora DB having stale metadata information consequently affecting the return of VslmListVStorageObjectForSpec and VslmRetrieveVStorageObjects APIs.

Required Privileges: System.View

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VslmVStorageObjectManager used to make the method call.
id P	ID	The ID of the virtual storage object. *Since* VSLM API 6.7.2
metadata* P	KeyValue[]	array of key/value strings. (keys must be unique within the list) *Since* VSLM API 6.7.2
deleteKeys* P	xsd:string[]	array of keys need to be deleted *Since* VSLM API 6.7.2

*Need not be set PRequired privilege - see tooltip for details

Return Value

Type	Description
ManagedObjectReference to a VslmTask	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.
VslmFault	Thrown if a VSLM internal server error occurred.

Events

Type
None

VslmUpdateVstorageObjectPolicy_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

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

id P

The ID of the virtual storage object.

Since VSLM API 6.7.2

profile* P

VirtualMachineProfileSpec[]

New profile requirement on the virtual storage object.

Since VSLM API 6.7.2

*Need not be set PRequired privilege - see tooltip for details

Return Value

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

Faults

Type	Description
FileFault	Thrown if an error occurs while updating the virtual storage object policy.
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.
TaskInProgress	Thrown if the virtual storage object is busy.
VslmFault	Thrown if a VSLM internal server error occurred.

Events

Type
None