Managed Object - HostStorageSystem

Property of
HostConfigManager
Extends
ExtensibleManagedObject
See also
FcoeConfigFcoeSpecification, HostDiskPartitionBlockRange, HostDiskPartitionInfo, HostDiskPartitionLayout, HostDiskPartitionSpec, HostFileSystemVolumeInfo, HostHbaCreateSpec, HostInternetScsiHbaAuthenticationProperties, HostInternetScsiHbaDigestProperties, HostInternetScsiHbaDiscoveryProperties, HostInternetScsiHbaIPProperties, HostInternetScsiHbaParamValue, HostInternetScsiHbaSendTarget, HostInternetScsiHbaStaticTarget, HostInternetScsiHbaTargetSet, HostMultipathInfoHppLogicalUnitPolicy, HostMultipathInfoLogicalUnitPolicy, HostMultipathStateInfo, HostNasVolumeUserInfo, HostNvmeConnectSpec, HostNvmeDisconnectSpec, HostNvmeDiscoverSpec, HostNvmeDiscoveryLog, HostPathSelectionPolicyOption, HostScsiDisk, HostScsiDiskPartition, HostStorageArrayTypePolicyOption, HostStorageDeviceInfo, HostStorageSystemDiskLocatorLedResult, HostStorageSystemScsiLunResult, HostStorageSystemVmfsVolumeResult, HostUnresolvedVmfsResolutionResult, HostUnresolvedVmfsResolutionSpec, HostUnresolvedVmfsVolume, HostVffsSpec, HostVffsVolume, HostVmfsSpec, HostVmfsVolume, VmfsConfigOption, VmfsUnmapBandwidthSpec
Since
null


Managed Object Description

Properties

Name Type Description
fileSystemVolumeInfoHostFileSystemVolumeInfo


multipathStateInfo*HostMultipathStateInfo

Since vSphere API 4.0
storageDeviceInfo*HostStorageDeviceInfo


systemFile*xsd:string[]

Since vSphere API 4.1
Properties inherited from ExtensibleManagedObject
availableField, value
*May not be present

Methods

Methods defined in this Managed Object
AddInternetScsiSendTargets, AddInternetScsiStaticTargets, AttachScsiLun, AttachScsiLunEx_Task, AttachVmfsExtent, ChangeNFSUserPassword, ClearNFSUser, ComputeDiskPartitionInfo, ComputeDiskPartitionInfoForResize, ConnectNvmeController, ConnectNvmeControllerEx_Task, CreateNvmeOverRdmaAdapter, CreateSoftwareAdapter, DeleteScsiLunState, DeleteVffsVolumeState, DeleteVmfsVolumeState, DestroyVffs, DetachScsiLun, DetachScsiLunEx_Task, DisableMultipathPath, DisconnectNvmeController, DisconnectNvmeControllerEx_Task, DiscoverFcoeHbas, DiscoverNvmeControllers, EnableMultipathPath, ExpandVmfsExtent, ExtendVffs, FormatVffs, FormatVmfs, MarkAsLocal_Task, MarkAsNonLocal_Task, MarkAsNonSsd_Task, MarkAsSsd_Task, MarkForRemoval, MarkPerenniallyReserved, MarkPerenniallyReservedEx_Task, MountVffsVolume, MountVmfsVolume, MountVmfsVolumeEx_Task, QueryAvailableSsds, QueryNFSUser, QueryPathSelectionPolicyOptions, QueryStorageArrayTypePolicyOptions, QueryUnresolvedVmfsVolume, QueryVmfsConfigOption, RefreshStorageSystem, RemoveInternetScsiSendTargets, RemoveInternetScsiStaticTargets, RemoveNvmeOverRdmaAdapter, RemoveSoftwareAdapter, RescanAllHba, RescanHba, RescanVffs, RescanVmfs, ResolveMultipleUnresolvedVmfsVolumes, ResolveMultipleUnresolvedVmfsVolumesEx_Task, RetrieveDiskPartitionInfo, SetMultipathLunPolicy, SetNFSUser, TurnDiskLocatorLedOff_Task, TurnDiskLocatorLedOn_Task, UnmapVmfsVolumeEx_Task, UnmountForceMountedVmfsVolume, UnmountVffsVolume, UnmountVmfsVolume, UnmountVmfsVolumeEx_Task, UpdateDiskPartitions, UpdateHppMultipathLunPolicy, UpdateInternetScsiAdvancedOptions, UpdateInternetScsiAlias, UpdateInternetScsiAuthenticationProperties, UpdateInternetScsiDigestProperties, UpdateInternetScsiDiscoveryProperties, UpdateInternetScsiIPProperties, UpdateInternetScsiName, UpdateScsiLunDisplayName, UpdateSoftwareInternetScsiEnabled, UpdateVmfsUnmapBandwidth, UpdateVmfsUnmapPriority, UpgradeVmfs, UpgradeVmLayout
Methods inherited from ExtensibleManagedObject
setCustomValue

