# 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
--- | --- | ---
fileSystemVolumeInfo | HostFileSystemVolumeInfo |
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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
iScsiHbaDevice P | xsd:string | Since null
targets P | HostInternetScsiHbaSendTarget[] | Since null

P Required privilege - see tooltip for details

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

# AddInternetScsiStaticTargets

Required Privileges
  Host.Config.Storage

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
iScsiHbaDevice P | xsd:string | Since null
targets P | HostInternetScsiHbaStaticTarget[] | Since null

P Required privilege - see tooltip for details

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

# AttachScsiLun

Required Privileges
  Host.Config.Storage
Since
  vSphere API 5.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
lunUuid P | xsd:string | Since vSphere API 5.0

P Required privilege: lunUuid

Return Value

Type | Description
--- | ---
None

Faults

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

# AttachScsiLunEx_Task

Required Privileges
  Host.Config.Storage
Since
  vSphere API 6.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
lunUuid P | xsd:string[] | Since vSphere API 6.0

P Required privilege: lunUuid

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

# AttachVmfsExtent

Required Privileges
  Host.Config.Storage

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
vmfsPath P | xsd:string | Since null
extent P | HostScsiDiskPartition | Since null

P Required privilege - see tooltip for details

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

# ChangeNFSUserPassword

Required Privileges
  Host.Config.Storage
Since
  vSphere API 6.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
password P | xsd:string | Since vSphere API 6.0

P Required privilege: password

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

# ClearNFSUser

Required Privileges
  Host.Config.Storage
Since
  vSphere API 6.0

Parameters

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

Return Value

Type | Description
--- | ---
None

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

# ComputeDiskPartitionInfo

Required Privileges
  Host.Config.Storage

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
devicePath P | xsd:string | Since null
layout P | HostDiskPartitionLayout | Since null
partitionFormat* P | xsd:string | Since null

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

Return Value

Type | Description
--- | ---
HostDiskPartitionInfo |

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

# ComputeDiskPartitionInfoForResize

Required Privileges
  Host.Config.Storage
Since
  vSphere API 4.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
partition P | HostScsiDiskPartition | Since vSphere API 4.0
blockRange P | HostDiskPartitionBlockRange | Since vSphere API 4.0
partitionFormat* P | xsd:string | Since vSphere API 4.0

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

Return Value

Type | Description
--- | ---
HostDiskPartitionInfo |

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

# ConnectNvmeController

Required Privileges
  Host.Config.Storage
Since
  vSphere API 7.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
connectSpec P | HostNvmeConnectSpec | Since vSphere API 7.0

P Required privilege: connectSpec

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

# ConnectNvmeControllerEx_Task

Required Privileges
  Host.Config.Storage
Since
  vSphere API 7.0.3.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
connectSpec* P | HostNvmeConnectSpec[] | 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 |
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

# CreateNvmeOverRdmaAdapter

Required Privileges
  Host.Config.Storage
Since
  vSphere API 7.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
rdmaDeviceName P | xsd:string | Since vSphere API 7.0

P Required privilege: rdmaDeviceName

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

# CreateSoftwareAdapter

Required Privileges
  Host.Config.Storage
Since
  vSphere API 7.0.3.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
spec P | HostHbaCreateSpec | Since vSphere API 7.0.3.0

P Required privilege: spec

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

# DeleteScsiLunState

Required Privileges
  Host.Config.Storage
Since
  vSphere API 5.1

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
lunCanonicalName P | xsd:string | Since vSphere API 5.0

P Required privilege: lunCanonicalName

Return Value

Type | Description
--- | ---
None

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

# DeleteVffsVolumeState

Required Privileges
  Host.Config.Storage
Since
  vSphere API 5.5

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
vffsUuid P | xsd:string | Since vSphere API 5.5

P Required privilege: vffsUuid

Return Value

Type | Description
--- | ---
None

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

# DeleteVmfsVolumeState

Required Privileges
  Host.Config.Storage
Since
  vSphere API 5.1

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
vmfsUuid P | xsd:string | Since vSphere API 5.0

