Managed Object - HostDatastoreSystem

Property of
HostConfigManager
See also
Datastore, HostDatastoreSystemCapabilities, HostDatastoreSystemDatastoreResult, HostDatastoreSystemVvolDatastoreSpec, HostNasVolumeSpec, HostResignatureRescanResult, HostScsiDisk, HostUnresolvedVmfsResignatureSpec, HostUnresolvedVmfsVolume, VmfsDatastoreCreateSpec, VmfsDatastoreExpandSpec, VmfsDatastoreExtendSpec, VmfsDatastoreOption
Since
null


Managed Object Description

Properties

Name Type Description
capabilitiesHostDatastoreSystemCapabilities

Since VI API 2.5
datastore* PManagedObjectReference[]
to a Datastore[]


*May not be presentP Required privilege: System.View

Methods

Methods defined in this Managed Object
ConfigureDatastorePrincipal, CreateLocalDatastore, CreateNasDatastore, CreateVmfsDatastore, CreateVvolDatastore, DisableClusteredVmdkSupport, EnableClusteredVmdkSupport, ExpandVmfsDatastore, ExtendVmfsDatastore, QueryAvailableDisksForVmfs, QueryMaxQueueDepth, QueryUnresolvedVmfsVolumes, QueryVmfsDatastoreCreateOptions, QueryVmfsDatastoreExpandOptions, QueryVmfsDatastoreExtendOptions, RemoveDatastore, RemoveDatastoreEx_Task, ResignatureUnresolvedVmfsVolume_Task, SetMaxQueueDepth, UpdateLocalSwapDatastore

ConfigureDatastorePrincipal

Required Privileges
Host.Config.Maintenance

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostDatastoreSystem used to make the method call.
userName Pxsd:string

Since null
password* Pxsd:string

Since null
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

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



CreateLocalDatastore

Required Privileges
Host.Config.Storage

Parameters

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

Since null
path Pxsd:string

Since null
PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference
to a Datastore

Faults

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



CreateNasDatastore

Required Privileges
Host.Config.Storage

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostDatastoreSystem used to make the method call.
spec PHostNasVolumeSpec

Since null
P Required privilege: spec

Return Value

Type Description
ManagedObjectReference
to a Datastore

Faults

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



CreateVmfsDatastore

Required Privileges
Host.Config.Storage

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostDatastoreSystem used to make the method call.
spec PVmfsDatastoreCreateSpec

Since null
P Required privilege: spec

Return Value

Type Description
ManagedObjectReference
to a Datastore

Faults

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



CreateVvolDatastore

Required Privileges
Host.Config.Storage
Since
vSphere API 6.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostDatastoreSystem used to make the method call.
spec PHostDatastoreSystemVvolDatastoreSpec

Since vSphere API 6.0
P Required privilege: spec

Return Value

Type Description
ManagedObjectReference
to a Datastore

Faults

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



DisableClusteredVmdkSupport

Required Privileges
Host.Config.Storage
Since
vSphere API 7.0

Parameters

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

Since vSphere API 7.0
P Required privilege: datastore

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



EnableClusteredVmdkSupport

Required Privileges
Host.Config.Storage
Since
vSphere API 7.0

Parameters

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

Since vSphere API 7.0
P Required privilege: datastore

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



ExpandVmfsDatastore

Required Privileges
Host.Config.Storage
Since
vSphere API 4.0

Parameters

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

Since vSphere API 4.0
spec PVmfsDatastoreExpandSpec

Since vSphere API 4.0
PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference
to a Datastore

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



ExtendVmfsDatastore

Required Privileges
Host.Config.Storage

Parameters

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

Since null
spec PVmfsDatastoreExtendSpec

Since null
PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference
to a Datastore

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



QueryAvailableDisksForVmfs

Required Privileges
Host.Config.Storage

Parameters

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

Since null
*Need not be set P Required privilege: datastore

Return Value

Type Description
HostScsiDisk[]

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



QueryMaxQueueDepth

Required Privileges
Host.Config.Storage
Since
null

Parameters

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

Since null
P Required privilege: datastore

Return Value

Type Description
xsd:long

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



QueryUnresolvedVmfsVolumes

Required Privileges
System.Read
Since
vSphere API 4.0

Parameters

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

Return Value

Type Description
HostUnresolvedVmfsVolume[]

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



QueryVmfsDatastoreCreateOptions

Required Privileges
Host.Config.Storage

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostDatastoreSystem used to make the method call.
devicePath Pxsd:string

Since null
vmfsMajorVersion* Pxsd:int

Since null
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
VmfsDatastoreOption[]

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



QueryVmfsDatastoreExpandOptions

Required Privileges
Host.Config.Storage
Since
vSphere API 4.0

Parameters

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

Since vSphere API 4.0
P Required privilege: datastore

Return Value

Type Description
VmfsDatastoreOption[]

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



QueryVmfsDatastoreExtendOptions

Required Privileges
Host.Config.Storage

Parameters

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

Since null
devicePath Pxsd:string

Since null
suppressExpandCandidates* Pxsd:boolean

Since null
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
VmfsDatastoreOption[]

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



RemoveDatastore

Required Privileges
Host.Config.Storage

Parameters

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

Since null
P Required privilege: datastore

Return Value

Type Description
None

Faults

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



RemoveDatastoreEx_Task

Required Privileges
Host.Config.Storage
Since
vSphere API 6.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostDatastoreSystem used to make the method call.
datastore PManagedObjectReference[]
to a Datastore[]

Since vSphere API 6.0
P Required privilege: datastore

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

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



ResignatureUnresolvedVmfsVolume_Task

Required Privileges
Host.Config.Storage
Since
vSphere API 4.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostDatastoreSystem used to make the method call.
resolutionSpec PHostUnresolvedVmfsResignatureSpec

Since vSphere API 4.0
P Required privilege: resolutionSpec

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

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

Events

Type
None



SetMaxQueueDepth

Required Privileges
Host.Config.Storage
Since
null

Parameters

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

Since null
maxQdepth Pxsd:long

Since null
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



UpdateLocalSwapDatastore

Required Privileges
Host.Config.Storage
Since
VI API 2.5

Parameters

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

Since VI API 2.5
*Need not be set P Required privilege: datastore

Return Value

Type Description
None

Faults

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