Managed Object - VcenterVStorageObjectManager

Extends
VStorageObjectManagerBase
See also
CryptoSpec, Datastore, DiskChangeInfo, DiskCryptoSpec, ID, KeyValue, RetrieveVStorageObjSpec, VirtualMachineProfileSpec, VslmCloneSpec, VslmCreateSpec, vslmInfrastructureObjectPolicy, vslmInfrastructureObjectPolicySpec, VslmRelocateSpec, VslmTagEntry, vslmVClockInfo, VStorageObject, VStorageObjectAssociations, VStorageObjectSnapshotDetails, VStorageObjectSnapshotInfo, VStorageObjectStateInfo
Since
vSphere API 6.5


Managed Object Description

Properties

Name Type Description
None
Properties inherited from VStorageObjectManagerBase
None

Methods

Methods defined in this Managed Object
AttachTagToVStorageObject, ClearVStorageObjectControlFlags, CloneVStorageObject_Task, CreateDisk_Task, CreateDiskFromSnapshot_Task, DeleteSnapshot_Task, DeleteVStorageObject_Task, DeleteVStorageObjectEx_Task, DetachTagFromVStorageObject, ExtendDisk_Task, InflateDisk_Task, ListTagsAttachedToVStorageObject, ListVStorageObject, ListVStorageObjectsAttachedToTag, ReconcileDatastoreInventory_Task, RegisterDisk, RelocateVStorageObject_Task, RenameVStorageObject, RetrieveSnapshotDetails, RetrieveSnapshotInfo, RetrieveVStorageInfrastructureObjectPolicy, RetrieveVStorageObject, RetrieveVStorageObjectAssociations, RetrieveVStorageObjectState, RevertVStorageObject_Task, ScheduleReconcileDatastoreInventory, SetVStorageObjectControlFlags, UpdateVStorageInfrastructureObjectPolicy_Task, UpdateVStorageObjectCrypto_Task, UpdateVStorageObjectPolicy_Task, VCenterUpdateVStorageObjectMetadataEx_Task, VStorageObjectCreateSnapshot_Task, VstorageObjectVCenterQueryChangedDiskAreas
Methods inherited from VStorageObjectManagerBase
None

AttachTagToVStorageObject

Required Privileges
System.Read

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VcenterVStorageObjectManager used to make the method call.
id PID

Since vSphere API 6.5
category Pxsd:string

Since vSphere API 6.5
tag Pxsd:string

Since vSphere API 6.5
PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

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



ClearVStorageObjectControlFlags

Required Privileges
System.View
Since
vSphere API 6.7

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VcenterVStorageObjectManager used to make the method call.
id PID

Since vSphere API 6.7
datastore PManagedObjectReference
to a Datastore

Since vSphere API 6.7
controlFlags* Pxsd:string[]

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

Return Value

Type Description
None

Faults

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



CloneVStorageObject_Task

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VcenterVStorageObjectManager used to make the method call.
id PID

Since vSphere API 6.5
datastore PManagedObjectReference
to a Datastore

Since vSphere API 6.5
spec PVslmCloneSpec

Since vSphere API 6.5
PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

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



CreateDisk_Task

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VcenterVStorageObjectManager used to make the method call.
spec PVslmCreateSpec

Since vSphere API 6.5
P Required privilege: spec

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



CreateDiskFromSnapshot_Task

Required Privileges
System.View
Since
vSphere API 6.7

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VcenterVStorageObjectManager used to make the method call.
id PID

Since vSphere API 6.7
datastore PManagedObjectReference
to a Datastore

Since vSphere API 6.7
snapshotId PID

Since vSphere API 6.7
name Pxsd:string

Since vSphere API 6.7
profile* PVirtualMachineProfileSpec[]

Since vSphere API 6.7
crypto* PCryptoSpec

Since vSphere API 6.7
path* Pxsd:string

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

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
FileFault
InvalidDatastore
InvalidState
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



DeleteSnapshot_Task

Required Privileges
System.View
Since
vSphere API 6.7

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VcenterVStorageObjectManager used to make the method call.
id PID

Since vSphere API 6.7
datastore PManagedObjectReference
to a Datastore

Since vSphere API 6.7
snapshotId PID

Since vSphere API 6.7
PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
FileFault
InvalidDatastore
InvalidState
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



DeleteVStorageObject_Task

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VcenterVStorageObjectManager used to make the method call.
id PID

Since vSphere API 6.5
datastore PManagedObjectReference
to a Datastore

Since vSphere API 6.5
PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
FileFault
InvalidDatastore
InvalidState
NotFound
RuntimeFaultThrown 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



DeleteVStorageObjectEx_Task

