| Local Methods | ||
Managed Object Types | Data Object Types | All Properties | All Methods |
Properties
Name | Type | Description |
---|---|---|
None | ||
Properties inherited from VStorageObjectManagerBase | ||
None |
Methods
Requires privilege InventoryService.Tagging.AttachTag on root folder
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VcenterVStorageObjectManager used to make the method call. |
id P | ID |
The identifier(ID) of the virtual storage object.
Since vSphere API 6.5 |
category P | xsd:string |
The category to which the tag belongs.
Since vSphere API 6.5 |
tag P | xsd:string |
The tag which has to be associated with the virtual storage
object.
Since vSphere API 6.5 |
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. |
Events
Type | |
---|---|
None |
Requires Datastore.FileManagement privilege on both source and destination datastore.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VcenterVStorageObjectManager used to make the method call. |
id P | ID |
The ID of the virtual storage object.
Since vSphere API 6.7 |
datastore P | ManagedObjectReference
to a Datastore |
The datastore where the source virtual storage
object is located.
Since vSphere API 6.7 |
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 vSphere API 6.7 |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
InvalidDatastore | Thrown if the operation cannot be performed on the datastore. |
InvalidState | Thrown if the operation cannot be performed on the disk. The disk may be consumed. |
NotFound | Thrown if specified virtual storage object cannot be found. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Requires Datastore.FileManagement privilege on both source and destination datastore.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VcenterVStorageObjectManager used to make the method call. |
id P | ID |
The ID of the virtual storage object.
Since vSphere API 6.5 |
datastore P | ManagedObjectReference
to a Datastore |
The datastore where the source virtual storage object
is located.
Since vSphere API 6.5 |
spec P | VslmCloneSpec |
The specification for cloning the virtual storage
object.
Since vSphere API 6.5 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task |
Faults
Type | Description |
---|---|
FileFault | Thrown if an error occurs while cloning the virtual storage object. |
InvalidDatastore | Thrown if the operation cannot be performed on the datastore. |
NotFound | Thrown if specified virtual storage object cannot be found. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Requires Datastore.FileManagement privilege on the datastore where the virtual disk object is created.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VcenterVStorageObjectManager used to make the method call. |
spec P | VslmCreateSpec |
The specification of the virtual storage object
to be created.
Since vSphere API 6.5 |
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 |
---|---|
FileFault | Thrown if an error occurs when creating the virtual disk. |
InvalidDatastore | Thrown if the operation cannot be performed on the datastore. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Requires Datastore.FileManagement privilege.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VcenterVStorageObjectManager used to make the method call. |
id P | ID |
The ID of the virtual storage object.
Since vSphere API 6.7 |
datastore P | ManagedObjectReference
to a Datastore |
The datastore where the source virtual storage object
is located.
Since vSphere API 6.7 |
snapshotId P | ID |
The ID of the snapshot of the virtual storage object.
Since vSphere API 6.7 |
name P | xsd:string |
A user friendly name to be associated with the new disk.
Since vSphere API 6.7 |
profile* P | VirtualMachineProfileSpec[] |
SPBM Profile requirement on the new virtual storage object.
If not specified datastore default policy would be
assigned.
Since vSphere API 6.7 |
crypto* P | CryptoSpec |
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* 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 vSphere API 6.7 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task |
Faults
Type | Description |
---|---|
FileFault | Thrown if an error occurs while snapshotting the virtual storage object. |
InvalidDatastore | Thrown if the operation cannot be performed on the datastore. |
InvalidState | Thrown if the operation cannot be performed on the disk. |
NotFound | Thrown if specified virtual storage object cannot be found. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Requires Datastore.FileManagement privilege.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VcenterVStorageObjectManager used to make the method call. |
id P | ID |
The ID of the virtual storage object.
Since vSphere API 6.7 |
datastore P | ManagedObjectReference
to a Datastore |
The datastore where the source virtual storage object
is located.
Since vSphere API 6.7 |
snapshotId P | ID |
The ID of the snapshot of a virtual storage object.
Since vSphere API 6.7 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task |
Faults
Type | Description |
---|---|
FileFault | Thrown if an error occurs while snapshotting the virtual storage object. |
InvalidDatastore | Thrown if the operation cannot be performed on the datastore. |
InvalidState | Thrown if the operation cannot be performed on the disk. |
NotFound | Thrown if specified virtual storage object cannot be found. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Requires Datastore.FileManagement privilege on the datastore where the virtual storage object is located.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VcenterVStorageObjectManager used to make the method call. |
id P | ID |
The ID of the virtual storage object to be deleted.
Since vSphere API 6.5 |
datastore P | ManagedObjectReference
to a Datastore |
The datastore where the virtual storage object
is located.
Since vSphere API 6.5 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task | This method returns a Task object with which to monitor the operation. |
Faults
Type | Description |
---|---|
FileFault | Thrown if an error occurs when deleting the virtual storage object. |
InvalidDatastore | Thrown if the operation cannot be performed on the datastore. |
InvalidState | Thrown if the operation cannot be performed on the disk. The disk may be consumed and cannot be deleted. |
NotFound | Thrown if the specified virtual storage object cannot be found. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
TaskInProgress | Thrown if the virtual storage object is busy. |
Events
Type | |
---|---|
None |
Requires Datastore.FileManagement privilege on the datastore where the virtual storage object is located.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VcenterVStorageObjectManager used to make the method call. |
id P | ID |
The ID of the virtual storage object to be deleted.
Since vSphere API 7.0.2.0 |
datastore P | ManagedObjectReference
to a Datastore |
The datastore where the virtual storage object
is located.
Since vSphere API 7.0.2.0 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task |
Faults
Type | Description |
---|---|
FileFault | Thrown if an error occurs when deleting the virtual storage object. |
InvalidDatastore | Thrown if the operation cannot be performed on the datastore. |
InvalidState | Thrown if the operation cannot be performed on the disk. The disk may be consumed and cannot be deleted. |
NotFound | Thrown if the specified virtual storage object cannot be found. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
TaskInProgress | Thrown if the virtual storage object is busy. |
Events
Type | |
---|---|
None |
Requires privilege InventoryService.Tagging.AttachTag on root folder
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VcenterVStorageObjectManager used to make the method call. |
id P | ID |
The identifier(ID) of the virtual storage object.
Since vSphere API 6.5 |
category P | xsd:string |
The category to which the tag belongs.
Since vSphere API 6.5 |
tag P | xsd:string |
The tag which has to be disassociated with the virtual storage
object.
Since vSphere API 6.5 |
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. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VcenterVStorageObjectManager used to make the method call. |
id P | ID |
The ID of the virtual disk to be extended.
Since vSphere API 6.5 |
datastore P | ManagedObjectReference
to a Datastore |
The datastore where the virtual disk is located.
Since vSphere API 6.5 |
newCapacityInMB P | xsd:long |
The new capacity of the virtual disk in MB.
Since vSphere API 6.5 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task | This method returns a Task object with which to monitor the operation. |
Faults
Type | Description |
---|---|
FileFault | Thrown if an error occurs while extending the virtual disk. |
InvalidDatastore | Thrown if the operation cannot be performed on the datastore. |
InvalidState | Thrown if the operation cannot be performed on the disk. The disk may be consumed and cannot be extended. |
NotFound | Thrown if the specified virtual storage object cannot be found. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
TaskInProgress | Thrown if the virtual storage object is busy. |
Events
Type | |
---|---|
None |
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.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VcenterVStorageObjectManager used to make the method call. |
id P | ID |
The ID of the virtual disk to be inflated.
Since vSphere API 6.5 |
datastore P | ManagedObjectReference
to a Datastore |
The datastore where the virtual disk is located.
Since vSphere API 6.5 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task | This method returns a Task object with which to monitor the operation. |
Faults
Type | Description |
---|---|
FileFault | Thrown if an error occurs while inflating the virtual disk. |
InvalidDatastore | Thrown if the operation cannot be performed on the datastore. |
InvalidState | Thrown if the operation cannot be performed on the disk. The disk may be consumed and cannot be extended. |
NotFound | Thrown if the specified virtual storage object cannot be found. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
TaskInProgress | Thrown if the virtual storage object is busy. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VcenterVStorageObjectManager used to make the method call. |
id P | ID |
The ID of the virtual storage object.
Since vSphere API 6.5 |
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. |
Events
Type | |
---|---|
None |
Requires Datastore.FileManagement privilege on the datastore where the virtual storage object is located.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VcenterVStorageObjectManager used to make the method call. |
datastore P | ManagedObjectReference
to a Datastore |
The datastore to query for the virtual storage objects.
Since vSphere API 6.5 |
Return Value
Type | Description |
---|---|
ID[] | The list of IDs of the virtual storage objects located on the datastore. |
Faults
Type | Description |
---|---|
InvalidDatastore | Thrown if the operation cannot be performed on the datastore, such as datastore cannot be found or is inaccessible. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VcenterVStorageObjectManager used to make the method call. |
category P | xsd:string |
The category to which the tag belongs.
Since vSphere API 6.5 |
tag P | xsd:string |
The tag to be queried.
Since vSphere API 6.5 |
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. |
Events
Type | |
---|---|
None |
Requires Datastore.FileManagement privilege.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VcenterVStorageObjectManager used to make the method call. |
datastore P | ManagedObjectReference
to a Datastore |
The datastore that needs to be reconciled.
Since vSphere API 6.5 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task |
Faults
Type | Description |
---|---|
InvalidDatastore | Thrown if the operation cannot be performed on the datastore. |
NotFound | |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Requires Datastore.FileManagement privilege on the datastore where the virtual disk resides.
See vim.vslm.BaseConfigInfo.name
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VcenterVStorageObjectManager used to make the method call. |
path P | xsd:string |
URL path to the virtual disk. See vim.vslm.BaseConfigInfo.name Since vSphere API 6.5 |
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 vSphere API 6.5 |
Return Value
Type | Description |
---|---|
VStorageObject | The registered virtual storage object for the disk. |
Faults
Type | Description |
---|---|
AlreadyExists | Thrown if disk is already registered as a virtual storage object. See vim.vslm.BaseConfigInfo.name |
FileFault | Thrown if an error occurs while registering the virtual disk. See vim.vslm.BaseConfigInfo.name |
InvalidDatastore | Thrown if datastore cannot be found or the operation cannot be performed on the datastore. See vim.vslm.BaseConfigInfo.name |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Requires Datastore.FileManagement privilege on both source and destination datastore.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VcenterVStorageObjectManager used to make the method call. |
id P | ID |
The ID of the virtual storage object.
Since vSphere API 6.5 |
datastore P | ManagedObjectReference
to a Datastore |
The datastore where the source virtual storage object
is located.
Since vSphere API 6.5 |
spec P | VslmRelocateSpec |
The specification for relocation of the virtual
storage object.
Since vSphere API 6.5 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task |
Faults
Type | Description |
---|---|
FileFault | Thrown if an error occurs while relocating the virtual storage object. |
InvalidDatastore | Thrown if the operation cannot be performed on the datastore. |
InvalidState | Thrown if the operation cannot be performed on the disk. The disk may be consumed and cannot be relocated. |
NotFound | Thrown if specified virtual storage object cannot be found. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VcenterVStorageObjectManager used to make the method call. |
id P | ID |
The ID of the virtual storage object to be renamed.
Since vSphere API 6.5 |
datastore P | ManagedObjectReference
to a Datastore |
The datastore where the virtual storage object is
located.
Since vSphere API 6.5 |
name P | xsd:string |
The new name for the virtual storage object.
Since vSphere API 6.5 |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
FileFault | Thrown if an error occurs while renaming the virtual storage object. |
InvalidDatastore | Thrown if the operation cannot be performed on the datastore. |
NotFound | Thrown if the specified virtual storage object cannot be found. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VcenterVStorageObjectManager used to make the method call. |
id P | ID |
The ID of the virtual storage object.
Since vSphere API 6.7 |
datastore P | ManagedObjectReference
to a Datastore |
The datastore where the source virtual storage object
is located.
Since vSphere API 6.7 |
snapshotId P | ID |
The ID of the snapshot of a virtual storage object.
Since vSphere API 6.7 |
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. |
Events
Type | |
---|---|
None |
Requires Datastore.FileManagement privilege.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VcenterVStorageObjectManager used to make the method call. |
id P | ID |
The ID of the virtual storage object.
Since vSphere API 6.7 |
datastore P | ManagedObjectReference
to a Datastore |
The datastore where the source virtual storage object
is located.
Since vSphere API 6.7 |
Return Value
Type | Description |
---|---|
VStorageObjectSnapshotInfo |
Faults
Type | Description |
---|---|
FileFault | Thrown if an error occurs while snapshotting the virtual storage object. |
InvalidDatastore | Thrown if the operation cannot be performed on the datastore. |
InvalidState | Thrown if the operation cannot be performed on the disk. |
NotFound | Thrown if specified virtual storage object cannot be found. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Requires Datastore.FileManagement privilege on the datastore where the virtual storage infrastructure object is located.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VcenterVStorageObjectManager used to make the method call. |
datastore P | ManagedObjectReference
to a Datastore |
Datastore on which policy needs to be retrieved.
Since vSphere API 6.7 |
Return Value
Type | Description |
---|---|
vslmInfrastructureObjectPolicy[] | The policy object of virtual storage object. |
Faults
Type | Description |
---|---|
InvalidDatastore | Thrown if the operation cannot be performed on the datastore. |
InvalidState | Thrown if the operation cannot be performed on the disk. |
NotFound | Thrown if specified virtual storage object cannot be found. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Requires Datastore.FileManagement privilege on the datastore where the virtual storage object is located.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VcenterVStorageObjectManager used to make the method call. |
id P | ID |
The ID of the virtual storage object to be retrieved.
Since vSphere API 6.5 |
datastore P | ManagedObjectReference
to a Datastore |
The datastore where the virtual storage object is
located.
Since vSphere API 6.5 |
Return Value
Type | Description |
---|---|
VStorageObject | The required virtual storage object. |
Faults
Type | Description |
---|---|
FileFault | Thrown if an error occurs when retrieving the virtual object. |
InvalidDatastore | Thrown if the operation cannot be performed on the datastore. |
NotFound | Thrown if specified virtual storage object cannot be found. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VcenterVStorageObjectManager used to make the method call. |
ids* P | RetrieveVStorageObjSpec[] |
The IDs of the virtual storage objects of the query.
Since vSphere API 6.7 |
Return Value
Type | Description |
---|---|
VStorageObjectAssociations[] | The list of VStorageObjectVmAssociations which provides virtual storage object 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 |
Requires Datastore.FileManagement privilege on the datastore where the virtual storage object is located.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VcenterVStorageObjectManager used to make the method call. |
id P | ID |
The ID of the virtual storage object the state to be retrieved.
Since vSphere API 6.5 |
datastore P | ManagedObjectReference
to a Datastore |
The datastore where the virtual storage object is
located.
Since vSphere API 6.5 |
Return Value
Type | Description |
---|---|
VStorageObjectStateInfo | The required virtual storage object state. |
Faults
Type | Description |
---|---|
FileFault | Thrown if an error occurs when retrieving the virtual object state. |
InvalidDatastore | Thrown if the operation cannot be performed on the datastore. |
NotFound | Thrown if specified virtual storage object cannot be found. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
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.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VcenterVStorageObjectManager used to make the method call. |
id P | ID |
The ID of the virtual storage object.
Since vSphere API 6.7 |
datastore P | ManagedObjectReference
to a Datastore |
The datastore where the source virtual storage object
is located.
Since vSphere API 6.7 |
snapshotId P | ID |
The ID of the snapshot of a virtual storage object.
Since vSphere API 6.7 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task |
Faults
Type | Description |
---|---|
FileFault | Thrown if an error occurs while snapshotting the virtual storage object. |
InvalidDatastore | Thrown if the operation cannot be performed on the datastore. |
InvalidState | Thrown if the operation cannot be performed on the disk. |
NotFound | Thrown if specified virtual storage object cannot be found. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Requires Datastore.FileManagement privilege.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VcenterVStorageObjectManager used to make the method call. |
datastore P | ManagedObjectReference
to a Datastore |
The datastore that needs to be reconciled.
Since vSphere API 6.5 |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
InvalidDatastore | Thrown if the operation cannot be performed on the datastore. |
NotFound | |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Requires Datastore.FileManagement privilege on both source and destination datastore.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VcenterVStorageObjectManager used to make the method call. |
id P | ID |
The ID of the virtual storage object.
Since vSphere API 6.7 |
datastore P | ManagedObjectReference
to a Datastore |
The datastore where the source virtual storage
object is located.
Since vSphere API 6.7 |
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 vSphere API 6.7 |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
InvalidDatastore | Thrown if the operation cannot be performed on the datastore. |
InvalidState | Thrown if the operation cannot be performed on the disk. The disk may be consumed. |
NotFound | Thrown if specified virtual storage object cannot be found. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Requires Datastore.FileManagement privilege on the datastore where the virtual storage infrastructure object is located.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VcenterVStorageObjectManager used to make the method call. |
spec P | vslmInfrastructureObjectPolicySpec |
specification to assign a SPBM policy to virtual storage
infrastructure object.
Since vSphere API 6.7 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task |
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 |
Events
Type | |
---|---|
None |
Requires Datastore.FileManagement privilege on the datastore where the virtual storage object is located.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VcenterVStorageObjectManager used to make the method call. |
id P | ID |
The ID of the virtual storage object.
Since vSphere API 7.0 |
datastore P | ManagedObjectReference
to a Datastore |
The datastore where the virtual storage object is
located.
Since vSphere API 7.0 |
profile* P | VirtualMachineProfileSpec[] |
New profile requirement on the virtual storage object.
Since vSphere API 7.0 |
disksCrypto* P | DiskCryptoSpec |
The crypto information of each disk on the chain.
Since vSphere API 7.0 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task | This method returns a Task object with which to monitor the operation. |
Faults
Type | Description |
---|---|
FileFault | Thrown if an error occurs while 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. |
Events
Type | |
---|---|
None |
Requires Datastore.FileManagement privilege on the datastore where the virtual storage object is located.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VcenterVStorageObjectManager used to make the method call. |
id P | ID |
The ID of the virtual storage object.
Since vSphere API 6.7 |
datastore P | ManagedObjectReference
to a Datastore |
The datastore where the virtual storage object is
located.
Since vSphere API 6.7 |
profile* P | VirtualMachineProfileSpec[] |
New profile requirement on the virtual storage object.
Since vSphere API 6.7 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task | This method returns a Task object with which to monitor the operation. |
Faults
Type | Description |
---|---|
FileFault | Thrown if an error occurs while 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. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VcenterVStorageObjectManager used to make the method call. |
id P | ID |
The ID of the virtual storage object.
Since vSphere API 7.0.2.0 |
datastore P | ManagedObjectReference
to a Datastore |
The datastore to query for the virtual storage objects.
Since vSphere API 7.0.2.0 |
metadata* P | KeyValue[] |
array of key/value strings. (keys must be unique
within the list)
Since vSphere API 7.0.2.0 |
deleteKeys* P | xsd:string[] |
array of keys need to be deleted
Since vSphere API 7.0.2.0 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task |
Faults
Type | Description |
---|---|
InvalidDatastore | Thrown if the operation cannot be performed on the datastore, such as datastore cannot be found or is inaccessible. |
InvalidState | Thrown if the operation cannot be performed on the disk. |
NotFound | Thrown if specified virtual storage object cannot be found. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Requires Datastore.FileManagement privilege.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VcenterVStorageObjectManager used to make the method call. |
id P | ID |
The ID of the virtual storage object.
Since vSphere API 6.7 |
datastore P | ManagedObjectReference
to a Datastore |
The datastore where the source virtual storage object
is located.
Since vSphere API 6.7 |
description P | xsd:string |
A short description to be associated with the snapshot.
Since vSphere API 6.7 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task |
Faults
Type | Description |
---|---|
FileFault | Thrown if an error occurs while snapshotting the virtual storage object. |
InvalidDatastore | Thrown if the operation cannot be performed on the datastore. |
InvalidState | Thrown if the operation cannot be performed on the disk. |
NotFound | Thrown if specified virtual storage object cannot be found. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
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.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VcenterVStorageObjectManager used to make the method call. |
id P | ID |
The ID of the virtual storage object.
Since vSphere API 6.7 |
datastore P | ManagedObjectReference
to a Datastore |
The datastore where the source virtual storage object
is located.
Since vSphere API 6.7 |
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 vSphere API 6.7 |
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 vSphere API 6.7 |
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 vSphere API 6.7 |
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. |
Events
Type | |
---|---|
None |
Top of page | Local Methods | ||
Managed Object Types | Data Object Types | All Properties | All Methods |