Managed Object - Datastore

Property of
BaseConfigInfoBackingInfo, BatchResult, ClusterComputeResourceVcsSlots, ClusterDasConfigInfo, ClusterDatastoreUpdateSpec, ClusterSystemVMsConfigInfo, ComputeResource, ConverterAgentInternalManagedVMOptions, DasHeartbeatDatastoreInfo, Datacenter, DatastoreEventArgument, DatastoreMountPathDatastorePair, DatastoreSummary, DeltaDiskFormatNotSupported, FaultToleranceDiskSpec, FaultToleranceMetaSpec, FaultToleranceVMConfigSpec, HbrDiskMigrationAction, HostCacheConfigurationInfo, HostCacheConfigurationSpec, HostConfigInfo, HostConfigSummary, HostDatastoreBrowser, HostDatastoreBrowserSearchResults, HostDatastoreSystem, HostDatastoreSystemDatastoreResult, HostEsxAgentHostManagerConfigInfo, HostResignatureRescanResult, HostSystem, InvalidDatastore, IORMNotSupportedHostOnDatastore, LargeRDMNotSupportedOnDatastore, MemorySizeNotSupportedByDatastore, NodeDeploymentSpec, OvfResourceMap, PlacementSpec, QuiesceDatastoreIOForHAFailed, RDMNotSupportedOnDatastore, RetrieveVStorageObjSpec, StorageMigrationAction, StoragePlacementAction, StorageRequirement, StorageVmotionIncompatible, UnsupportedDatastore, VAppCloneSpec, VAppCloneSpecResourceMap, VirtualApp, VirtualDeviceFileBackingInfo, VirtualMachine, VirtualMachineRelocateSpec, VirtualMachineRelocateSpecDiskLocator, VirtualMachineUsageOnDatastore, VslmCreateSpecBackingSpec, vslmInfrastructureObjectPolicySpec
Parameter to
AttachDisk_Task, ClearVStorageObjectControlFlags, CloneVStorageObject_Task, ConfigureDatastoreIORM_Task, CreateDirectory, CreateDiskFromSnapshot_Task, CreateImportSpec, DeleteSnapshot_Task, DeleteVStorageObject_Task, DeleteVStorageObjectEx_Task, DisableClusteredVmdkSupport, EnableClusteredVmdkSupport, ExpandVmfsDatastore, ExtendDisk_Task, ExtendVmfsDatastore, HostClearVStorageObjectControlFlags, HostCloneVStorageObject_Task, HostDeleteVStorageObject_Task, HostDeleteVStorageObjectEx_Task, HostExtendDisk_Task, HostInflateDisk_Task, HostListVStorageObject, HostReconcileDatastoreInventory_Task, HostRelocateVStorageObject_Task, HostRenameVStorageObject, HostRetrieveVStorageInfrastructureObjectPolicy, HostRetrieveVStorageObject, HostRetrieveVStorageObjectMetadata, HostRetrieveVStorageObjectMetadataValue, HostRetrieveVStorageObjectState, HostScheduleReconcileDatastoreInventory, HostSetVStorageObjectControlFlags, HostUpdateVStorageObjectMetadata_Task, HostUpdateVStorageObjectMetadataEx_Task, HostVStorageObjectCreateDiskFromSnapshot_Task, HostVStorageObjectCreateSnapshot_Task, HostVStorageObjectDeleteSnapshot_Task, HostVStorageObjectRetrieveSnapshotInfo, HostVStorageObjectRevert_Task, InflateDisk_Task, ListVStorageObject, QueryAvailableDisksForVmfs, QueryDatastorePerformanceSummary, QueryMaxQueueDepth, QueryVmfsDatastoreExpandOptions, QueryVmfsDatastoreExtendOptions, ReconcileDatastoreInventory_Task, RelocateVStorageObject_Task, RemoveDatastore, RemoveDatastoreEx_Task, RenameVStorageObject, RetrieveSnapshotDetails, RetrieveSnapshotInfo, RetrieveVStorageInfrastructureObjectPolicy, RetrieveVStorageObject, RetrieveVStorageObjectState, RevertVStorageObject_Task, ScheduleReconcileDatastoreInventory, SetMaxQueueDepth, SetVStorageObjectControlFlags, UpdateLocalSwapDatastore, UpdateVStorageObjectCrypto_Task, UpdateVStorageObjectPolicy_Task, VCenterUpdateVStorageObjectMetadataEx_Task, VStorageObjectCreateSnapshot_Task, VstorageObjectVCenterQueryChangedDiskAreas
Returned by
CreateLocalDatastore, CreateNasDatastore, CreateVmfsDatastore, CreateVvolDatastore, ExpandVmfsDatastore, ExtendVmfsDatastore, GetSystemVMsRestrictedDatastores
Extends
ManagedEntity
See also
DatastoreCapability, DatastoreHostMount, DatastoreInfo, DatastoreMountPathDatastorePair, DatastoreSummary, DatastoreVVolContainerFailoverPair, HostDatastoreBrowser, StorageIORMInfo, StoragePlacementResult, UpdateVirtualMachineFilesResult, VirtualMachine, VVolVmConfigFileUpdateResult
Since
null