P Required privilege: vmfsUuid

Return Value

Type | Description
--- | ---
None

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

# DestroyVffs

Required Privileges
  Host.Config.Storage
Since
  vSphere API 5.5

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
vffsPath P | xsd:string | Since vSphere API 5.5

P Required privilege: vffsPath

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

# DetachScsiLun

Required Privileges
  Host.Config.Storage
Since
  vSphere API 5.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
lunUuid P | xsd:string | Since vSphere API 5.0

P Required privilege: lunUuid

Return Value

Type | Description
--- | ---
None

Faults

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

# DetachScsiLunEx_Task

Required Privileges
  Host.Config.Storage
Since
  vSphere API 6.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
lunUuid P | xsd:string[] | Since vSphere API 6.0

P Required privilege: lunUuid

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

# DisableMultipathPath

Required Privileges
  Host.Config.Storage

Parameters

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

P Required privilege: pathName

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

# DisconnectNvmeController

Required Privileges
  Host.Config.Storage
Since
  vSphere API 7.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
disconnectSpec P | HostNvmeDisconnectSpec | Since vSphere API 7.0

P Required privilege: disconnectSpec

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

# DisconnectNvmeControllerEx_Task

Required Privileges
  Host.Config.Storage
Since
  vSphere API 7.0.3.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
disconnectSpec* P | HostNvmeDisconnectSpec[] | 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 |
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

# DiscoverFcoeHbas

Deprecated.

Required Privileges
  Host.Config.Storage
Since
  vSphere API 5.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
fcoeSpec P | FcoeConfigFcoeSpecification | Since vSphere API 5.0

P Required privilege: fcoeSpec

Return Value

Type | Description
--- | ---
None

Faults

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

# DiscoverNvmeControllers

Required Privileges
  Host.Config.Storage
Since
  vSphere API 7.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
discoverSpec P | HostNvmeDiscoverSpec | Since vSphere API 7.0

P Required privilege: discoverSpec

Return Value

Type | Description
--- | ---
HostNvmeDiscoveryLog |

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

# EnableMultipathPath

Required Privileges
  Host.Config.Storage

Parameters

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

P Required privilege: pathName

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

# ExpandVmfsExtent

Required Privileges
  Host.Config.Storage
Since
  vSphere API 4.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
vmfsPath P | xsd:string | Since vSphere API 4.0
extent P | HostScsiDiskPartition | Since vSphere API 4.0

P Required privilege - see tooltip for details

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

# ExtendVffs

Required Privileges
  Host.Config.Storage
Since
  vSphere API 5.5

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
vffsPath P | xsd:string | Since vSphere API 5.5
devicePath P | xsd:string | Since vSphere API 5.5
spec* P | HostDiskPartitionSpec | Since vSphere API 5.5

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

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

# FormatVffs

Required Privileges
  Host.Config.Storage
Since
  vSphere API 5.5

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
createSpec P | HostVffsSpec | Since vSphere API 5.5

P Required privilege: createSpec

Return Value

Type | Description
--- | ---
HostVffsVolume |

Faults

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

# FormatVmfs

Required Privileges
  Host.Config.Storage

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
createSpec P | HostVmfsSpec | Since null

P Required privilege: createSpec

Return Value

Type | Description
--- | ---
HostVmfsVolume |

Faults

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

# MarkAsLocal_Task

Required Privileges
  Host.Config.Storage
Since
  vSphere API 6.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
scsiDiskUuid P | xsd:string | Since vSphere API 6.0

P Required privilege: scsiDiskUuid

Return Value

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

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

# MarkAsNonLocal_Task

Required Privileges
  Host.Config.Storage
Since
  vSphere API 6.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
scsiDiskUuid P | xsd:string | Since vSphere API 6.0

P Required privilege: scsiDiskUuid

Return Value

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

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

# MarkAsNonSsd_Task

Required Privileges
  Host.Config.Storage
Since
  vSphere API 6.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
scsiDiskUuid P | xsd:string | Since vSphere API 6.0

P Required privilege: scsiDiskUuid

Return Value

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

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

