Managed Object - HostStorageSystem(vim.host.StorageSystem)

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


Managed Object Description

This managed object gets and sets configuration information about the host's storage subsystem. The properties and operations are used to configure the host to make storage available for virtual machines. This object contains properties that are specific to ESX Server and general to both the ESX Server system and the hosted architecture.

Properties

Name Type Description
fileSystemVolumeInfoHostFileSystemVolumeInfo

File system volume information for the host. See the FileSystemVolumeInfo data object type for more information.
multipathStateInfo*HostMultipathStateInfo

Runtime information about the state of a multipath path. A null value will be returned if path state information is not available for this system.

In systems prior to the plug-store architecture, the state of a path may be accessible on the HostMultipathInfo data object of the StorageDeviceInfo property.

Since vSphere API 4.0
storageDeviceInfo*HostStorageDeviceInfo

Host storage information up to the device level.
systemFile*xsd:string[]

Datastore paths of files used by the host system on mounted volumes, for instance, the COS vmdk file of the host. For information on datastore paths, see Datastore.

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, DeleteScsiLunState, DeleteVffsVolumeState, DeleteVmfsVolumeState, DestroyVffs, DetachScsiLun, DetachScsiLunEx_Task, DisableMultipathPath, DiscoverFcoeHbas, EnableMultipathPath, ExpandVmfsExtent, ExtendVffs, FormatVffs, FormatVmfs, MarkAsLocal_Task, MarkAsNonLocal_Task, MarkAsNonSsd_Task, MarkAsSsd_Task, MarkForRemoval, MountVffsVolume, MountVmfsVolume, MountVmfsVolumeEx_Task, QueryAvailableSsds, QueryNFSUser, QueryPathSelectionPolicyOptions, QueryStorageArrayTypePolicyOptions, QueryUnresolvedVmfsVolume, QueryVmfsConfigOption, RefreshStorageSystem, RemoveInternetScsiSendTargets, RemoveInternetScsiStaticTargets, RescanAllHba, RescanHba, RescanVffs, RescanVmfs, ResolveMultipleUnresolvedVmfsVolumes, ResolveMultipleUnresolvedVmfsVolumesEx_Task, RetrieveDiskPartitionInfo, SetMultipathLunPolicy, SetNFSUser, TurnDiskLocatorLedOff_Task, TurnDiskLocatorLedOn_Task, UnmapVmfsVolumeEx_Task, UnmountForceMountedVmfsVolume, UnmountVffsVolume, UnmountVmfsVolume, UnmountVmfsVolumeEx_Task, UpdateDiskPartitions, UpdateInternetScsiAdvancedOptions, UpdateInternetScsiAlias, UpdateInternetScsiAuthenticationProperties, UpdateInternetScsiDigestProperties, UpdateInternetScsiDiscoveryProperties, UpdateInternetScsiIPProperties, UpdateInternetScsiName, UpdateScsiLunDisplayName, UpdateSoftwareInternetScsiEnabled, UpdateVmfsUnmapBandwidth, UpdateVmfsUnmapPriority, UpgradeVmfs, UpgradeVmLayout
Methods inherited from ExtensibleManagedObject
setCustomValue

AddInternetScsiSendTargets(addInternetScsiSendTargets)

Adds Send Target entries to the host bus adapter discovery list. The DiscoveryProperties.sendTargetsDiscoveryEnabled flag must be set to true.
Required Privileges
Host.Config.Storage

Parameters

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

The device of the Internet SCSI HBA adapter.

Since 2.0
targets PHostInternetScsiHbaSendTarget[]

An array of iSCSI send targets.

Since 2.0
PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for all other configuration failures.
NotFoundThrown if the discovery list could not be found.
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

Show WSDL type definition



AddInternetScsiStaticTargets(addInternetScsiStaticTargets)

Adds Static Target entries to the host bus adapter discovery list. The DiscoveryProperty.staticTargetDiscoveryEnabled must be set to true.
Required Privileges
Host.Config.Storage

Parameters

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

The device of the Internet SCSI HBA adapter.

Since 2.0
targets PHostInternetScsiHbaStaticTarget[]

An array of iSCSI static targets to add.

Since 2.0
PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for all other configuration failures.
NotFoundThrown if the host bus adaptor discovery list was not found.
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

Show WSDL type definition



AttachScsiLun(attachScsiLun)

Allow I/O issue to the specified detached ScsiLun. The ScsiLun is administratively configured on, if the attach operation is successful. See DetachScsiLun.

attachScsiLun is part of the Unmount, Detach workflow used when a device will be permanently removed. See also 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.
lunUuid Pxsd:string

The uuid of the ScsiLun to update.

Since vSphere API 5.0
P Required privilege: lunUuid

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for all other configuration failures.
InvalidStateThrown if
NotFoundThrown if the device could not be found.
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

Show WSDL type definition



AttachScsiLunEx_Task(attachScsiLunEx)

Attach one or more SCSI LUNs. This is an asynchronous, batch operation of attachScisLun. Please see AttachScsiLun for operational details.
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[]

each element specifies UUID of LUN to be attached.

Since vSphere API 6.0
P Required privilege: lunUuid

Return Value

Type Description
ManagedObjectReference
to a Task

Faults

Type Description
HostConfigFaultThrown for host configuration failures.
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(attachVmfsExtent)