AddInternetScsiSendTargets

Required Privileges
Host.Config.Storage

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem used to make the method call.
iScsiHbaDevice Pxsd:string

Since null
targets PHostInternetScsiHbaSendTarget[]

Since null
PRequired privilege - see tooltip for details

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



AddInternetScsiStaticTargets

Required Privileges
Host.Config.Storage

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem used to make the method call.
iScsiHbaDevice Pxsd:string

Since null
targets PHostInternetScsiHbaStaticTarget[]

Since null
PRequired privilege - see tooltip for details

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



AttachScsiLun

Required Privileges
Host.Config.Storage
Since
vSphere API 5.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem used to make the method call.
lunUuid Pxsd:string

Since vSphere API 5.0
P Required privilege: lunUuid

Return Value

Type Description
None

Faults

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



AttachScsiLunEx_Task

Required Privileges
Host.Config.Storage
Since
vSphere API 6.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem used to make the method call.
lunUuid Pxsd:string[]

Since vSphere API 6.0
P Required privilege: lunUuid

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



AttachVmfsExtent

Required Privileges
Host.Config.Storage

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem used to make the method call.
vmfsPath Pxsd:string

Since null
extent PHostScsiDiskPartition

Since null
PRequired privilege - see tooltip for details

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



ChangeNFSUserPassword

Required Privileges
Host.Config.Storage
Since
vSphere API 6.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem used to make the method call.
password Pxsd:string

Since vSphere API 6.0
P Required privilege: password

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



ClearNFSUser

Required Privileges
Host.Config.Storage
Since
vSphere API 6.0

Parameters

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

Return Value

Type Description
None

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



ComputeDiskPartitionInfo

Required Privileges
Host.Config.Storage

Parameters

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

Since null
layout PHostDiskPartitionLayout

Since null
partitionFormat* Pxsd:string

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

Return Value

Type Description
HostDiskPartitionInfo

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



ComputeDiskPartitionInfoForResize

Required Privileges
Host.Config.Storage
Since
vSphere API 4.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem used to make the method call.
partition PHostScsiDiskPartition

Since vSphere API 4.0
blockRange PHostDiskPartitionBlockRange

Since vSphere API 4.0
partitionFormat* Pxsd:string

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

Return Value

Type Description
HostDiskPartitionInfo

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



ConnectNvmeController

Required Privileges
Host.Config.Storage
Since
vSphere API 7.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem used to make the method call.
connectSpec PHostNvmeConnectSpec

Since vSphere API 7.0
P Required privilege: connectSpec

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



ConnectNvmeControllerEx_Task

Required Privileges
Host.Config.Storage
Since
vSphere API 7.0.3.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem used to make the method call.
connectSpec* PHostNvmeConnectSpec[]

Since vSphere API 7.0.3.0
*Need not be set P Required privilege: connectSpec

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



CreateNvmeOverRdmaAdapter

Required Privileges
Host.Config.Storage
Since
vSphere API 7.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem used to make the method call.
rdmaDeviceName Pxsd:string

Since vSphere API 7.0
P Required privilege: rdmaDeviceName

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



CreateSoftwareAdapter

Required Privileges
Host.Config.Storage
Since
vSphere API 7.0.3.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem used to make the method call.
spec PHostHbaCreateSpec

Since vSphere API 7.0.3.0
P Required privilege: spec

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



DeleteScsiLunState

Required Privileges
Host.Config.Storage
Since
vSphere API 5.1

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem used to make the method call.
lunCanonicalName Pxsd:string

