Managed Object - VirtualDiskManager

Property of
ServiceContent
See also
Datacenter, HostDiskDimensionsChs, VirtualDiskSpec, VirtualMachineProfileSpec
Since
VI API 2.5


Managed Object Description

Properties

Name Type Description
None

Methods

Methods defined in this Managed Object
CopyVirtualDisk_Task, CreateVirtualDisk_Task, DefragmentVirtualDisk_Task, DeleteVirtualDisk_Task, EagerZeroVirtualDisk_Task, ExtendVirtualDisk_Task, ImportUnmanagedSnapshot, InflateVirtualDisk_Task, MoveVirtualDisk_Task, QueryVirtualDiskFragmentation, QueryVirtualDiskGeometry, QueryVirtualDiskUuid, ReleaseManagedSnapshot, SetVirtualDiskUuid, ShrinkVirtualDisk_Task, ZeroFillVirtualDisk_Task

CopyVirtualDisk_Task

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualDiskManager used to make the method call.
sourceName Pxsd:string

Since VI API 2.5
sourceDatacenter* PManagedObjectReference
to a Datacenter

Since VI API 2.5
destName Pxsd:string

Since VI API 2.5
destDatacenter* PManagedObjectReference
to a Datacenter

Since VI API 2.5
destSpec* PVirtualDiskSpec

Since VI API 2.5
force* Pxsd:boolean

Since VI API 2.5
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
FileFault
InvalidDatastore
InvalidDiskFormat
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



CreateVirtualDisk_Task

Deprecated.

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualDiskManager used to make the method call.
name Pxsd:string

Since VI API 2.5
datacenter* PManagedObjectReference
to a Datacenter

Since VI API 2.5
spec PVirtualDiskSpec

Since VI API 2.5
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
FileFault
InvalidDatastore
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



DefragmentVirtualDisk_Task

Deprecated.

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualDiskManager used to make the method call.
name Pxsd:string

Since VI API 2.5
datacenter* PManagedObjectReference
to a Datacenter

Since VI API 2.5
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
FileFault
InvalidDatastore
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



DeleteVirtualDisk_Task

Deprecated.

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualDiskManager used to make the method call.
name Pxsd:string

Since VI API 2.5
datacenter* PManagedObjectReference
to a Datacenter

Since VI API 2.5
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
FileFault
InvalidDatastore
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



EagerZeroVirtualDisk_Task

Required Privileges
System.View
Since
vSphere API 4.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualDiskManager used to make the method call.
name Pxsd:string

Since vSphere API 4.0
datacenter* PManagedObjectReference
to a Datacenter

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

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
FileFault
InvalidDatastore
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



ExtendVirtualDisk_Task

Deprecated.

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualDiskManager used to make the method call.
name Pxsd:string

Since VI API 2.5
datacenter* PManagedObjectReference
to a Datacenter

Since VI API 2.5
newCapacityKb Pxsd:long

Since VI API 2.5
eagerZero* Pxsd:boolean

Since VI API 2.5
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
FileFault
InvalidDatastore
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



ImportUnmanagedSnapshot

Required Privileges
System.View
Since
vSphere API 6.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualDiskManager used to make the method call.
vdisk Pxsd:string

Since vSphere API 6.0
datacenter* PManagedObjectReference
to a Datacenter

Since vSphere API 6.0
vvolId Pxsd:string

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

Return Value

Type Description
None

Faults

Type Description
InvalidDatastore
NotFound
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



InflateVirtualDisk_Task

Deprecated.

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualDiskManager used to make the method call.
name Pxsd:string

Since VI API 2.5
datacenter* PManagedObjectReference
to a Datacenter

Since VI API 2.5
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
FileFault
InvalidDatastore
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



MoveVirtualDisk_Task

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualDiskManager used to make the method call.
sourceName Pxsd:string

Since VI API 2.5
sourceDatacenter* PManagedObjectReference
to a Datacenter

Since VI API 2.5
destName Pxsd:string

Since VI API 2.5
destDatacenter* PManagedObjectReference
to a Datacenter

Since VI API 2.5
force* Pxsd:boolean

Since VI API 2.5
profile* PVirtualMachineProfileSpec[]

Since VI API 2.5
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
FileFault
InvalidDatastore
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



QueryVirtualDiskFragmentation

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualDiskManager used to make the method call.
name Pxsd:string

Since VI API 2.5
datacenter* PManagedObjectReference
to a Datacenter

Since VI API 2.5
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
xsd:int

Faults

Type Description
FileFault
InvalidDatastore
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



QueryVirtualDiskGeometry

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualDiskManager used to make the method call.
name Pxsd:string

Since VI API 2.5
datacenter* PManagedObjectReference
to a Datacenter

Since VI API 2.5
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
HostDiskDimensionsChs

Faults

Type Description
FileFault
InvalidDatastore
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



QueryVirtualDiskUuid

Deprecated.

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualDiskManager used to make the method call.
name Pxsd:string

Since VI API 2.5
datacenter* PManagedObjectReference
to a Datacenter

Since VI API 2.5
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
xsd:string

Faults

Type Description
FileFault
InvalidDatastore
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



ReleaseManagedSnapshot

Required Privileges
System.View
Since
vSphere API 6.5

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualDiskManager used to make the method call.
vdisk Pxsd:string

Since vSphere API 6.5
datacenter* PManagedObjectReference
to a Datacenter

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

Return Value

Type Description
None

Faults

Type Description
FileNotFound
InvalidDatastore
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



SetVirtualDiskUuid

Deprecated.

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualDiskManager used to make the method call.
name Pxsd:string

Since VI API 2.5
datacenter* PManagedObjectReference
to a Datacenter

Since VI API 2.5
uuid Pxsd:string

Since VI API 2.5
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

Type Description
FileFault
InvalidDatastore
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



ShrinkVirtualDisk_Task

Deprecated.

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualDiskManager used to make the method call.
name Pxsd:string

Since VI API 2.5
datacenter* PManagedObjectReference
to a Datacenter

Since VI API 2.5
copy* Pxsd:boolean

Since VI API 2.5
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
FileFault
InvalidDatastore
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None



ZeroFillVirtualDisk_Task

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualDiskManager used to make the method call.
name Pxsd:string

Since VI API 2.5
datacenter* PManagedObjectReference
to a Datacenter

Since VI API 2.5
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
FileFault
InvalidDatastore
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None