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

Name	Type	Description
_this	ManagedObjectReference	A reference to the VirtualDiskManager used to make the method call.
sourceName P	xsd:string	*Since* VI API 2.5
sourceDatacenter* P	ManagedObjectReference to a Datacenter	*Since* VI API 2.5
destName P	xsd:string	*Since* VI API 2.5
destDatacenter* P	ManagedObjectReference to a Datacenter	*Since* VI API 2.5
destSpec* P	VirtualDiskSpec	*Since* VI API 2.5
force* P	xsd: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
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

CreateVirtualDisk_Task

Deprecated.

Required Privileges: System.View

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VirtualDiskManager used to make the method call.
name P	xsd:string	*Since* VI API 2.5
datacenter* P	ManagedObjectReference to a Datacenter	*Since* VI API 2.5
spec P	VirtualDiskSpec	*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
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

DefragmentVirtualDisk_Task

Deprecated.

Required Privileges: System.View

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

name P

xsd:string

Since VI API 2.5

datacenter* P

ManagedObjectReference
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
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

DeleteVirtualDisk_Task

Deprecated.

Required Privileges: System.View

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

name P

xsd:string

Since VI API 2.5

datacenter* P

ManagedObjectReference
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
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

EagerZeroVirtualDisk_Task

Required Privileges: System.View
Since: vSphere API 4.0

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

name P

xsd:string

Since vSphere API 4.0

datacenter* P

ManagedObjectReference
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
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

ExtendVirtualDisk_Task

Deprecated.

Required Privileges: System.View

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VirtualDiskManager used to make the method call.
name P	xsd:string	*Since* VI API 2.5
datacenter* P	ManagedObjectReference to a Datacenter	*Since* VI API 2.5
newCapacityKb P	xsd:long	*Since* VI API 2.5
eagerZero* P	xsd: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
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

ImportUnmanagedSnapshot

Required Privileges: System.View
Since: vSphere API 6.0

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VirtualDiskManager used to make the method call.
vdisk P	xsd:string	*Since* vSphere API 6.0
datacenter* P	ManagedObjectReference to a Datacenter	*Since* vSphere API 6.0
vvolId P	xsd: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
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

InflateVirtualDisk_Task

Deprecated.

Required Privileges: System.View

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

name P

xsd:string

Since VI API 2.5

datacenter* P

ManagedObjectReference
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
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

MoveVirtualDisk_Task

Required Privileges: System.View

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VirtualDiskManager used to make the method call.
sourceName P	xsd:string	*Since* VI API 2.5
sourceDatacenter* P	ManagedObjectReference to a Datacenter	*Since* VI API 2.5
destName P	xsd:string	*Since* VI API 2.5
destDatacenter* P	ManagedObjectReference to a Datacenter	*Since* VI API 2.5
force* P	xsd:boolean	*Since* VI API 2.5
profile* P	VirtualMachineProfileSpec[]	*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
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

QueryVirtualDiskFragmentation

Required Privileges: System.View

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

name P

xsd:string

Since VI API 2.5

datacenter* P

ManagedObjectReference
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
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

QueryVirtualDiskGeometry

Required Privileges: System.View

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

name P

xsd:string

Since VI API 2.5

datacenter* P

ManagedObjectReference
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
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

QueryVirtualDiskUuid

Deprecated.

Required Privileges: System.View

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

name P

xsd:string

Since VI API 2.5

datacenter* P

ManagedObjectReference
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
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

ReleaseManagedSnapshot

Required Privileges: System.View
Since: vSphere API 6.5

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

vdisk P

xsd:string

Since vSphere API 6.5

datacenter* P

ManagedObjectReference
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
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

SetVirtualDiskUuid

Deprecated.

Required Privileges: System.View

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VirtualDiskManager used to make the method call.
name P	xsd:string	*Since* VI API 2.5
datacenter* P	ManagedObjectReference to a Datacenter	*Since* VI API 2.5
uuid P	xsd: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
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

ShrinkVirtualDisk_Task

Deprecated.

Required Privileges: System.View

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VirtualDiskManager used to make the method call.
name P	xsd:string	*Since* VI API 2.5
datacenter* P	ManagedObjectReference to a Datacenter	*Since* VI API 2.5
copy* P	xsd: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
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

ZeroFillVirtualDisk_Task

Required Privileges: System.View

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

name P

xsd:string

Since VI API 2.5

datacenter* P

ManagedObjectReference
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
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