Extends a VMFS by attaching a disk partition as an extent.
Required Privileges
Host.Config.Storage

Parameters

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

The path of the VMFS to extend. See FileSystemMountInfo.

Since 2.0
extent PHostScsiDiskPartition

A data object that describes the specification of a Disk partition.

Since 2.0
PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for all other configuration failures.
NotFoundThrown if the VMFS cannot be found or is unmounted.
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

Show WSDL type definition



ChangeNFSUserPassword(changeNFSUserPassword)

Change password for existing NFS user. This method shall be called after the NFS user has been created on the host.
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

New password.

Since vSphere API 6.0
P Required privilege: password

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultUnable to set passwords due to host configuration problem.
NotFoundNFS user is not set.
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

Show WSDL type definition



ClearNFSUser(clearNFSUser)

Clear the NFS user configured on the esx host
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
HostConfigFaultUnable to clear NFS user due to host configuration problem.
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

Show WSDL type definition



ComputeDiskPartitionInfo(computeDiskPartitionInfo)

Computes the disk partition information given the desired disk layout. The server computes a new partition information object for a specific disk representing the desired layout.
See HostDiskPartitionInfoPartitionFormat
Required Privileges
Host.Config.Storage

Parameters

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

The name of the device path for the specific disk.
See HostDiskPartitionInfoPartitionFormat

Since 2.0
layout PHostDiskPartitionLayout

A data object that describes the disk partition layout.
See HostDiskPartitionInfoPartitionFormat

Since 2.0
partitionFormat* Pxsd:string

Specifies the desired partition format to be computed from the block range. If partitionFormat is not specified, the existing partitionFormat on disk is used, if the disk is not blank and mbr otherwise.
See HostDiskPartitionInfoPartitionFormat

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

Return Value

Type Description
HostDiskPartitionInfoA data object that contains information about the partitions on a disk

Faults

Type Description
HostConfigFaultThrown if unable to get the current partition information for the device.
See HostDiskPartitionInfoPartitionFormat
NotFoundThrown if the device could not be found.
See HostDiskPartitionInfoPartitionFormat
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

Show WSDL type definition



ComputeDiskPartitionInfoForResize(computeDiskPartitionInfoForResize)

Computes the disk partition information for the purpose of resizing a given partition.
See HostDiskPartitionInfoPartitionFormat
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

The disk partition to resize.
See HostDiskPartitionInfoPartitionFormat

Since vSphere API 4.0
blockRange PHostDiskPartitionBlockRange

Specifies the desired block range for the resized partition. The start of the block range specified should match that of the current partition.
See HostDiskPartitionInfoPartitionFormat

Since vSphere API 4.0
partitionFormat* Pxsd:string

Specifies the desired partition format to be computed from the block range. If partitionFormat is not specified, the existing partitionFormat on disk is used, if the disk is not blank and mbr otherwise.
See HostDiskPartitionInfoPartitionFormat

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

Return Value

Type Description
HostDiskPartitionInforesized disk partition information

Faults

Type Description
HostConfigFaultThrown if unable to get the current partition information for the device.
See HostDiskPartitionInfoPartitionFormat
NotFoundThrown if the device could not be found.
See HostDiskPartitionInfoPartitionFormat
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

Show WSDL type definition



DeleteScsiLunState(deleteScsiLunState)

For previously detached SCSI Lun, remove the state information from host. Detach SCSI Lun marks the device where I/Os are not allowed. Host still maintains the entry of this device and its state. If a LUN is detached using detachScsiLun, ESX will not automatically attach this LUN durng a rescan or after a reboot. See DetachScsiLun. Please note: The API takes 'canonicalName' of the ScsiLun object instead of the ScsiLun.uuid.
See canonicalName
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

The 'canonicalName' of the ScsiLun whose state needs to be deleted.
See canonicalName

Since vSphere API 5.0
P Required privilege: lunCanonicalName

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for any configuration failures.
See canonicalName
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

Show WSDL type definition



DeleteVffsVolumeState(deleteVffsVolumeState)

For previously unmounted VFFS volume, remove the state information from host. VFFS volumes mount state is maintained by host.

deleteVffsVolumeState is part of the Unmount/Detach workflow used when the device will be permanently removed. See also UnmountVffsVolume. If the VFFS volume is unmounted using unmountVffsVolume, ESX maintains the state of VFFS volume. This API will remove the state from the host. If the underlying storage device is going to be un-provisioned on the array side, please detach the storage device. See also DetachScsiLun.

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

The VFFS UUID.

Since vSphere API 5.5
P Required privilege: vffsUuid

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for any configuration failures.
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

Show WSDL type definition



DeleteVmfsVolumeState(deleteVmfsVolumeState)

For previously unmounted VMFS volume, remove the state information from host. VMFS volumes mount state is maintained by host.

deleteVmfsVolumeState is part of the Unmount/Detach workflow used when the device will be permanently removed. See also UnmountVmfsVolume. If the VMFS volume is unmounted using unmountVmfsVolume, ESX maintains the state of VMFS volume. This API will remove the state from the host. If the underlying storage device is going to be un-provisioned on the array side, please detach the storage device. See also DetachScsiLun.

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

The VMFS UUID.

Since vSphere API 5.0
P Required privilege: vmfsUuid

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for any configuration failures.
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

Show WSDL type definition



DestroyVffs(destroyVffs)

Destroy a VFFS volume.
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