Since vSphere API 5.0
P Required privilege: lunCanonicalName

Return Value

Type Description
None

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



DeleteVffsVolumeState

Required Privileges
Host.Config.Storage
Since
vSphere API 5.5

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem used to make the method call.
vffsUuid Pxsd:string

Since vSphere API 5.5
P Required privilege: vffsUuid

Return Value

Type Description
None

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



DeleteVmfsVolumeState

Required Privileges
Host.Config.Storage
Since
vSphere API 5.1

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem used to make the method call.
vmfsUuid Pxsd:string

Since vSphere API 5.0
P Required privilege: vmfsUuid

Return Value

Type Description
None

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



DestroyVffs

Required Privileges
Host.Config.Storage
Since
vSphere API 5.5

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem used to make the method call.
vffsPath Pxsd:string

Since vSphere API 5.5
P Required privilege: vffsPath

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



DetachScsiLun

Required Privileges
Host.Config.Storage
Since
vSphere API 5.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem used to make the method call.
lunUuid Pxsd:string

Since vSphere API 5.0
P Required privilege: lunUuid

Return Value

Type Description
None

Faults

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



DetachScsiLunEx_Task

Required Privileges
Host.Config.Storage
Since
vSphere API 6.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem used to make the method call.
lunUuid Pxsd:string[]

Since vSphere API 6.0
P Required privilege: lunUuid

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



DisableMultipathPath

Required Privileges
Host.Config.Storage

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem used to make the method call.
pathName Pxsd:string

Since null
P Required privilege: pathName

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



DisconnectNvmeController

Required Privileges
Host.Config.Storage
Since
vSphere API 7.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem used to make the method call.
disconnectSpec PHostNvmeDisconnectSpec

Since vSphere API 7.0
P Required privilege: disconnectSpec

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



DisconnectNvmeControllerEx_Task

Required Privileges
Host.Config.Storage
Since
vSphere API 7.0.3.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem used to make the method call.
disconnectSpec* PHostNvmeDisconnectSpec[]

Since vSphere API 7.0.3.0
*Need not be set P Required privilege: disconnectSpec

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



DiscoverFcoeHbas

Deprecated.

Required Privileges
Host.Config.Storage
Since
vSphere API 5.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem used to make the method call.
fcoeSpec PFcoeConfigFcoeSpecification

Since vSphere API 5.0
P Required privilege: fcoeSpec

Return Value

Type Description
None

Faults

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



DiscoverNvmeControllers

Required Privileges
Host.Config.Storage
Since
vSphere API 7.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem used to make the method call.
discoverSpec PHostNvmeDiscoverSpec

Since vSphere API 7.0
P Required privilege: discoverSpec

Return Value

Type Description
HostNvmeDiscoveryLog

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



EnableMultipathPath

Required Privileges
Host.Config.Storage

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem used to make the method call.
pathName Pxsd:string

Since null
P Required privilege: pathName

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



ExpandVmfsExtent

Required Privileges
Host.Config.Storage
Since
vSphere API 4.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem used to make the method call.
vmfsPath Pxsd:string

Since vSphere API 4.0
extent PHostScsiDiskPartition

Since vSphere API 4.0
PRequired privilege - see tooltip for details

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



ExtendVffs

Required Privileges
Host.Config.Storage
Since
vSphere API 5.5

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem used to make the method call.
vffsPath Pxsd:string

Since vSphere API 5.5
devicePath Pxsd:string

Since vSphere API 5.5
spec* PHostDiskPartitionSpec

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

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



FormatVffs

Required Privileges
Host.Config.Storage
Since
vSphere API 5.5

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem used to make the method call.
createSpec PHostVffsSpec

Since vSphere API 5.5
P Required privilege: createSpec

Return Value

Type Description
HostVffsVolume

Faults

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



FormatVmfs

Required Privileges
Host.Config.Storage

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem used to make the method call.
createSpec PHostVmfsSpec

Since null
P Required privilege: createSpec

Return Value

Type Description
HostVmfsVolume

Faults

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



MarkAsLocal_Task

Required Privileges
Host.Config.Storage
Since
vSphere API 6.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem used to make the method call.
scsiDiskUuid Pxsd:string

Since vSphere API 6.0
P Required privilege: scsiDiskUuid

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

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



MarkAsNonLocal_Task

