# 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
--- | --- | ---
capabilities | HostDatastoreSystemCapabilities | Since VI API 2.5
datastore* P | ManagedObjectReference[] to a Datastore[] |

*May not be present P 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostDatastoreSystem used to make the method call.
userName P | xsd:string | Since null
password* P | xsd:string | Since null

*Need not be set P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
None

Faults

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

# CreateLocalDatastore

Required Privileges
  Host.Config.Storage

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostDatastoreSystem used to make the method call.
name P | xsd:string | Since null
path P | xsd:string | Since null

P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
ManagedObjectReference to a Datastore |

Faults

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

# CreateNasDatastore

Required Privileges
  Host.Config.Storage

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostDatastoreSystem used to make the method call.
spec P | HostNasVolumeSpec | Since null

P Required privilege: spec

Return Value

Type | Description
--- | ---
ManagedObjectReference to a Datastore |

Faults

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

# CreateVmfsDatastore

Required Privileges
  Host.Config.Storage

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostDatastoreSystem used to make the method call.
spec P | VmfsDatastoreCreateSpec | Since null

P Required privilege: spec

Return Value

Type | Description
--- | ---
ManagedObjectReference to a Datastore |

Faults

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

# CreateVvolDatastore

Required Privileges
  Host.Config.Storage
Since
  vSphere API 6.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostDatastoreSystem used to make the method call.
spec P | HostDatastoreSystemVvolDatastoreSpec | Since vSphere API 6.0

P Required privilege: spec

Return Value

Type | Description
--- | ---
ManagedObjectReference to a Datastore |

Faults

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

# DisableClusteredVmdkSupport

Required Privileges
  Host.Config.Storage
Since
  vSphere API 7.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostDatastoreSystem used to make the method call.
datastore P | ManagedObjectReference to a Datastore | Since vSphere API 7.0

P Required privilege: datastore

Return Value

Type | Description
--- | ---
None

Faults

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

# EnableClusteredVmdkSupport

Required Privileges
  Host.Config.Storage
Since
  vSphere API 7.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostDatastoreSystem used to make the method call.
datastore P | ManagedObjectReference to a Datastore | Since vSphere API 7.0

P Required privilege: datastore

Return Value

Type | Description
--- | ---
None

Faults

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

# ExpandVmfsDatastore

Required Privileges
  Host.Config.Storage
Since
  vSphere API 4.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostDatastoreSystem used to make the method call.
datastore P | ManagedObjectReference to a Datastore | Since vSphere API 4.0
spec P | VmfsDatastoreExpandSpec | Since vSphere API 4.0

P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
ManagedObjectReference to a Datastore |

Faults

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

# ExtendVmfsDatastore

Required Privileges
  Host.Config.Storage

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostDatastoreSystem used to make the method call.
datastore P | ManagedObjectReference to a Datastore | Since null
spec P | VmfsDatastoreExtendSpec | Since null

P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
ManagedObjectReference to a Datastore |

Faults

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

# QueryAvailableDisksForVmfs

Required Privileges
  Host.Config.Storage

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostDatastoreSystem used to make the method call.
datastore* P | ManagedObjectReference to a Datastore | Since null

*Need not be set P Required privilege: datastore

Return Value

Type | Description
--- | ---
HostScsiDisk[] |

Faults

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

# QueryMaxQueueDepth

Required Privileges
  Host.Config.Storage
Since
  null

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostDatastoreSystem used to make the method call.
datastore P | ManagedObjectReference to a Datastore | Since null

P Required privilege: datastore

Return Value

Type | Description
--- | ---
xsd:long |

Faults

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

# QueryUnresolvedVmfsVolumes

Required Privileges
  System.Read
Since
  vSphere API 4.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostDatastoreSystem used to make the method call.

Return Value

Type | Description
--- | ---
HostUnresolvedVmfsVolume[] |

Faults

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

# QueryVmfsDatastoreCreateOptions

Required Privileges
  Host.Config.Storage

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostDatastoreSystem used to make the method call.
devicePath P | xsd:string | Since null
vmfsMajorVersion* P | xsd:int | Since null

*Need not be set P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
VmfsDatastoreOption[] |

Faults

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

# QueryVmfsDatastoreExpandOptions

Required Privileges
  Host.Config.Storage
Since
  vSphere API 4.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostDatastoreSystem used to make the method call.
datastore P | ManagedObjectReference to a Datastore | Since vSphere API 4.0

P Required privilege: datastore

Return Value

Type | Description
--- | ---
VmfsDatastoreOption[] |

Faults

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

# QueryVmfsDatastoreExtendOptions

Required Privileges
  Host.Config.Storage

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostDatastoreSystem used to make the method call.
datastore P | ManagedObjectReference to a Datastore | Since null
devicePath P | xsd:string | Since null
suppressExpandCandidates* P | xsd:boolean | Since null

*Need not be set P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
VmfsDatastoreOption[] |

Faults

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

# RemoveDatastore

Required Privileges
  Host.Config.Storage

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostDatastoreSystem used to make the method call.
datastore P | ManagedObjectReference to a Datastore | Since null

P Required privilege: datastore

Return Value

Type | Description
--- | ---
None

Faults

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

# RemoveDatastoreEx_Task

Required Privileges
  Host.Config.Storage
Since
  vSphere API 6.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostDatastoreSystem used to make the method call.
datastore P | ManagedObjectReference[] to a Datastore[] | Since vSphere API 6.0

P Required privilege: datastore

Return Value

Type | Description
--- | ---
ManagedObjectReference to a ConverterTask |

Faults

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

# ResignatureUnresolvedVmfsVolume_Task

Required Privileges
  Host.Config.Storage
Since
  vSphere API 4.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostDatastoreSystem used to make the method call.
resolutionSpec P | HostUnresolvedVmfsResignatureSpec | Since vSphere API 4.0

P Required privilege: resolutionSpec

Return Value

Type | Description
--- | ---
ManagedObjectReference to a ConverterTask |

Faults

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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostDatastoreSystem used to make the method call.
datastore P | ManagedObjectReference to a Datastore | Since null
maxQdepth P | xsd:long | Since null

P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
None

Faults

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

# UpdateLocalSwapDatastore

Required Privileges
  Host.Config.Storage
Since
  VI API 2.5

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostDatastoreSystem used to make the method call.
datastore* P | ManagedObjectReference 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 |
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