# MarkAsSsd_Task

Required Privileges
  Host.Config.Storage
Since
  vSphere API 6.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
scsiDiskUuid P | xsd:string | Since vSphere API 6.0

P Required privilege: scsiDiskUuid

Return Value

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

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

# MarkForRemoval

Deprecated.

Required Privileges
  Host.Config.Storage
Since
  vSphere API 5.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
hbaName P | xsd:string | Since vSphere API 5.0
remove P | xsd:boolean | Since vSphere API 5.0

P Required privilege - see tooltip for details

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

# MarkPerenniallyReserved

Required Privileges
  Host.Config.Storage
Since
  vSphere API 6.7.2

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
lunUuid P | xsd:string | Since vSphere API 6.7.2
state P | xsd:boolean | Since vSphere API 6.7.2

P Required privilege - see tooltip for details

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

# MarkPerenniallyReservedEx_Task

Required Privileges
  Host.Config.Storage
Since
  vSphere API 6.7.2

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
lunUuid* P | xsd:string[] | Since vSphere API 6.7.2
state P | xsd:boolean | Since vSphere API 6.7.2

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

Return Value

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

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

# MountVffsVolume

Required Privileges
  Host.Config.Storage
Since
  vSphere API 5.5

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
vffsUuid P | xsd:string | Since vSphere API 5.5

P Required privilege: vffsUuid

Return Value

Type | Description
--- | ---
None

Faults

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

# MountVmfsVolume

Required Privileges
  Host.Config.Storage
Since
  vSphere API 5.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
vmfsUuid P | xsd:string | Since vSphere API 5.0

P Required privilege: vmfsUuid

Return Value

Type | Description
--- | ---
None

Faults

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

# MountVmfsVolumeEx_Task

Required Privileges
  Host.Config.Storage
Since
  vSphere API 6.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
vmfsUuid P | xsd:string[] | Since vSphere API 6.0

P Required privilege: vmfsUuid

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

# QueryAvailableSsds

Required Privileges
  Host.Config.Storage
Since
  vSphere API 5.5

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
vffsPath* P | xsd:string | Since vSphere API 5.5

*Need not be set P Required privilege: vffsPath

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

# QueryNFSUser

Required Privileges
  Host.Config.Storage
Since
  vSphere API 6.0

Parameters

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

Return Value

Type | Description
--- | ---
HostNasVolumeUserInfo |

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

# QueryPathSelectionPolicyOptions

Required Privileges
  System.Read
Since
  vSphere API 4.0

Parameters

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

Return Value

Type | Description
--- | ---
HostPathSelectionPolicyOption[] |

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

# QueryStorageArrayTypePolicyOptions

Required Privileges
  System.Read
Since
  vSphere API 4.0

Parameters

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

Return Value

Type | Description
--- | ---
HostStorageArrayTypePolicyOption[] |

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

# QueryUnresolvedVmfsVolume

Required Privileges
  System.Read
Since
  vSphere API 4.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem 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

# QueryVmfsConfigOption

Required Privileges
  Host.Config.Storage
Since
  vSphere API 6.5

Parameters

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

Return Value

Type | Description
--- | ---
VmfsConfigOption[] |

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

# RefreshStorageSystem

Required Privileges
  Host.Config.Storage

Parameters

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

Return Value

Type | Description
--- | ---
None

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

# RemoveInternetScsiSendTargets

Required Privileges
  Host.Config.Storage

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
iScsiHbaDevice P | xsd:string | Since null
targets P | HostInternetScsiHbaSendTarget[] | Since null
force* P | xsd:boolean | Since null

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

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

# RemoveInternetScsiStaticTargets

Required Privileges
  Host.Config.Storage

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
iScsiHbaDevice P | xsd:string | Since null
targets P | HostInternetScsiHbaStaticTarget[] | Since null

P Required privilege - see tooltip for details

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

# RemoveNvmeOverRdmaAdapter

Required Privileges
  Host.Config.Storage
Since
  vSphere API 7.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
hbaDeviceName P | xsd:string | Since vSphere API 7.0