Required Privileges
Host.Config.Storage
Since
vSphere API 6.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem used to make the method call.
scsiDiskUuid Pxsd:string

Since vSphere API 6.0
P Required privilege: scsiDiskUuid

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

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



MarkAsNonSsd_Task

Required Privileges
Host.Config.Storage
Since
vSphere API 6.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem used to make the method call.
scsiDiskUuid Pxsd:string

Since vSphere API 6.0
P Required privilege: scsiDiskUuid

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

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



MarkAsSsd_Task

Required Privileges
Host.Config.Storage
Since
vSphere API 6.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem used to make the method call.
scsiDiskUuid Pxsd:string

Since vSphere API 6.0
P Required privilege: scsiDiskUuid

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

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



MarkForRemoval

Deprecated.

Required Privileges
Host.Config.Storage
Since
vSphere API 5.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem used to make the method call.
hbaName Pxsd:string

Since vSphere API 5.0
remove Pxsd:boolean

Since vSphere API 5.0
PRequired privilege - see tooltip for details

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



MarkPerenniallyReserved

Required Privileges
Host.Config.Storage
Since
vSphere API 6.7.2

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem used to make the method call.
lunUuid Pxsd:string

Since vSphere API 6.7.2
state Pxsd:boolean

Since vSphere API 6.7.2
PRequired privilege - see tooltip for details

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



MarkPerenniallyReservedEx_Task

Required Privileges
Host.Config.Storage
Since
vSphere API 6.7.2

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem used to make the method call.
lunUuid* Pxsd:string[]

Since vSphere API 6.7.2
state Pxsd:boolean

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

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

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



MountVffsVolume

Required Privileges
Host.Config.Storage
Since
vSphere API 5.5

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem used to make the method call.
vffsUuid Pxsd:string

Since vSphere API 5.5
P Required privilege: vffsUuid

Return Value

Type Description
None

Faults

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



MountVmfsVolume

Required Privileges
Host.Config.Storage
Since
vSphere API 5.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem used to make the method call.
vmfsUuid Pxsd:string

Since vSphere API 5.0
P Required privilege: vmfsUuid

Return Value

Type Description
None

Faults

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



MountVmfsVolumeEx_Task

Required Privileges
Host.Config.Storage
Since
vSphere API 6.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem used to make the method call.
vmfsUuid Pxsd:string[]

Since vSphere API 6.0
P Required privilege: vmfsUuid

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



QueryAvailableSsds

Required Privileges
Host.Config.Storage
Since
vSphere API 5.5

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem used to make the method call.
vffsPath* Pxsd:string

Since vSphere API 5.5
*Need not be set P Required privilege: vffsPath

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



QueryNFSUser

Required Privileges
Host.Config.Storage
Since
vSphere API 6.0

Parameters

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

Return Value

Type Description
HostNasVolumeUserInfo

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



QueryPathSelectionPolicyOptions

Required Privileges
System.Read
Since
vSphere API 4.0

Parameters

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

Return Value

Type Description
HostPathSelectionPolicyOption[]

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



QueryStorageArrayTypePolicyOptions

Required Privileges
System.Read
Since
vSphere API 4.0

Parameters

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

Return Value

Type Description
HostStorageArrayTypePolicyOption[]

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



QueryUnresolvedVmfsVolume

Required Privileges
System.Read
Since
vSphere API 4.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem 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



QueryVmfsConfigOption

Required Privileges
Host.Config.Storage
Since
vSphere API 6.5

Parameters

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

Return Value

Type Description
VmfsConfigOption[]

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



RefreshStorageSystem

Required Privileges
Host.Config.Storage

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem 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



RemoveInternetScsiSendTargets

Required Privileges
Host.Config.Storage

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem used to make the method call.
iScsiHbaDevice Pxsd:string

Since null
targets PHostInternetScsiHbaSendTarget[]

Since null
force* Pxsd:boolean

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

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



RemoveInternetScsiStaticTargets

Required Privileges
Host.Config.Storage

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem used to make the method call.
iScsiHbaDevice Pxsd:string

Since null
targets PHostInternetScsiHbaStaticTarget[]

Since null
PRequired privilege - see tooltip for details

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



RemoveNvmeOverRdmaAdapter