The path of the VFFS to destroy. See FileSystemMountInfo.

Since vSphere API 5.5
P Required privilege: vffsPath

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for all other configuration failures.
NotFoundThrown if the VFFS cannot be found or is unmounted.
ResourceInUseVFFS volume is being used.
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

Show WSDL type definition



DetachScsiLun(detachScsiLun)

Disallow I/O issue to the specified ScsiLun. The ScsiLun is detached, i.e. administratively configured off until a subsequent attachScsiLun is performed, if the operation is successful. See AttachScsiLun.

detachScsiLun is part of the Unmount / Detach workflow used when a device will be permanently removed. See also 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.
lunUuid Pxsd:string

The uuid of the ScsiLun device to detach.

Since vSphere API 5.0
P Required privilege: lunUuid

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for all other configuration failures.
InvalidStateThrown if
NotFoundThrown if the device could not be found.
ResourceInUseThrown if
  • This device is backing a Vm with a Raw Device Mapped Virtual Disk.
  • 1 or more programs have I/O outstanding on this device.
  • 1 or more mounted vmfs volumes have extents residing on this device.
  • The device is configured for use by the host e.g. diagnostic partition is configured on this device.
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

Show WSDL type definition



DetachScsiLunEx_Task(detachScsiLunEx)

Detach one or more SCSI LUNs. This is an asynchronous, batch operation of detachScisLun. Please see DetachScsiLun for operational details.
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[]

each element specifies UUID of LUN to be detached.

Since vSphere API 6.0
P Required privilege: lunUuid

Return Value

Type Description
ManagedObjectReference
to a Task

Faults

Type Description
HostConfigFaultThrown for host configuration failures.
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(disableMultipathPath)

Disables an enabled path for a Logical Unit. Use the path name from HostMultipathStateInfoPath or HostMultipathInfoPath.
Required Privileges
Host.Config.Storage

Parameters

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

The name of the path to disable.

Since 2.0
P Required privilege: pathName

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for all other configuration failures.
NotFoundThrown if the LUN could not be found.
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

Show WSDL type definition



DiscoverFcoeHbas(discoverFcoeHbas)

Initiates FCoE discovery using the given FcoeSpecification. Upon success, discovered VNPorts will have registered with the system as FCoE HBAs.
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
HostConfigFaultThrown if the host is unable to issue FCoE discovery.
NotFoundThrown if the given HBA could not be found.
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

Show WSDL type definition



EnableMultipathPath(enableMultipathPath)

Enables a disabled path for a Logical Unit. Use the path name from HostMultipathStateInfoPath or HostMultipathInfoPath.
Required Privileges
Host.Config.Storage

Parameters

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

The name of the path to enable.

Since 2.0
P Required privilege: pathName

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for all other configuration failures.
NotFoundThrown if the LUN could not be found.
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

Show WSDL type definition



ExpandVmfsExtent(expandVmfsExtent)

Expands a VMFS extent as specified by the Disk partition specification.
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

The path of the VMFS to expand. See FileSystemMountInfo.

Since vSphere API 4.0
extent PHostScsiDiskPartition

The disk partition corresponding to the extent to be expanded.

Since vSphere API 4.0
PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for all other configuration failures.
NotFoundThrown if the VMFS cannot be found or is unmounted.
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

Show WSDL type definition



ExtendVffs(extendVffs)

Extends a VFFS by attaching a SSD.
See devicePath
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

The path of the VFFS to extend. See FileSystemMountInfo.
See devicePath

Since vSphere API 5.5
devicePath Pxsd:string

Device path of the SSD disk.
See devicePath

Since vSphere API 5.5
spec* PHostDiskPartitionSpec

A data object that describes the SSD disk partition information. If this property is not provided, partition information will be computed and generated.
See devicePath

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

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for all other configuration failures.
See devicePath
NotFoundThrown if the VFFS cannot be found or is unmounted.
See devicePath
ResourceInUseVFFS volume is being used.
See devicePath
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

Show WSDL type definition



FormatVffs(formatVffs)

Format a new VFFS on a SSD disk
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

A data object that describes the VFFS volume creation specification.

Since vSphere API 5.5
P Required privilege: createSpec

Return Value

Type Description
HostVffsVolumeA data object that represents the VFFS file system.

Faults

Type Description
AlreadyExistsThrown if the volume name is already being used by another volume on the host.
HostConfigFaultThrown for all other configuration failures.
ResourceInUseVFFS volume is being used.
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

Show WSDL type definition



FormatVmfs(formatVmfs)

Formats a new VMFS on a disk partition.
Required Privileges
Host.Config.Storage

Parameters

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

A data object that describes the VMware File System (VMFS) creation specification.

Since 2.0
P Required privilege: createSpec

Return Value

Type Description
HostVmfsVolumeA data object that represents the VMFS file system.

Faults

Type Description
AlreadyExistsThrown if the volume name is already being used by another volume on the host.
HostConfigFaultThrown for all other configuration failures.
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

Show WSDL type definition



MarkAsLocal_Task(markAsLocal)

Mark a disk to local disk, due to the reason that local disks behind some controllers might not be recongized as local correctly. Task failure might lose existing claim rules on the disk.
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

The SCSI disk UUID.

Since vSphere API 6.0
P Required privilege: scsiDiskUuid

Return Value

Type Description
ManagedObjectReference
to a Task

Faults