P Required privilege: hbaDeviceName

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

# RemoveSoftwareAdapter

Required Privileges
  Host.Config.Storage
Since
  vSphere API 7.0.3.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
hbaDeviceName P | xsd:string | Since vSphere API 7.0.3.0

P Required privilege: hbaDeviceName

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

# RescanAllHba

Required Privileges
  Host.Config.Storage

Parameters

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

Return Value

Type | Description
--- | ---
None

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

# RescanHba

Required Privileges
  Host.Config.Storage

Parameters

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

P Required privilege: hbaDevice

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

# RescanVffs

Required Privileges
  Host.Config.Storage
Since
  vSphere API 5.5

Parameters

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

Return Value

Type | Description
--- | ---
None

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

# RescanVmfs

Required Privileges
  Host.Config.Storage

Parameters

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

Return Value

Type | Description
--- | ---
None

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

# ResolveMultipleUnresolvedVmfsVolumes

Required Privileges
  Host.Config.Storage
Since
  vSphere API 4.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
resolutionSpec P | HostUnresolvedVmfsResolutionSpec[] | Since vSphere API 4.0

P Required privilege: resolutionSpec

Return Value

Type | Description
--- | ---
HostUnresolvedVmfsResolutionResult[] |

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

# ResolveMultipleUnresolvedVmfsVolumesEx_Task

Required Privileges
  Host.Config.Storage
Since
  vSphere API 5.5

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
resolutionSpec P | HostUnresolvedVmfsResolutionSpec[] | Since vSphere API 5.5

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.

Events

Type
None

# RetrieveDiskPartitionInfo

Required Privileges
  System.Read

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
devicePath P | xsd:string[] | Since null

P Required privilege: devicePath

Return Value

Type | Description
--- | ---
HostDiskPartitionInfo[] |

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

# SetMultipathLunPolicy

Required Privileges
  Host.Config.Storage

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
lunId P | xsd:string | Since null
policy P | HostMultipathInfoLogicalUnitPolicy | Since null

P Required privilege - see tooltip for details

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

# SetNFSUser

Required Privileges
  Host.Config.Storage
Since
  vSphere API 6.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
user P | xsd:string | Since vSphere API 6.0
password P | xsd:string | Since vSphere API 6.0

P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
None

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

# TurnDiskLocatorLedOff_Task

Required Privileges
  Host.Config.Storage
Since
  vSphere API 6.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
scsiDiskUuids P | xsd:string[] | Since vSphere API 6.0

P Required privilege: scsiDiskUuids

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

# TurnDiskLocatorLedOn_Task

Required Privileges
  Host.Config.Storage
Since
  vSphere API 6.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
scsiDiskUuids P | xsd:string[] | Since vSphere API 6.0

P Required privilege: scsiDiskUuids

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

# UnmapVmfsVolumeEx_Task

Required Privileges
  Host.Config.Storage
Since
  vSphere API 6.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
vmfsUuid P | xsd:string[] | Since vSphere API 6.0

P Required privilege: vmfsUuid

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

# UnmountForceMountedVmfsVolume

Required Privileges
  Host.Config.Storage
Since
  vSphere API 4.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
vmfsUuid P | xsd:string | Since vSphere API 4.0

P Required privilege: vmfsUuid

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

# UnmountVffsVolume

Required Privileges
  Host.Config.Storage
Since
  vSphere API 5.5

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
vffsUuid P | xsd:string | Since vSphere API 5.5

P Required privilege: vffsUuid

Return Value

Type | Description
--- | ---
None

Faults

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

# UnmountVmfsVolume

Required Privileges
  Host.Config.Storage
Since
  vSphere API 5.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
vmfsUuid P | xsd:string | Since vSphere API 5.0

P Required privilege: vmfsUuid

Return Value

Type | Description
--- | ---
None

Faults

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

# UnmountVmfsVolumeEx_Task

Required Privileges
  Host.Config.Storage
Since
  vSphere API 6.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
vmfsUuid P | xsd:string[] | Since vSphere API 6.0