Required Privileges
Host.Config.Storage
Since
vSphere API 7.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem used to make the method call.
hbaDeviceName Pxsd:string

Since vSphere API 7.0
P Required privilege: hbaDeviceName

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



RemoveSoftwareAdapter

Required Privileges
Host.Config.Storage
Since
vSphere API 7.0.3.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem used to make the method call.
hbaDeviceName Pxsd:string

Since vSphere API 7.0.3.0
P Required privilege: hbaDeviceName

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



RescanAllHba

Required Privileges
Host.Config.Storage

Parameters

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

Return Value

Type Description
None

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



RescanHba

Required Privileges
Host.Config.Storage

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem used to make the method call.
hbaDevice Pxsd:string

Since null
P Required privilege: hbaDevice

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



RescanVffs

Required Privileges
Host.Config.Storage
Since
vSphere API 5.5

Parameters

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

Return Value

Type Description
None

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



RescanVmfs

Required Privileges
Host.Config.Storage

Parameters

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

Return Value

Type Description
None

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



ResolveMultipleUnresolvedVmfsVolumes

Required Privileges
Host.Config.Storage
Since
vSphere API 4.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem used to make the method call.
resolutionSpec PHostUnresolvedVmfsResolutionSpec[]

Since vSphere API 4.0
P Required privilege: resolutionSpec

Return Value

Type Description
HostUnresolvedVmfsResolutionResult[]

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



ResolveMultipleUnresolvedVmfsVolumesEx_Task

Required Privileges
Host.Config.Storage
Since
vSphere API 5.5

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem used to make the method call.
resolutionSpec PHostUnresolvedVmfsResolutionSpec[]

Since vSphere API 5.5
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.

Events

Type
None



RetrieveDiskPartitionInfo

Required Privileges
System.Read

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem used to make the method call.
devicePath Pxsd:string[]

Since null
P Required privilege: devicePath

Return Value

Type Description
HostDiskPartitionInfo[]

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



SetMultipathLunPolicy

Required Privileges
Host.Config.Storage

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem used to make the method call.
lunId Pxsd:string

Since null
policy PHostMultipathInfoLogicalUnitPolicy

Since null
PRequired privilege - see tooltip for details

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



SetNFSUser

Required Privileges
Host.Config.Storage
Since
vSphere API 6.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem used to make the method call.
user Pxsd:string

Since vSphere API 6.0
password Pxsd:string

Since vSphere API 6.0
PRequired privilege - see tooltip for details

Return Value

Type Description
None

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



TurnDiskLocatorLedOff_Task

Required Privileges
Host.Config.Storage
Since
vSphere API 6.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem used to make the method call.
scsiDiskUuids Pxsd:string[]

Since vSphere API 6.0
P Required privilege: scsiDiskUuids

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



TurnDiskLocatorLedOn_Task

Required Privileges
Host.Config.Storage
Since
vSphere API 6.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem used to make the method call.
scsiDiskUuids Pxsd:string[]

Since vSphere API 6.0
P Required privilege: scsiDiskUuids

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



UnmapVmfsVolumeEx_Task

Required Privileges
Host.Config.Storage
Since
vSphere API 6.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem used to make the method call.
vmfsUuid Pxsd:string[]

Since vSphere API 6.0
P Required privilege: vmfsUuid

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



UnmountForceMountedVmfsVolume

Required Privileges
Host.Config.Storage
Since
vSphere API 4.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem used to make the method call.
vmfsUuid Pxsd:string

Since vSphere API 4.0
P Required privilege: vmfsUuid

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



UnmountVffsVolume

Required Privileges
Host.Config.Storage
Since
vSphere API 5.5

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem used to make the method call.
vffsUuid Pxsd:string

Since vSphere API 5.5
P Required privilege: vffsUuid

Return Value

Type Description
None

Faults

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



UnmountVmfsVolume

Required Privileges
Host.Config.Storage
Since
vSphere API 5.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem used to make the method call.
vmfsUuid Pxsd:string

Since vSphere API 5.0
P Required privilege: vmfsUuid

Return Value

Type Description
None

Faults

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



UnmountVmfsVolumeEx_Task

Required Privileges
Host.Config.Storage
Since
vSphere API 6.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem used to make the method call.
vmfsUuid Pxsd:string[]