Type Description
HostConfigFaultThrown for all other configuration failures.
NotFoundThrown if the device could not be found.
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(markAsNonLocal)

Mark a disk to remote disk, which is the opposite operation of MarkAsLocal_Task Task failure might lose existing claim rules on the disk.
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

The SCSI disk UUID.

Since vSphere API 6.0
P Required privilege: scsiDiskUuid

Return Value

Type Description
ManagedObjectReference
to a Task

Faults

Type Description
HostConfigFaultThrown for all other configuration failures.
NotFoundThrown if the device could not be found.
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(markAsNonSsd)

Mark a disk to Non-SSD, which is the opposite operation of MarkAsSsd_Task Task failure might lose existing claim rules on the disk.
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

The SCSI disk UUID.

Since vSphere API 6.0
P Required privilege: scsiDiskUuid

Return Value

Type Description
ManagedObjectReference
to a Task

Faults

Type Description
HostConfigFaultThrown for all other configuration failures.
NotFoundThrown if the device could not be found.
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(markAsSsd)

Mark a disk to SSD, due to the reason that SSDs behind some controllers might not be recongized as SSD correctly. Task failure might lose existing claim rules on the disk.
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

The SCSI disk UUID.

Since vSphere API 6.0
P Required privilege: scsiDiskUuid

Return Value

Type Description
ManagedObjectReference
to a Task

Faults

Type Description
HostConfigFaultThrown for all other configuration failures.
NotFoundThrown if the device could not be found.
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(markForRemoval)

Mark or unmark the given FCoE HBA for removal from the host system. Marking an FCoE HBA for removal will result in the HBA not being discovered upon host reboot. Until reboot, the HBA remains visible in the storage topology.
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
HostConfigFaultThrown if the host does not support removing the given HBA.
NotFoundThrown if the given HBA could not be found.
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

Show WSDL type definition



MountVffsVolume(mountVffsVolume)

Mount the unmounted VFFS volume. See UnmountVffsVolume.

mountVffsVolume is part of the Unmount / Detach workflow used when a device will be permanently removed. See also DetachScsiLun.

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
HostConfigFaultThrown for all other configuration failures.
InvalidStateThrown if
  • The volume is already mounted.
  • The volume is inaccessible.
NotFoundThrown if VFFS uuid is not found on the host.
ResourceInUseVFFS volume is being used.
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

Show WSDL type definition



MountVmfsVolume(mountVmfsVolume)

Mount the unmounted Vmfs volume. A newly discovered vmfs volume will be mounted unless, it has been explicitly unmounted. The default mount behavior of Vmfs volumes is auto-mount. See UnmountVmfsVolume.

mountVmfsVolume is part of the Unmount / Detach workflow used when a device will be permanently removed. See also 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.
vmfsUuid Pxsd:string

Since vSphere API 5.0
P Required privilege: vmfsUuid

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for all other configuration failures.
InvalidStateThrown if
  • The volume is already mounted.
  • The volume is inaccessible.
NotFoundThrown if VMFS Uuid is not found on the host.
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

Show WSDL type definition



MountVmfsVolumeEx_Task(mountVmfsVolumeEx)

Mount one or more VMFS volumes. This is an asynchronous, batch operation of mountVmfsVolume. Please see MountVmfsVolume for operational details.
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[]

each element specifies the UUID of a VMFS volume to be unmounted.

Since vSphere API 6.0
P Required privilege: vmfsUuid

Return Value

Type Description
ManagedObjectReference
to a Task

Faults

Type Description
HostConfigFaultThrown for host configuration failures.
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(queryAvailableSsds)

Query the list SSD disks that can be used to contain a VFFS volume. If the optional parameter name is supplied, queries for the SSD disks that can be used to contain extents of the specified VFFS volume. Otherwise, the method retrieves the SSD disks that can be used to contain the new VFFS volume.

This operation will filter out SSD disks that are currently in use by an existing VFFS volume.

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

The path of the VFFS to extend. See FileSystemMountInfo.

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

Return Value

Type Description
HostScsiDisk[]An array of data objects descrbing SSD disks.

Faults

Type Description
HostConfigFaultThrown if unable to query disk information.
NotFoundThrown if the named VFFS volume is not found.
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

Show WSDL type definition



QueryNFSUser(queryNFSUser)

Query the NFS user configured on the esx host
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
HostNasVolumeUserInfoUserInfo objects. See HostNasVolumeUserInfo

Faults

Type Description
HostConfigFaultUnable to get NFS user due to host configuration problem.
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

Show WSDL type definition



QueryPathSelectionPolicyOptions(queryPathSelectionPolicyOptions)

Queries the set of path selection policy options. The set of policy options indicates what path selection policies can be used by a device managed by native multipathing. Devices managed through native multipathing are described in the HostMultipathInfo data object.

Filtering capabilities are not currently present but may be added in the future.

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[]The list of path selection policy descriptions that match the search criteria. Details about the policies will also be provided in accordance to the query specification.

Faults

Type Description
HostConfigFaultThrown for system configuration failures.
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

Show WSDL type definition



QueryStorageArrayTypePolicyOptions(queryStorageArrayTypePolicyOptions)

Queries the set of storage array type policy options. The set of policy options indicates what storage array type policies can be used by a device managed by native multipathing. Devices managed through native multipathing are described in the HostMultipathInfo data object.