P Required privilege: vmfsUuid

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

# UpdateDiskPartitions

Required Privileges
  Host.Config.Storage

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
devicePath P | xsd:string | Since null
spec P | HostDiskPartitionSpec | Since null

P Required privilege - see tooltip for details

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

# UpdateHppMultipathLunPolicy

Required Privileges
  Host.Config.Storage
Since
  vSphere API 7.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
lunId P | xsd:string | Since vSphere API 7.0
policy P | HostMultipathInfoHppLogicalUnitPolicy | Since vSphere API 7.0

P Required privilege - see tooltip for details

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

# UpdateInternetScsiAdvancedOptions

Required Privileges
  Host.Config.Storage
Since
  vSphere API 4.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
iScsiHbaDevice P | xsd:string | Since vSphere API 4.0
targetSet* P | HostInternetScsiHbaTargetSet | Since vSphere API 4.0
options P | HostInternetScsiHbaParamValue[] | Since vSphere API 4.0

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

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

# UpdateInternetScsiAlias

Required Privileges
  Host.Config.Storage

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
iScsiHbaDevice P | xsd:string | Since null
iScsiAlias P | xsd:string | Since null

P Required privilege - see tooltip for details

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

# UpdateInternetScsiAuthenticationProperties

Required Privileges
  Host.Config.Storage

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
iScsiHbaDevice P | xsd:string | Since null
authenticationProperties P | HostInternetScsiHbaAuthenticationProperties | Since null
targetSet* P | HostInternetScsiHbaTargetSet | Since null

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

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

# UpdateInternetScsiDigestProperties

Required Privileges
  Host.Config.Storage
Since
  vSphere API 4.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
iScsiHbaDevice P | xsd:string | Since vSphere API 4.0
targetSet* P | HostInternetScsiHbaTargetSet | Since vSphere API 4.0
digestProperties P | HostInternetScsiHbaDigestProperties | Since vSphere API 4.0

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

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

# UpdateInternetScsiDiscoveryProperties

Required Privileges
  Host.Config.Storage

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
iScsiHbaDevice P | xsd:string | Since null
discoveryProperties P | HostInternetScsiHbaDiscoveryProperties | Since null

P Required privilege - see tooltip for details

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

# UpdateInternetScsiIPProperties

Required Privileges
  Host.Config.Storage

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
iScsiHbaDevice P | xsd:string | Since null
ipProperties P | HostInternetScsiHbaIPProperties | Since null

P Required privilege - see tooltip for details

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

# UpdateInternetScsiName

Required Privileges
  Host.Config.Storage

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
iScsiHbaDevice P | xsd:string | Since null
iScsiName P | xsd:string | Since null

P Required privilege - see tooltip for details

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

# UpdateScsiLunDisplayName

Required Privileges
  Host.Config.Storage
Since
  vSphere API 4.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
lunUuid P | xsd:string | Since vSphere API 4.0
displayName P | xsd:string | Since vSphere API 4.0

P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
None

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

# UpdateSoftwareInternetScsiEnabled

Required Privileges
  Host.Config.Storage

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
enabled P | xsd:boolean | Since null

P Required privilege: enabled

Return Value

Type | Description
--- | ---
None

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

# UpdateVmfsUnmapBandwidth

Required Privileges
  Host.Config.Storage
Since
  vSphere API 6.7

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
vmfsUuid P | xsd:string | Since vSphere API 6.7
unmapBandwidthSpec P | VmfsUnmapBandwidthSpec | Since vSphere API 6.7

P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
None

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

# UpdateVmfsUnmapPriority

Required Privileges
  Host.Config.Storage
Since
  vSphere API 6.5

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
vmfsUuid P | xsd:string | Since vSphere API 6.5
unmapPriority P | xsd:string | Since vSphere API 6.5

P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
None

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

# UpgradeVmfs

Required Privileges
  Host.Config.Storage

Parameters

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

P Required privilege: vmfsPath

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

# UpgradeVmLayout

Required Privileges
  Host.Config.Storage

Parameters

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

Return Value

Type | Description
--- | ---
None

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