Managed Object Description

Properties

Name Type Description
browserManagedObjectReference
to a HostDatastoreBrowser


capabilityDatastoreCapability


host*DatastoreHostMount[]


infoDatastoreInfo


iormConfiguration*StorageIORMInfo

Since vSphere API 4.1
summaryDatastoreSummary


vm*ManagedObjectReference[]
to a VirtualMachine[]


Properties inherited from ManagedEntity
alarmActionsEnabled, configIssue, configStatus, customValue, declaredAlarmState, disabledMethod, effectiveRole, name, overallStatus, parent, permission, recentTask, tag, triggeredAlarmState
Properties inherited from ExtensibleManagedObject
availableField, value
*May not be present

Methods

Methods defined in this Managed Object
DatastoreEnterMaintenanceMode, DatastoreExitMaintenanceMode_Task, DestroyDatastore, RefreshDatastore, RefreshDatastoreStorageInfo, RenameDatastore, UpdateVirtualMachineFiles_Task, UpdateVVolVirtualMachineFiles_Task
Methods inherited from ManagedEntity
Destroy_Task, Reload, Rename_Task
Methods inherited from ExtensibleManagedObject
setCustomValue

DatastoreEnterMaintenanceMode

Required Privileges
Datastore.Config
Since
vSphere API 5.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the Datastore used to make the method call.

Return Value

Type Description
StoragePlacementResult

Faults

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



DatastoreExitMaintenanceMode_Task

Required Privileges
Datastore.Config
Since
vSphere API 5.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the Datastore used to make the method call.

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

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



DestroyDatastore

Deprecated.

Required Privileges
Datastore.Delete

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the Datastore used to make the method call.

Return Value

Type Description
None

Faults

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



RefreshDatastore

Required Privileges
System.Read

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the Datastore used to make the method call.

Return Value

Type Description
None

Faults

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



RefreshDatastoreStorageInfo

Required Privileges
System.Read
Since
vSphere API 4.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the Datastore used to make the method call.

Return Value

Type Description
None

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



RenameDatastore

Deprecated.

Required Privileges
Datastore.Rename

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the Datastore used to make the method call.
newName Pxsd:string

Since null
P Required privilege: newName

Return Value

Type Description
None

Faults

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



UpdateVirtualMachineFiles_Task

Required Privileges
Datastore.UpdateVirtualMachineFiles
Since
vSphere API 4.1

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the Datastore used to make the method call.
mountPathDatastoreMapping PDatastoreMountPathDatastorePair[]

Since vSphere API 4.1
P Required privilege: mountPathDatastoreMapping

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
InvalidDatastore
PlatformConfigFault
ResourceInUse
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



UpdateVVolVirtualMachineFiles_Task

Required Privileges
Datastore.UpdateVirtualMachineFiles
Since
vSphere API 6.5

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the Datastore used to make the method call.
failoverPair* PDatastoreVVolContainerFailoverPair[]

Since vSphere API 6.5
*Need not be set P Required privilege: failoverPair

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
InvalidDatastore
NotSupported
PlatformConfigFault
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