Filtering capabilities are not currently present but may be added in the future.

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[]The list of storage array type policy descriptions.

Faults

Type Description
HostConfigFaultThrown for system configuration failures.
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

Show WSDL type definition



QueryUnresolvedVmfsVolume(queryUnresolvedVmfsVolume)

Get the list of unbound VMFS volumes. For sharing a volume across hosts, a VMFS volume is bound to its underlying block device storage. When a low level block copy is performed to copy or move the VMFS volume, the copied volume will be unbound.
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[]An array of unbound VMFS volumes.

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

Show WSDL type definition



QueryVmfsConfigOption(queryVmfsConfigOption)

Get the VMFS configuration options, including block size, unmap granularity.
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[]VMFS configuration options.

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

Show WSDL type definition



RefreshStorageSystem(refresh)

Obtains the latest host storage information related to storage devices, topology, and file systems. The ESX host updates its storage information asynchronously.

This method may update the following inventory elements:

The Server performs asynchronous updates to the inventory. Use the PropertyCollector.WaitForUpdatesEx method to obtain the property changes.

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

Show WSDL type definition



RemoveInternetScsiSendTargets(removeInternetScsiSendTargets)

Removes Send Target entries from the host bus adapter discovery list. The DiscoveryProperty.sendTargetsDiscoveryEnabled must be set to true. If any of the targets provided as parameters are not found in the existing list, the other targets are removed and an exception is thrown.
Required Privileges
Host.Config.Storage

Parameters

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

The device of the Internet SCSI HBA adapter.

Since 2.0
targets PHostInternetScsiHbaSendTarget[]

An array of iSCSI send targets to remove.

Since 2.0
PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for all other configuration failures.
NotFoundThrown if at least one target was not found.
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

Show WSDL type definition



RemoveInternetScsiStaticTargets(removeInternetScsiStaticTargets)

Removes static target entries from the host bus adapter discovery list. The DiscoveryProperty.staticTargetDiscoveryEnabled must be set to true. If any of the targets provided as parameters are not found in the existing list, the other targets are removed and an exception is thrown.
Required Privileges
Host.Config.Storage

Parameters

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

The device of the Internet SCSI HBA adapter.

Since 2.0
targets PHostInternetScsiHbaStaticTarget[]

An array of iSCSI static targets to remove.

Since 2.0
PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for all other configuration failures.
NotFoundThrown if at least one target was not found.
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

Show WSDL type definition



RescanAllHba(rescanAllHba)

Scans all host bus adapters to obtain the current list of devices and device topology. The RescanAllHba method looks for new devices, removed devices, and path changes.

This method may update the following inventory elements:

The Server performs asynchronous updates to the inventory. Use the PropertyCollector.WaitForUpdatesEx method to obtain the property changes.

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
HostConfigFaultThrown if rescan failed.
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

Show WSDL type definition



RescanHba(rescanHba)

Issues a request to rescan a specific host bus adapter for new storage devices.
Required Privileges
Host.Config.Storage

Parameters

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

The device of the host bus adapter.

Since 2.0
P Required privilege: hbaDevice

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for all other configuration failures.
NotFoundThrown if the host bus adapter cannot be found.
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

Show WSDL type definition



RescanVffs(rescanVffs)

Rescans for new VFFS. The RefreshStorageSystem method also performs a VFFS rescan.

RescanVffs may update the HostSystem.Config.fileSystemVolume property. The Server performs asynchronous updates to the inventory. Use the PropertyCollector.WaitForUpdatesEx method to obtain the property changes.

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
HostConfigFaultThrown if configuration fails.
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

Show WSDL type definition



RescanVmfs(rescanVmfs)

Rescans for new Virtual Machine File Systems (VMFS). The RefreshStorageSystem method also performs a VMFS rescan.

RescanVmfs may update the HostSystem.Config.fileSystemVolume property. The Server performs asynchronous updates to the inventory. Use the PropertyCollector.WaitForUpdatesEx method to obtain the property changes.

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
HostConfigFaultThrown if configuration fails.
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

Show WSDL type definition



ResolveMultipleUnresolvedVmfsVolumes(resolveMultipleUnresolvedVmfsVolumes)

Resignature or 'Force Mount' list of unbound VMFS volumes. To safely enable sharing of the volume across hosts, a VMFS volume is bound to its underlying block device storage. When a low level block copy is performed to copy or move the VMFS volume, the copied volume will be unbound. In order for the VMFS volume to be usable, a resolution operation is needed to determine whether the VMFS volume should be treated as a new volume or not and what extents compose that volume in the event there is more than one unbound volume.

Resignature results in a new VMFS volume on the host. Operations performed at the StorageSystem interface apply only to a specific host. Hence, callers of this method are responsible for issuing rescan operations to detect the new VMFS volume on other hosts. Alternatively, callers that want VirtualCenter to handle rescanning the necessary hosts should use the DatastoreSystem interface.

When user wants to keep the original Vmfs Uuid and mount it on the host, set the 'resolutionSpec.uuidResolution' to 'forceMounted' This is per-host operation. It will return an array of ResolutionResult describing success or failure associated with each specification.

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[]

List of data object that describes what the disk extents to be used for creating the new VMFS volume.

Since vSphere API 4.0
P Required privilege: resolutionSpec

Return Value

Type Description
HostUnresolvedVmfsResolutionResult[]A data object that represents the VMFS file system and return status value.