Required Privileges
System.View
Since
vSphere API 7.0.2.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VcenterVStorageObjectManager used to make the method call.
id PID

Since vSphere API 7.0.2.0
datastore PManagedObjectReference
to a Datastore

Since vSphere API 7.0.2.0
PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
FileFault
InvalidDatastore
InvalidState
NotFound
RuntimeFaultThrown 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



DetachTagFromVStorageObject

Required Privileges
System.Read

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VcenterVStorageObjectManager used to make the method call.
id PID

Since vSphere API 6.5
category Pxsd:string

Since vSphere API 6.5
tag Pxsd:string

Since vSphere API 6.5
PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

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



ExtendDisk_Task

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VcenterVStorageObjectManager used to make the method call.
id PID

Since vSphere API 6.5
datastore PManagedObjectReference
to a Datastore

Since vSphere API 6.5
newCapacityInMB Pxsd:long

Since vSphere API 6.5
PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
FileFault
InvalidDatastore
InvalidState
NotFound
RuntimeFaultThrown 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



InflateDisk_Task

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VcenterVStorageObjectManager used to make the method call.
id PID

Since vSphere API 6.5
datastore PManagedObjectReference
to a Datastore

Since vSphere API 6.5
PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
FileFault
InvalidDatastore
InvalidState
NotFound
RuntimeFaultThrown 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



ListTagsAttachedToVStorageObject

Required Privileges
System.Read

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VcenterVStorageObjectManager used to make the method call.
id PID

Since vSphere API 6.5
P Required privilege: id

Return Value

Type Description
VslmTagEntry[]

Faults

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



ListVStorageObject

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VcenterVStorageObjectManager used to make the method call.
datastore PManagedObjectReference
to a Datastore

Since vSphere API 6.5
P Required privilege: datastore

Return Value

Type Description
ID[]

Faults

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



ListVStorageObjectsAttachedToTag

Required Privileges
System.Read

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VcenterVStorageObjectManager used to make the method call.
category Pxsd:string

Since vSphere API 6.5
tag Pxsd:string

Since vSphere API 6.5
PRequired privilege - see tooltip for details

Return Value

Type Description
ID[]

Faults

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



ReconcileDatastoreInventory_Task

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VcenterVStorageObjectManager used to make the method call.
datastore PManagedObjectReference
to a Datastore

Since vSphere API 6.5
P Required privilege: datastore

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

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



RegisterDisk

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VcenterVStorageObjectManager used to make the method call.
path Pxsd:string

Since vSphere API 6.5
name* Pxsd:string

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

Return Value

Type Description
VStorageObject

Faults

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



RelocateVStorageObject_Task

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VcenterVStorageObjectManager used to make the method call.
id PID

Since vSphere API 6.5
datastore PManagedObjectReference
to a Datastore

Since vSphere API 6.5
spec PVslmRelocateSpec

Since vSphere API 6.5
PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
FileFault
InvalidDatastore
InvalidState
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



RenameVStorageObject

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VcenterVStorageObjectManager used to make the method call.
id PID

Since vSphere API 6.5
datastore PManagedObjectReference
to a Datastore

Since vSphere API 6.5
name Pxsd:string

Since vSphere API 6.5
PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

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



RetrieveSnapshotDetails

Required Privileges
System.View
Since
vSphere API 7.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VcenterVStorageObjectManager used to make the method call.
id PID

Since vSphere API 6.7
datastore PManagedObjectReference
to a Datastore

Since vSphere API 6.7
snapshotId PID

Since vSphere API 6.7
PRequired privilege - see tooltip for details

Return Value

Type Description
VStorageObjectSnapshotDetails

Faults

Type Description
FileFault
InvalidDatastore
InvalidState
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



RetrieveSnapshotInfo

Required Privileges
System.View
Since
vSphere API 6.7

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VcenterVStorageObjectManager used to make the method call.
id PID

Since vSphere API 6.7
datastore PManagedObjectReference
to a Datastore

Since vSphere API 6.7
PRequired privilege - see tooltip for details

Return Value

Type Description
VStorageObjectSnapshotInfo

Faults

Type Description
FileFault
InvalidDatastore
InvalidState
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



RetrieveVStorageInfrastructureObjectPolicy

Required Privileges
System.View
Since
vSphere API 6.7

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VcenterVStorageObjectManager used to make the method call.
datastore PManagedObjectReference
to a Datastore

Since vSphere API 6.7
P Required privilege: datastore

Return Value

Type Description
vslmInfrastructureObjectPolicy[]

Faults

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



RetrieveVStorageObject

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VcenterVStorageObjectManager used to make the method call.
id PID

