Managed Object - VStorageObjectManagerBase(vim.vslm.VStorageObjectManagerBase)

Property of: ServiceContent
Extended by: HostVStorageObjectManager, VcenterVStorageObjectManager
See also: Datastore, ID, vslmVClockInfo, VStorageObjectSnapshot
Since: vSphere API 6.5

Managed Object Description

Base interface to manage virtual storage object.

Properties

Name	Type	Description
None

Methods

Methods defined in this Managed Object
RenameVStorageObjectEx, RevertVStorageObjectEx_Task, VStorageObjectCreateSnapshotEx_Task, VStorageObjectDeleteSnapshotEx_Task, VStorageObjectExtendDiskEx_Task

RenameVStorageObjectEx(renameVStorageObjectEx)

Rename a virtual storage object.

Required Privileges: System.View
Since: 8.0.2.0

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VStorageObjectManagerBase used to make the method call.
id P	ID	The ID of the virtual storage object to be renamed. *Since* 8.0.2.0
datastore P	ManagedObjectReference to a Datastore	The datastore where the virtual storage object is located. *Since* 8.0.2.0
name P	xsd:string	The new name for the virtual storage object. *Since* 8.0.2.0

PRequired privilege - see tooltip for details

Return Value

Type	Description
vslmVClockInfo	The vclock info of this operation

Faults

Type	Description
FileFault	Thrown if an error occurs while renaming the virtual storage object.
InvalidDatastore	Thrown if the operation cannot be performed on the datastore.
NotFound	Thrown if the specified virtual storage object cannot be found.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="RenameVStorageObjectEx" type="vim25:RenameVStorageObjectExRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="RenameVStorageObjectExResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vim25:vslmVClockInfo"/>
                     </sequence>
                  </complexType>
               </element>

RevertVStorageObjectEx_Task(revertVStorageObjectEx)

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

E.g. Consider Disk with 4 snapshots

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

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

BaseDisk -> Snap-2 -> Running-Point

Requires Datastore.FileManagement privilege.

Required Privileges: System.View
Since: 8.0.2.0

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VStorageObjectManagerBase used to make the method call.
id P	ID	The ID of the virtual storage object. *Since* 8.0.2.0
datastore P	ManagedObjectReference to a Datastore	The datastore where the source virtual storage object is located. *Since* 8.0.2.0
snapshotId P	ID	The ID of the snapshot of a virtual storage object. *Since* 8.0.2.0

PRequired privilege - see tooltip for details

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

VStorageObjectCreateSnapshotEx_Task(createSnapshotEx)

Creates a snapshot of a given VStorageObject.

Requires Datastore.FileManagement privilege.

Required Privileges: System.View
Since: 8.0.2.0

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VStorageObjectManagerBase used to make the method call.
id P	ID	The ID of the virtual storage object. *Since* 8.0.2.0
datastore P	ManagedObjectReference to a Datastore	The datastore where the source virtual storage object is located. *Since* 8.0.2.0
description P	xsd:string	A short description to be associated with the snapshot. *Since* 8.0.2.0

PRequired privilege - see tooltip for details

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

VStorageObjectDeleteSnapshotEx_Task(deleteSnapshotEx)

Deletes a given snapshot of a VStorageObject.

Requires Datastore.FileManagement privilege.

Required Privileges: System.View
Since: 8.0.2.0

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VStorageObjectManagerBase used to make the method call.
id P	ID	The ID of the virtual storage object. *Since* 8.0.2.0
datastore P	ManagedObjectReference to a Datastore	The datastore where the source virtual storage object is located. *Since* 8.0.2.0
snapshotId P	ID	The ID of the snapshot of a virtual storage object. *Since* 8.0.2.0

PRequired privilege - see tooltip for details

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

VStorageObjectExtendDiskEx_Task(extendDiskEx)

Expand the capacity of a virtual disk, which is a storage object with vim.vslm.VStorageObject.ConsumptionType#disk, to the new capacity. If new capacity is smaller than current disk capacity, then operation fails due to invalid capacity. If new capacity is greater than current disk capacity, then operation proceeds. If new capacity is equal to current disk ccapcity, then operation succeeds without any actual extension. The extended disk region will be the same as the original disk: - For a zerothick disk, the extended disk region will be zeroedthick. - For an eagerzerothick disk, the extended disk region will be eagerzeroedthick - A thin-provisioned disk will always be extended as a thin-provisioned disk.

Required Privileges: System.View
Since: 8.0.2.0

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VStorageObjectManagerBase used to make the method call.
id P	ID	The ID of the virtual disk to be extended. *Since* 8.0.2.0
datastore P	ManagedObjectReference to a Datastore	The datastore where the virtual disk is located. *Since* 8.0.2.0
newCapacityInMB P	xsd:long	The new capacity of the virtual disk in MB. *Since* 8.0.2.0

PRequired privilege - see tooltip for details

Return Value

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

Faults

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