Faults

Type Description
HostConfigFaultThrown if batch operation fails on the host. Because the returned array of ResolutionResult contains the new VMFS volume or fault for each operation, as of vSphere API 5.x, we won't throw fault when batch operation fails.
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

Show WSDL type definition



ResolveMultipleUnresolvedVmfsVolumesEx_Task(resolveMultipleUnresolvedVmfsVolumesEx)

Resignature or 'Force Mount' list of unbound VMFS volumes.

To safely enable sharing of the volume across hosts, a VMFS volume is bound to its underlying block device storage. When a low level block copy is performed to copy or move the VMFS volume, the copied volume will be unbound. In order for the VMFS volume to be usable, a resolution operation is needed to determine whether the VMFS volume should be treated as a new volume or not and what extents compose that volume in the event there is more than one unbound volume.

Resignature results in a new VMFS volume on the host. Operations performed at the HostStorageSystem interface apply only to a specific host. Hence, callers of this method are responsible for issuing rescan operations to detect the new VMFS volume on other hosts. Alternatively, callers that want VirtualCenter to handle rescanning the necessary hosts should use the HostDatastoreSystem interface.

When user wants to keep the original VMFS UUID and mount it on the host, set the resolutionSpec.uuidResolution (uuidResolution) to vim.host.UnresolvedVmfsResolutionSpec.VmfsUuidResolution#forceMount. This is per-host operation.

It will return an array of HostUnresolvedVmfsResolutionResult describing success or failure associated with each specification.

This method behaves the same as ResolveMultipleUnresolvedVmfsVolumes except that it returns a task to support monitoring the operation. This is important for operations with large number of unresolved volumes which may take potentially dozens of minutes to complete.

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[]

List of data object that describes what the disk extents to be used for creating the new VMFS volume.

Since vSphere API 5.5
P Required privilege: resolutionSpec

Return Value

Type Description
ManagedObjectReference
to a Task
This method returns a Task object with which to monitor the operation. The result property in the Task contains an array of HostUnresolvedVmfsResolutionResult describing success or failure associated with each specification.

Faults

Type Description
HostConfigFaultThrown if batch operation fails on the host. Because the returned array of ResolutionResult contains the new VMFS volume or fault for each operation, as of vSphere API 5.x, we won't throw fault when batch operation fails.
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(retrieveDiskPartitionInfo)

Gets the partition information for the disks named by the device names.
Required Privileges
System.Read

Parameters

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

An array of device path names that identify disks. See ScsiDisk.

Since 2.0
P Required privilege: devicePath

Return Value

Type Description
HostDiskPartitionInfo[]An array of information about the partitions.

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

Show WSDL type definition



SetMultipathLunPolicy(setMultipathLunPolicy)

Updates the path selection policy for a Logical Unit. Use the LUN uuid from HostMultipathInfoLogicalUnit.
Required Privileges
Host.Config.Storage

Parameters

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

The logical unit ID

Since 2.0
policy PHostMultipathInfoLogicalUnitPolicy

A data object that describes a path selection policy for the logical unit.

Since 2.0
PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for all other configuration failures.
NotFoundThrown if the LUN could not be found.
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

Show WSDL type definition



SetNFSUser(setNFSUser)

Set NFS username and password on the host. The specified password is stored encrypted at the host and overwrites any previous password configuration. This information is only needed when the host has mounted NFS volumes with security types that require user credentials for accessing data. The password is used to acquire credentials that the NFS client needs to use in order to secure NFS traffic using RPCSECGSS. The client will access files on all volumes mounted on this host (that are mounted with the relevant security type) on behalf of specified user.

At present, this API supports only file system NFSv4.1.

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

User to be saved on the the esx host

Since vSphere API 6.0
password Pxsd:string

Password for the user.

Since vSphere API 6.0
PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultUnable to set user/passwords due to host configuration problem.
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

Show WSDL type definition



TurnDiskLocatorLedOff_Task(turnDiskLocatorLedOff)

Turn off one or more disk locator LEDs. This is a batch operation to turn off one or more disk locator LEDs, which is the opposite operation of 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[]

The SCSI disk UUIDs for which the disk locator LED should be turned off.

Since vSphere API 6.0
P Required privilege: scsiDiskUuids

Return Value

Type Description
ManagedObjectReference
to a Task

Faults

Type Description
HostConfigFaultThrown for host configuration failures.
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(turnDiskLocatorLedOn)

Turn on one or more disk locator LEDs, duration is the maximum that hardware can support. This is a batch operation to turn on one or more disk locator LEDs, so that user can easily locate the ScsiDisk on physical infrastructure.
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[]

The SCSI disk UUIDs for which the disk locator LED should be turned on.

Since vSphere API 6.0
P Required privilege: scsiDiskUuids

Return Value

Type Description
ManagedObjectReference
to a Task

Faults

Type Description
HostConfigFaultThrown for host configuration failures.
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(unmapVmfsVolumeEx)

Unmap one or more VMFS volumes. This is an asynchronous, batch operation. The operation unmaps free blocks in each VMFS volume.
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[]

each element specifies the UUID of a VMFS volume to be unmapped.

Since vSphere API 6.0
P Required privilege: vmfsUuid

Return Value

Type Description
ManagedObjectReference
to a Task

Faults

Type Description
HostConfigFaultThrown for host configuration failures.
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(unmountForceMountedVmfsVolume)