Since vSphere API 6.5
datastore PManagedObjectReference
to a Datastore

Since vSphere API 6.5
diskInfoFlags* Pxsd:string[]

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

Return Value

Type Description
VStorageObject

Faults

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



RetrieveVStorageObjectAssociations

Required Privileges
System.View
Since
vSphere API 6.7

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VcenterVStorageObjectManager used to make the method call.
ids* PRetrieveVStorageObjSpec[]

Since vSphere API 6.7
*Need not be set P Required privilege: ids

Return Value

Type Description
VStorageObjectAssociations[]

Faults

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



RetrieveVStorageObjectState

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VcenterVStorageObjectManager used to make the method call.
id PID

Since vSphere API 6.5
datastore PManagedObjectReference
to a Datastore

Since vSphere API 6.5
PRequired privilege - see tooltip for details

Return Value

Type Description
VStorageObjectStateInfo

Faults

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



RevertVStorageObject_Task

Required Privileges
System.View
Since
vSphere API 6.7

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VcenterVStorageObjectManager used to make the method call.
id PID

Since vSphere API 6.7
datastore PManagedObjectReference
to a Datastore

Since vSphere API 6.7
snapshotId PID

Since vSphere API 6.7
PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
FileFault
InvalidDatastore
InvalidState
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



ScheduleReconcileDatastoreInventory

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VcenterVStorageObjectManager used to make the method call.
datastore PManagedObjectReference
to a Datastore

Since vSphere API 6.5
P Required privilege: datastore

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



SetVStorageObjectControlFlags

Required Privileges
System.View
Since
vSphere API 6.7

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VcenterVStorageObjectManager used to make the method call.
id PID

Since vSphere API 6.7
datastore PManagedObjectReference
to a Datastore

Since vSphere API 6.7
controlFlags* Pxsd:string[]

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

Return Value

Type Description
None

Faults

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



UpdateVStorageInfrastructureObjectPolicy_Task

Required Privileges
System.View
Since
vSphere API 6.7

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VcenterVStorageObjectManager used to make the method call.
spec PvslmInfrastructureObjectPolicySpec

Since vSphere API 6.7
P Required privilege: spec

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
InvalidDatastore
InvalidState
NotFound
RuntimeFaultThrown 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



UpdateVStorageObjectCrypto_Task

Required Privileges
System.View
Since
vSphere API 7.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VcenterVStorageObjectManager used to make the method call.
id PID

Since vSphere API 7.0
datastore PManagedObjectReference
to a Datastore

Since vSphere API 7.0
profile* PVirtualMachineProfileSpec[]

Since vSphere API 7.0
disksCrypto* PDiskCryptoSpec

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

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
FileFault
InvalidDatastore
NotFound
RuntimeFaultThrown 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



UpdateVStorageObjectPolicy_Task

Required Privileges
System.View
Since
vSphere API 6.7

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VcenterVStorageObjectManager used to make the method call.
id PID

Since vSphere API 6.7
datastore PManagedObjectReference
to a Datastore

Since vSphere API 6.7
profile* PVirtualMachineProfileSpec[]

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

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
FileFault
InvalidDatastore
NotFound
RuntimeFaultThrown 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



VCenterUpdateVStorageObjectMetadataEx_Task

Required Privileges
System.View
Since
vSphere API 7.0.2.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VcenterVStorageObjectManager used to make the method call.
id PID

Since vSphere API 7.0.2.0
datastore PManagedObjectReference
to a Datastore

Since vSphere API 7.0.2.0
metadata* PKeyValue[]

Since vSphere API 7.0.2.0
deleteKeys* Pxsd:string[]

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

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

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



VStorageObjectCreateSnapshot_Task

Required Privileges
System.View
Since
vSphere API 6.7

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VcenterVStorageObjectManager used to make the method call.
id PID

Since vSphere API 6.7
datastore PManagedObjectReference
to a Datastore

Since vSphere API 6.7
description Pxsd:string

Since vSphere API 6.7
PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
FileFault
InvalidDatastore
InvalidState
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



VstorageObjectVCenterQueryChangedDiskAreas

Required Privileges
System.View
Since
vSphere API 7.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VcenterVStorageObjectManager used to make the method call.
id PID

Since vSphere API 6.7
datastore PManagedObjectReference
to a Datastore

Since vSphere API 6.7
snapshotId PID

Since vSphere API 6.7
startOffset Pxsd:long

Since vSphere API 6.7
changeId Pxsd:string

Since vSphere API 6.7
PRequired privilege - see tooltip for details

Return Value

Type Description
DiskChangeInfo

Faults

Type Description
FileFault
InvalidArgument
InvalidDatastore
InvalidState
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