Since vSphere API 6.0
P Required privilege: vmfsUuid

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



UpdateDiskPartitions

Required Privileges
Host.Config.Storage

Parameters

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

Since null
spec PHostDiskPartitionSpec

Since null
PRequired privilege - see tooltip for details

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



UpdateHppMultipathLunPolicy

Required Privileges
Host.Config.Storage
Since
vSphere API 7.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem used to make the method call.
lunId Pxsd:string

Since vSphere API 7.0
policy PHostMultipathInfoHppLogicalUnitPolicy

Since vSphere API 7.0
PRequired privilege - see tooltip for details

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



UpdateInternetScsiAdvancedOptions

Required Privileges
Host.Config.Storage
Since
vSphere API 4.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem used to make the method call.
iScsiHbaDevice Pxsd:string

Since vSphere API 4.0
targetSet* PHostInternetScsiHbaTargetSet

Since vSphere API 4.0
options PHostInternetScsiHbaParamValue[]

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

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



UpdateInternetScsiAlias

Required Privileges
Host.Config.Storage

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem used to make the method call.
iScsiHbaDevice Pxsd:string

Since null
iScsiAlias Pxsd:string

Since null
PRequired privilege - see tooltip for details

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



UpdateInternetScsiAuthenticationProperties

Required Privileges
Host.Config.Storage

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem used to make the method call.
iScsiHbaDevice Pxsd:string

Since null
authenticationProperties PHostInternetScsiHbaAuthenticationProperties

Since null
targetSet* PHostInternetScsiHbaTargetSet

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

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



UpdateInternetScsiDigestProperties

Required Privileges
Host.Config.Storage
Since
vSphere API 4.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem used to make the method call.
iScsiHbaDevice Pxsd:string

Since vSphere API 4.0
targetSet* PHostInternetScsiHbaTargetSet

Since vSphere API 4.0
digestProperties PHostInternetScsiHbaDigestProperties

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

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



UpdateInternetScsiDiscoveryProperties

Required Privileges
Host.Config.Storage

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem used to make the method call.
iScsiHbaDevice Pxsd:string

Since null
discoveryProperties PHostInternetScsiHbaDiscoveryProperties

Since null
PRequired privilege - see tooltip for details

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



UpdateInternetScsiIPProperties

Required Privileges
Host.Config.Storage

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem used to make the method call.
iScsiHbaDevice Pxsd:string

Since null
ipProperties PHostInternetScsiHbaIPProperties

Since null
PRequired privilege - see tooltip for details

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



UpdateInternetScsiName

Required Privileges
Host.Config.Storage

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem used to make the method call.
iScsiHbaDevice Pxsd:string

Since null
iScsiName Pxsd:string

Since null
PRequired privilege - see tooltip for details

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



UpdateScsiLunDisplayName

Required Privileges
Host.Config.Storage
Since
vSphere API 4.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem used to make the method call.
lunUuid Pxsd:string

Since vSphere API 4.0
displayName Pxsd:string

Since vSphere API 4.0
PRequired privilege - see tooltip for details

Return Value

Type Description
None

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



UpdateSoftwareInternetScsiEnabled

Required Privileges
Host.Config.Storage

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem used to make the method call.
enabled Pxsd:boolean

Since null
P Required privilege: enabled

Return Value

Type Description
None

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



UpdateVmfsUnmapBandwidth

Required Privileges
Host.Config.Storage
Since
vSphere API 6.7

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem used to make the method call.
vmfsUuid Pxsd:string

Since vSphere API 6.7
unmapBandwidthSpec PVmfsUnmapBandwidthSpec

Since vSphere API 6.7
PRequired privilege - see tooltip for details

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



UpdateVmfsUnmapPriority

Required Privileges
Host.Config.Storage
Since
vSphere API 6.5

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem used to make the method call.
vmfsUuid Pxsd:string

Since vSphere API 6.5
unmapPriority Pxsd:string

Since vSphere API 6.5
PRequired privilege - see tooltip for details

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



UpgradeVmfs

Required Privileges
Host.Config.Storage

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem used to make the method call.
vmfsPath Pxsd:string

Since null
P Required privilege: vmfsPath

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



UpgradeVmLayout

Required Privileges
Host.Config.Storage

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostStorageSystem 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