Unmount the 'forceMounted' Vmfs volume. When a low level block copy is performed to copy or move the VMFS volume, the copied volume is unresolved. For the VMFS volume to be usable, a resolution operation is applied. As part of resolution operation, user may decide to keep the original VMFS Uuid. Once the resolution is applied, the VMFS volume is mounted on the host for its use. User can unmount the VMFS volume if it is not being used by any registered VMs.
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
HostConfigFaultThrown for all other configuration failures.
NotFoundThrown if VMFS Uuid is not found on the host.
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

Show WSDL type definition



UnmountVffsVolume(unmountVffsVolume)

Unmount the VFFS volume. An unmounted volume cannot be used for any filesystem operation requiring I/O. In contrast to removal, this operation does not destroy or alter partitions on which VFFS volumes reside. The mountState will be persisted across filesystem rescans and host reboots. See MountVffsVolume.

unmountVffsVolume is part of the Unmount / Detach workflow used when a device will be permanently removed. See also DetachScsiLun.

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
HostConfigFaultThrown for all other configuration failures.
InvalidStateThrown if
  • The volume is already unmounted.
  • The volume is inaccessible.
NotFoundThrown if VFFS uuid is not found on the host.
ResourceInUseThrown if
  • 1 or more programs have I/O outstanding on this volume.
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

Show WSDL type definition



UnmountVmfsVolume(unmountVmfsVolume)

Unmount the Vmfs volume. An unmounted volume cannot be used for any filesystem operation requiring I/O. In contrast to removal, this operation does not destroy or alter partitions on which vmfs volumes reside. The mountState will be persisted across filesystem rescans and host reboots. See MountVmfsVolume.

unmountVmfsVolume is part of the Unmount / Detach workflow used when a device will be permanently removed.

                     Mounted Vmfs Volume
    unmountVmfsVolume  |  ^ mountVmfsVolume
                       V  |
                     Unmounted Vmfs Volume

         Attached Scsi Device (honors I/O)
    detachScsiLun      |  ^ attachScsiLun
                       V  |
  Detached Scsi Device (does not honor I/O)
  

It is safe to unprovision a Lun from the Storage array *only* after a Scsi device is detached.

The best practice for decommisioning a Lun would be to find out the set of subsystems that a Lun is being used for. Many of the systems are listed as exceptions in the function documentation.

One typical workflow could be:

See also 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.
vmfsUuid Pxsd:string

Since vSphere API 5.0
P Required privilege: vmfsUuid

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for all other configuration failures.
InvalidStateThrown if
  • The volume is already unmounted.
  • The volume is inaccessible.
NotFoundThrown if VMFS Uuid is not found on the host.
ResourceInUseThrown if
  • There is any VM registered on this volume.
  • 1 or more programs have I/O outstanding on this volume.
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

Show WSDL type definition



UnmountVmfsVolumeEx_Task(unmountVmfsVolumeEx)

Unmount one or more VMFS volumes. This is an asynchronous, batch operation of unmountVmfsVolume. Please see UnmountVmfsVolume for operational details.
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[]

each element specifies the UUID of a VMFS volume to be unmounted.

Since vSphere API 6.0
P Required privilege: vmfsUuid

Return Value

Type Description
ManagedObjectReference
to a Task

Faults

Type Description
HostConfigFaultThrown for host configuration failures.
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(updateDiskPartitions)

Changes the partitions on the disk by supplying a partition specification and the device name.
Required Privileges
Host.Config.Storage

Parameters

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

The name of the device path for the specific disk.

Since 2.0
spec PHostDiskPartitionSpec

A data object that describes the disk partition table specification used to configure the partitions on a disk.

Since 2.0
PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for all other configuration failures.
NotFoundThrown if the device could not be found.
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

Show WSDL type definition



UpdateInternetScsiAdvancedOptions(updateInternetScsiAdvancedOptions)

Updates the advanced options the iSCSI host bus adapter or the discovery addresses and targets associated with it.
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

The device of the Internet SCSI HBA adapter.

Since vSphere API 4.0
targetSet* PHostInternetScsiHbaTargetSet

The set the targets to configure. If not provided, the settings will be applied to the host bus adapter itself.

Since vSphere API 4.0
options PHostInternetScsiHbaParamValue[]

The list of options to set.

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

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for all other configuration failures.
NotFoundThrown if the host bus adapter could not be found.
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

Show WSDL type definition



UpdateInternetScsiAlias(updateInternetScsiAlias)

Updates the alias of an iSCSI host bus adapter.
Required Privileges
Host.Config.Storage

Parameters

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

The device of the Internet SCSI HBA adapter.

Since 2.0
iScsiAlias Pxsd:string

The new value for the alias of the adapter.

Since 2.0
PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for all other configuration failures.
NotFoundThrown if the host bus adapter could not be found.
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

Show WSDL type definition



UpdateInternetScsiAuthenticationProperties(updateInternetScsiAuthenticationProperties)

Updates the authentication properties for one or more targets or discovery addresses associated with an iSCSI host bus adapter.
Required Privileges
Host.Config.Storage

Parameters

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

The device of the Internet SCSI HBA adapter. associated with the target.

Since 2.0
authenticationProperties PHostInternetScsiHbaAuthenticationProperties

The data object that represents the authentication settings to set.

