| Local Methods | ||
Managed Object Types | Data Object Types | All Properties | All Methods |
Properties
Name | Type | Description |
---|---|---|
None | ||
Properties inherited from VStorageObjectManagerBase | ||
None |
Methods
Requires Datastore.FileManagement privilege on both source and destination datastore.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HostVStorageObjectManager used to make the method call. |
id | ID |
The ID of the virtual storage object.
|
datastore | ManagedObjectReference
to a Datastore |
The datastore where the source virtual storage
object is located.
|
controlFlags* | xsd:string[] |
control flags enum array to be cleared on the
VStorageObject. All control flags not included
in the array remain intact.
|
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 HostVStorageObjectManager used to make the method call. |
id | ID |
The ID of the virtual storage object.
|
datastore | ManagedObjectReference
to a Datastore |
The datastore where the source virtual storage
object is located.
|
spec | VslmCloneSpec |
The specification for cloning the virtual storage
object.
|
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task |
Faults
Type | Description |
---|---|
FileFault | Thrown if an error occurs while cloning the virtual storage object. |
InvalidDatastore | Thrown if the operation cannot be performed on the datastore. |
NotFound | Thrown if specified virtual storage object cannot be found. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Requires Datastore.FileManagement privilege on the datastore where the virtual disk object is created.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HostVStorageObjectManager used to make the method call. |
spec | VslmCreateSpec |
The specification of the virtual storage object
to be created.
2
|
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task | This method returns a Task object with which to monitor the operation. The info.result property in the Task contains the newly created VStorageObject upon success. |
Faults
Type | Description |
---|---|
FileFault | Thrown if an error occurs when creating the virtual disk. |
InvalidDatastore | Thrown if the operation cannot be performed on the datastore. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Requires Datastore.FileManagement privilege on the datastore where the virtual storage object is located.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HostVStorageObjectManager used to make the method call. |
id | ID |
The ID of the virtual storage object to be deleted.
|
datastore | ManagedObjectReference
to a Datastore |
The datastore where the virtual storage object is
located.
|
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task | This method returns a Task object with which to monitor the operation. |
Faults
Type | Description |
---|---|
FileFault | Thrown if an error occurs when deleting the virtual storage object. |
InvalidDatastore | Thrown if the operation cannot be performed on the datastore. |
InvalidState | Thrown if the operation cannot be performed on the disk. The disk may be consumed and cannot be deleted. |
NotFound | Thrown if the specified virtual storage object cannot be found. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
TaskInProgress | Thrown if the virtual storage object is busy. |
Events
Type | |
---|---|
None |
Requires Datastore.FileManagement privilege on the datastore where the virtual storage object is located.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HostVStorageObjectManager used to make the method call. |
id | ID |
The ID of the virtual disk to be extended.
|
datastore | ManagedObjectReference
to a Datastore |
The datastore where the virtual disk is located.
|
newCapacityInMB | xsd:long |
The new capacity of the virtual disk in MB.
|
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task | This method returns a Task object with which to monitor the operation. |
Faults
Type | Description |
---|---|
FileFault | Thrown if an error occurs while extending the virtual disk. |
InvalidDatastore | Thrown if the operation cannot be performed on the datastore. |
InvalidState | Thrown if the operation cannot be performed on the disk. The disk may be consumed and cannot be extended. |
NotFound | Thrown if the specified virtual storage object cannot be found. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
TaskInProgress | Thrown if the virtual storage object is busy. |
Events
Type | |
---|---|
None |
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 HostVStorageObjectManager used to make the method call. |
id | ID |
The ID of the virtual disk to be inflated.
|
datastore | ManagedObjectReference
to a Datastore |
The datastore where the virtual disk is located.
|
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task | This method returns a Task object with which to monitor the operation. |
Faults
Type | Description |
---|---|
FileFault | Thrown if an error occurs while inflating the virtual disk. |
InvalidDatastore | Thrown if the operation cannot be performed on the datastore. |
InvalidState | Thrown if the operation cannot be performed on the disk. The disk may be consumed and cannot be extended. |
NotFound | Thrown if the specified virtual storage object cannot be found. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
TaskInProgress | Thrown if the virtual storage object is busy. |
Events
Type | |
---|---|
None |
Requires Datastore.FileManagement privilege on the datastore where the virtual storage object is located.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HostVStorageObjectManager used to make the method call. |
datastore | ManagedObjectReference
to a Datastore |
The datastore to query for the virtual storage objects.
|
Return Value
Type | Description |
---|---|
ID[] | The list of IDs of the virtual storage objects located on the datastore. |
Faults
Type | Description |
---|---|
InvalidDatastore | Thrown if the operation cannot be performed on the datastore, such as datastore cannot be found or inaccessible. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Requires Datastore.FileManagement privilege.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HostVStorageObjectManager used to make the method call. |
datastore | ManagedObjectReference
to a Datastore |
The datastore that needs to be reconciled.
|
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task |
Faults
Type | Description |
---|---|
InvalidDatastore | Thrown if the operation cannot be performed on the datastore. |
NotFound | |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
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 HostVStorageObjectManager used to make the method call. |
path | xsd:string |
URL or datastore path to the virtual disk. See vim.vslm.BaseConfigInfo.name |
name* | xsd:string |
The descriptive name of the disk object. If
unset the name will be automatically determined
from the path. See vim.vslm.BaseConfigInfo.name |
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 HostVStorageObjectManager used to make the method call. |
id | ID |
The ID of the virtual storage object.
|
datastore | ManagedObjectReference
to a Datastore |
The datastore where the source virtual storage
object is located.
|
spec | VslmRelocateSpec |
The specification for relocation of the virtual
storage object.
|
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task |
Faults
Type | Description |
---|---|
FileFault | Thrown if an error occurs while relocating the virtual storage object. |
InvalidDatastore | Thrown if the operation cannot be performed on the datastore. |
InvalidState | Thrown if the operation cannot be performed on the disk. The disk may be consumed and cannot be relocated. |
NotFound | Thrown if specified virtual storage object cannot be found. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Requires Datastore.FileManagement privilege on the datastore where the virtual storage object is located.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HostVStorageObjectManager used to make the method call. |
id | ID |
The ID of the virtual storage object to be renamed.
|
datastore | ManagedObjectReference
to a Datastore |
The datastore where the virtual storage object is
located.
|
name | xsd:string |
The new name for the virtual storage object.
|
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
FileFault | Thrown if an error occurs while renaming the virtual storage object. |
InvalidDatastore | Thrown if the operation cannot be performed on the datastore. |
NotFound | Thrown if the specified virtual storage object cannot be found. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Requires Datastore.FileManagement privilege on the datastore specified.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HostVStorageObjectManager used to make the method call. |
datastore | ManagedObjectReference
to a Datastore |
Datastore on which policy needs to be retrieved.
|
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 HostVStorageObjectManager used to make the method call. |
id | ID |
The ID of the virtual storage object to be retrieved.
|
datastore | ManagedObjectReference
to a Datastore |
The datastore where the virtual storage object is
located.
|
Return Value
Type | Description |
---|---|
VStorageObject | The required virtual storage object. |
Faults
Type | Description |
---|---|
FileFault | Thrown if an error occurs when retrieving the virtual object. |
InvalidDatastore | Thrown if the operation cannot be performed on the datastore. |
NotFound | Thrown if specified virtual storage object cannot be found. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Requires Datastore.FileManagement privilege on the datastore where the virtual storage object is located.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HostVStorageObjectManager used to make the method call. |
id | ID |
The ID of the virtual storage object the state to be retrieved.
|
datastore | ManagedObjectReference
to a Datastore |
The datastore where the virtual storage object is
located.
|
Return Value
Type | Description |
---|---|
VStorageObjectStateInfo | The required virtual storage object state. |
Faults
Type | Description |
---|---|
FileFault | Thrown if an error occurs when retrieving the virtual object state. |
InvalidDatastore | Thrown if the operation cannot be performed on the datastore. |
NotFound | Thrown if specified virtual storage object cannot be found. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Requires Datastore.FileManagement privilege.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HostVStorageObjectManager used to make the method call. |
datastore | ManagedObjectReference
to a Datastore |
The datastore that needs to be reconciled.
|
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
InvalidDatastore | Thrown if the operation cannot be performed on the datastore. |
NotFound | |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Requires Datastore.FileManagement privilege on both source and destination datastore.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HostVStorageObjectManager used to make the method call. |
id | ID |
The ID of the virtual storage object.
|
datastore | ManagedObjectReference
to a Datastore |
The datastore where the source virtual storage
object is located.
|
controlFlags* | xsd:string[] |
control flags enum array to be set on the
VStorageObject. All control flags not included
in the array remain intact.
|
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HostVStorageObjectManager used to make the method call. |
id | ID |
The ID of the virtual storage object.
|
datastore | ManagedObjectReference
to a Datastore |
The datastore where the source virtual storage object
is located.
|
snapshotId | ID |
The ID of the snapshot of the virtual storage object.
|
name | xsd:string |
A user friendly name to be associated with the new disk.
|
profile* | VirtualMachineProfileSpec[] |
SPBM Profile requirement on the new virtual storage object.
If not specified datastore default policy would be
assigned.
|
crypto* | CryptoSpec |
Crypto information of the new disk.
|
path* | xsd:string |
Relative location in the specified datastore where disk needs
to be created. If not specified disk gets created at defualt
VStorageObject location on the specified datastore
|
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HostVStorageObjectManager used to make the method call. |
id | ID |
The ID of the virtual storage object.
|
datastore | ManagedObjectReference
to a Datastore |
The datastore where the source virtual storage object
is located.
|
description | xsd:string |
A short description to be associated with the snapshot.
|
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HostVStorageObjectManager used to make the method call. |
id | ID |
The ID of the virtual storage object.
|
datastore | ManagedObjectReference
to a Datastore |
The datastore where the source virtual storage object
is located.
|
snapshotId | ID |
The ID of the snapshot of a virtual storage object.
|
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HostVStorageObjectManager used to make the method call. |
id | ID |
The ID of the virtual storage object.
|
datastore | ManagedObjectReference
to a Datastore |
The datastore where the source virtual storage object
is located.
|
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 |
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
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HostVStorageObjectManager used to make the method call. |
id | ID |
The ID of the virtual storage object.
|
datastore | ManagedObjectReference
to a Datastore |
The datastore where the source virtual storage object
is located.
|
snapshotId | ID |
The ID of the snapshot of a virtual storage object.
|
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 |
Top of page | Local Methods | ||
Managed Object Types | Data Object Types | All Properties | All Methods |