Since 2.0
targetSet* PHostInternetScsiHbaTargetSet

The set the targets to configure. Optional, when obmitted will configura the authentication properties for the adapter instead.

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

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for all other configuration failures.
NotFoundThrown if the host bus adapter could not be found.
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

Show WSDL type definition



UpdateInternetScsiDigestProperties(updateInternetScsiDigestProperties)

Updates the digest properties for the iSCSI host bus adapter or the discovery addresses and targets associated with it.
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

The device of the Internet SCSI HBA adapter.

Since vSphere API 4.0
targetSet* PHostInternetScsiHbaTargetSet

The set the targets to configure. If not provided, the settings will be applied to the host bus adapter itself.

Since vSphere API 4.0
digestProperties PHostInternetScsiHbaDigestProperties

The data object that represents the digest settings to set.

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

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for all other configuration failures.
NotFoundThrown if the host bus adapter could not be found.
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

Show WSDL type definition



UpdateInternetScsiDiscoveryProperties(updateInternetScsiDiscoveryProperties)

Updates the Discovery properties for an iSCSI host bus adapter.
Required Privileges
Host.Config.Storage

Parameters

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

The device of the Internet SCSI HBA adapter.

Since 2.0
discoveryProperties PHostInternetScsiHbaDiscoveryProperties

The discovery settings for this host bus adapter.

Since 2.0
PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for all other configuration failures.
NotFoundThrown if the host bus adapter could not be found.
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

Show WSDL type definition



UpdateInternetScsiIPProperties(updateInternetScsiIPProperties)

Updates the IP properties for an iSCSI host bus adapter.
Required Privileges
Host.Config.Storage

Parameters

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

The device of the Internet SCSI HBA adapter.

Since 2.0
ipProperties PHostInternetScsiHbaIPProperties

A data object representing the IP properties for the host bus adapter

Since 2.0
PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for all other configuration failures.
NotFoundThrown if the host bus adapter could not be found.
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

Show WSDL type definition



UpdateInternetScsiName(updateInternetScsiName)

Updates the name of an iSCSI host bus adapter.
Required Privileges
Host.Config.Storage

Parameters

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

The current name of the Internet SCSI HBA adapter.

Since 2.0
iScsiName Pxsd:string

The new name for the Internet SCSI HBA adapter

Since 2.0
PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for all other configuration failures.
NotFoundThrown if the host bus adapter could not be found.
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

Show WSDL type definition



UpdateScsiLunDisplayName(updateScsiLunDisplayName)

Update the mutable display name associated with a ScsiLun. The ScsiLun to be updated is identified using the specified uuid.
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

The uuid of the ScsiLun to update.

Since vSphere API 4.0
displayName Pxsd:string

The new name to assign to the ScsiLun object.

Since vSphere API 4.0
PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

Type Description
DuplicateNameThrown if the name does not name uniqueness restrictions. Name uniqueness restrictions will vary based on the context in which this method is invoked.

When this method is invoked on a host directly, no uniqueness checks will be performed on the name.

When this method is invoked on a VC server, uniqueness checks will be performed on the name. The uniqueness check will ensure that the name is unique with respect to the entire VC instance.

HostConfigFaultThrown for all other configuration failures.
InvalidNameThrown if the name does not meet name restrictions such as an 80 character limit.
NotFoundThrown if the device could not be found.
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

Show WSDL type definition



UpdateSoftwareInternetScsiEnabled(updateSoftwareInternetScsiEnabled)

Enables or disables Software iSCSI.
Required Privileges
Host.Config.Storage

Parameters

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

True to enable the iSCSI; false to disable it

Since 2.0
P Required privilege: enabled

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for any configuration failure.
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

Show WSDL type definition



UpdateVmfsUnmapBandwidth(updateVmfsUnmapBandwidth)

Update VMFS unmap bandwidth. This API updates the value of policy, fixedValue, dynamicMin, dynamicMax.
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

The VMFS UUID.

Since vSphere API 6.7
unmapBandwidthSpec PVmfsUnmapBandwidthSpec

Unmap bandwidth specification. See VmfsUnmapBandwidthSpec

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

Show WSDL type definition



UpdateVmfsUnmapPriority(updateVmfsUnmapPriority)

Update VMFS unmap priority. This API updates the value of unmapPriority.
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

The VMFS UUID.

Since vSphere API 6.5
unmapPriority Pxsd:string

Unmap priority. The supported values are defined in HostVmfsVolumeUnmapPriority.

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

Show WSDL type definition



UpgradeVmfs(upgradeVmfs)

Upgrades the VMFS to the supportedVmfsMajorVersion.

Prerequisite:
All hosts that have mounted the volume must support the VMFS version to which the volume will be upgraded.

Required Privileges
Host.Config.Storage

Parameters

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

The path of the VMFS.

Since 2.0
P Required privilege: vmfsPath

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown if the prerequisite is not satisfied or for all other configuration failures.
NotFoundThrown if the VMFS cannot be found or is unmounted.
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

Show WSDL type definition



UpgradeVmLayout(upgradeVmLayout)

Iterates over all registered virtual machines. For each VM which .vmx file is located on the service console and all disks are available on VMFS3 or NAS, it will relocate the disks into directories if stored in the ROOT, and relocate the VMX file into the directory too. Events are logged for each virtual machine that is relocated.

On ESXi systems, this operation has no effect.

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

Show WSDL type definition