# Managed Object - HostStorageSystem(vim.host.StorageSystem)

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
  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
--- | --- | ---
fileSystemVolumeInfo | HostFileSystemVolumeInfo | 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, 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(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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
iScsiHbaDevice P | xsd:string | The device of the Internet SCSI HBA adapter. Since 2.0
targets P | HostInternetScsiHbaSendTarget[] | An array of iSCSI send targets. Since 2.0

PRequired privilege - see tooltip for details

Return Value

Type | Description
--- | ---
None

Faults

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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="AddInternetScsiSendTargets" type="sms:AddInternetScsiSendTargetsRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="AddInternetScsiSendTargetsResponse"> <complexType/> </element>

# 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
iScsiHbaDevice P | xsd:string | The device of the Internet SCSI HBA adapter. Since 2.0
targets P | HostInternetScsiHbaStaticTarget[] | 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
--- | ---
HostConfigFault | Thrown for all other configuration failures.
NotFound | Thrown if the host bus adaptor discovery list was not found.
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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="AddInternetScsiStaticTargets" type="sms:AddInternetScsiStaticTargetsRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="AddInternetScsiStaticTargetsResponse"> <complexType/> </element>

# 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
lunUuid P | xsd: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
--- | ---
HostConfigFault | Thrown for all other configuration failures.
InvalidState | Thrown if The device is already attached. i.e. Device state is not 'off' in operationalState. The device is unreachable. See operationalState.
NotFound | Thrown if the device could not be found.
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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="AttachScsiLun" type="sms:AttachScsiLunRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="AttachScsiLunResponse"> <complexType/> </element>

# 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
lunUuid P | xsd: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 SmsTask |

Faults

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

Extends a VMFS by attaching a disk partition as an extent.

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 | The path of the VMFS to extend. See FileSystemMountInfo. Since 2.0
extent P | HostScsiDiskPartition | 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
--- | ---
HostConfigFault | Thrown for all other configuration failures.
NotFound | Thrown if the VMFS cannot be found or is unmounted.
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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="AttachVmfsExtent" type="sms:AttachVmfsExtentRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="AttachVmfsExtentResponse"> <complexType/> </element>

# 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

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

P Required privilege: password

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
HostConfigFault | Unable to set passwords due to host configuration problem.
NotFound | NFS user is not set.
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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="ChangeNFSUserPassword" type="sms:ChangeNFSUserPasswordRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="ChangeNFSUserPasswordResponse"> <complexType/> </element>

# ClearNFSUser(clearNFSUser)

Clear the NFS user configured on the esx host

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 | Unable to clear NFS user due to host configuration problem.
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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="ClearNFSUser" type="sms:ClearNFSUserRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="ClearNFSUserResponse"> <complexType/> </element>

# 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
devicePath P | xsd:string | The name of the device path for the specific disk. See HostDiskPartitionInfoPartitionFormat Since 2.0
layout P | HostDiskPartitionLayout | A data object that describes the disk partition layout. See HostDiskPartitionInfoPartitionFormat Since 2.0
partitionFormat* P | xsd: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
--- | ---
HostDiskPartitionInfo | A data object that contains information about the partitions on a disk

Faults

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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="ComputeDiskPartitionInfo" type="sms:ComputeDiskPartitionInfoRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="ComputeDiskPartitionInfoResponse"> <complexType> <sequence> <element name="returnval" type="sms:HostDiskPartitionInfo"/> </sequence> </complexType> </element>

# 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
partition P | HostScsiDiskPartition | The disk partition to resize. See HostDiskPartitionInfoPartitionFormat Since vSphere API 4.0
blockRange P | HostDiskPartitionBlockRange | 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* P | xsd: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
--- | ---
HostDiskPartitionInfo | resized disk partition information

Faults

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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="ComputeDiskPartitionInfoForResize" type="sms:ComputeDiskPartitionInfoForResizeRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="ComputeDiskPartitionInfoForResizeResponse"> <complexType> <sequence> <element name="returnval" type="sms:HostDiskPartitionInfo"/> </sequence> </complexType> </element>

# ConnectNvmeController(connectNvmeController)

Establish a connection to an NVME controller.

As a result, all the namespaces attached to the controller will be accessible through the adapter. For more details, see:

- "NVM Express over Fabrics 1.0", Section 3.3, "Connect command and response"

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 | A data object that specifies the parameters necessary to connect to the controller. Since vSphere API 7.0

P Required privilege: connectSpec

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
HostConfigFault | Thrown if the host is unable to establish the connection.
NotFound | Thrown if the given HBA or transport target could not be found.
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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="ConnectNvmeController" type="sms:ConnectNvmeControllerRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="ConnectNvmeControllerResponse"> <complexType/> </element>

# ConnectNvmeControllerEx_Task(connectNvmeControllerEx)

Establish a connection to one or more NVMe controllers.

This is an asynchronous, batch version of the connectNvmeController API. See ConnectNvmeController for details. If supported on the host in question, nvmeBatchOperationsSupported will be set to true. An attempt will be made to establish a connection using each of the provided specifications. There are no transactional guarantees - some of the connections may succeed and some may fail. In case of any failures, a fault containing information about the failed attempts to establish a connection will be thrown.

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[] | A list of data objects, each specifying the parameters necessary to connect to an NVMe controller. Since vSphere API 7.0.3.0

*Need not be set P Required privilege: connectSpec

Return Value

Type | Description
--- | ---
ManagedObjectReference to a SmsTask |

Faults

Type | Description
--- | ---
HostConfigFault | Thrown if any of the attempted connections failed.
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(createNvmeOverRdmaAdapter)

Creates a software NVME over RDMA adapter.

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 | The device name of the RDMA device to be used to create the software adapter. Can be obtained from device. Since vSphere API 7.0

P Required privilege: rdmaDeviceName

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
HostConfigFault | Thrown if the host is unable to create the adapter.
NotFound | Thrown if the given RDMA device could not be found.
ResourceInUse | Thrown if the RDMA device is already in use by an NVME over RDMA adapter.
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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="CreateNvmeOverRdmaAdapter" type="sms:CreateNvmeOverRdmaAdapterRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="CreateNvmeOverRdmaAdapterResponse"> <complexType/> </element>

# CreateSoftwareAdapter(createSoftwareAdapter)

Creates a software host bus adapter based on the provided spec.

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 | A data object that specifices the parameters necessary to create a software host bus adapter of a specific type. Since vSphere API 7.0.3.0

P Required privilege: spec

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
HostConfigFault | Thrown if the host is unable to create the adapter.
NotFound | Thrown if any of the resources specified in the spec could not be found.
ResourceInUse | Thrown if some of the resources specified in the spec and needed for adapter creation is in use
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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="CreateSoftwareAdapter" type="sms:CreateSoftwareAdapterRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="CreateSoftwareAdapterResponse"> <complexType/> </element>

# 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
lunCanonicalName P | xsd: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
--- | ---
HostConfigFault | Thrown for any configuration failures. See canonicalName
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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="DeleteScsiLunState" type="sms:DeleteScsiLunStateRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="DeleteScsiLunStateResponse"> <complexType/> </element>

# 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

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

P Required privilege: vffsUuid

Return Value

Type | Description
--- | ---
None

Faults

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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="DeleteVffsVolumeState" type="sms:DeleteVffsVolumeStateRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="DeleteVffsVolumeStateResponse"> <complexType/> </element>

# 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

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

P Required privilege: vmfsUuid

Return Value

Type | Description
--- | ---
None

Faults

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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="DeleteVmfsVolumeState" type="sms:DeleteVmfsVolumeStateRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="DeleteVmfsVolumeStateResponse"> <complexType/> </element>

# DestroyVffs(destroyVffs)

Destroy a VFFS volume.

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 | 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
--- | ---
HostConfigFault | Thrown for all other configuration failures.
NotFound | Thrown if the VFFS cannot be found or is unmounted.
ResourceInUse | VFFS volume is being used.
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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="DestroyVffs" type="sms:DestroyVffsRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="DestroyVffsResponse"> <complexType/> </element>

# 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
lunUuid P | xsd: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
--- | ---
HostConfigFault | Thrown for all other configuration failures.
InvalidState | Thrown if The device is already detached(turned 'off'). See operationalState.
NotFound | Thrown if the device could not be found.
ResourceInUse | Thrown 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.
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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="DetachScsiLun" type="sms:DetachScsiLunRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="DetachScsiLunResponse"> <complexType/> </element>

# 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
lunUuid P | xsd: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 SmsTask |

Faults

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

Disables an enabled path for a Logical Unit. Use the path name from HostMultipathStateInfoPath or HostMultipathInfoPath.

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 | The name of the path to disable. Since 2.0

P Required privilege: pathName

Return Value

Type | Description
--- | ---
None

Faults

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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="DisableMultipathPath" type="sms:DisableMultipathPathRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="DisableMultipathPathResponse"> <complexType/> </element>

# DisconnectNvmeController(disconnectNvmeController)

Disconnect from an NVME controller.

As a result, all the namespaces attached to the controller will no longer be accessible through the adapter.

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 | A data object that specifies the parameters necessary to perform the disconnection. Since vSphere API 7.0

P Required privilege: disconnectSpec

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
HostConfigFault | Thrown if the host is unable to perform the disconnect.
NotFound | Thrown if the given HBA or controller could not be found.
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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="DisconnectNvmeController" type="sms:DisconnectNvmeControllerRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="DisconnectNvmeControllerResponse"> <complexType/> </element>

# DisconnectNvmeControllerEx_Task(disconnectNvmeControllerEx)

Disconnect from one or more NVMe controllers.

This is an asynchronous, batch version of the disconnectNvmeController API. See DisconnectNvmeController for details. If supported on the host in question, nvmeBatchOperationsSupported will be set to true. An attempt will be made to disconnect a controller using each of the provided specifications. There are no transactional guarantees - some of the disconnections may succeed and some may fail. In case of any failures, a fault containing information about the failed attempts to disconnect a controller will be thrown.

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[] | A list of data objects, each specifying the parameters necessary to disconnect an NVMe controller. Since vSphere API 7.0.3.0

*Need not be set P Required privilege: disconnectSpec

Return Value

Type | Description
--- | ---
ManagedObjectReference to a SmsTask |

Faults

Type | Description
--- | ---
HostConfigFault | Thrown if any of the attempts to disconnect a controller fails.
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(discoverFcoeHbas)

Deprecated. As of vSphere API 8.0. Software FCoE not supported.

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

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 | Thrown if the host is unable to issue FCoE discovery.
NotFound | Thrown if the given HBA could not be found.
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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="DiscoverFcoeHbas" type="sms:DiscoverFcoeHbasRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="DiscoverFcoeHbasResponse"> <complexType/> </element>

# DiscoverNvmeControllers(discoverNvmeControllers)

Connects to a Discovery Controller and retrieves the Discovery Log using the provided NvmeDiscoverSpec.

For more details, see:

- "NVM Express over Fabrics 1.0", Section 5, "Discovery service"

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 | A data object that specifies the parameters necessary to retrieve the Discovery Log. Since vSphere API 7.0

P Required privilege: discoverSpec

Return Value

Type | Description
--- | ---
HostNvmeDiscoveryLog | discoveryLog A data object that represents the Discovery Log.

Faults

Type | Description
--- | ---
HostConfigFault | Thrown if the host is unable to retrieve the discovery log.
NotFound | Thrown if the given HBA or transport target could not be found.
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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="DiscoverNvmeControllers" type="sms:DiscoverNvmeControllersRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="DiscoverNvmeControllersResponse"> <complexType> <sequence> <element name="returnval" type="sms:HostNvmeDiscoveryLog"/> </sequence> </complexType> </element>

# EnableMultipathPath(enableMultipathPath)

Enables a disabled path for a Logical Unit. Use the path name from HostMultipathStateInfoPath or HostMultipathInfoPath.

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 | The name of the path to enable. Since 2.0

P Required privilege: pathName

Return Value

Type | Description
--- | ---
None

Faults

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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="EnableMultipathPath" type="sms:EnableMultipathPathRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="EnableMultipathPathResponse"> <complexType/> </element>

# ExpandVmfsExtent(expandVmfsExtent)

Expands a VMFS extent as specified by the Disk partition specification.

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 | The path of the VMFS to expand. See FileSystemMountInfo. Since vSphere API 4.0
extent P | HostScsiDiskPartition | 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
--- | ---
HostConfigFault | Thrown for all other configuration failures.
NotFound | Thrown if the VMFS cannot be found or is unmounted.
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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="ExpandVmfsExtent" type="sms:ExpandVmfsExtentRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="ExpandVmfsExtentResponse"> <complexType/> </element>

# ExtendVffs(extendVffs)

Extends a VFFS by attaching a SSD.
See devicePath

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 | The path of the VFFS to extend. See FileSystemMountInfo. See devicePath Since vSphere API 5.5
devicePath P | xsd:string | Device path of the SSD disk. See devicePath Since vSphere API 5.5
spec* P | HostDiskPartitionSpec | 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
--- | ---
HostConfigFault | Thrown for all other configuration failures. See devicePath
NotFound | Thrown if the VFFS cannot be found or is unmounted. See devicePath
ResourceInUse | VFFS volume is being used. See devicePath
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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="ExtendVffs" type="sms:ExtendVffsRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="ExtendVffsResponse"> <complexType/> </element>

# FormatVffs(formatVffs)

Format a new VFFS on a SSD disk

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 | A data object that describes the VFFS volume creation specification. Since vSphere API 5.5

P Required privilege: createSpec

Return Value

Type | Description
--- | ---
HostVffsVolume | A data object that represents the VFFS file system.

Faults

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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="FormatVffs" type="sms:FormatVffsRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="FormatVffsResponse"> <complexType> <sequence> <element name="returnval" type="sms:HostVffsVolume"/> </sequence> </complexType> </element>

# FormatVmfs(formatVmfs)

Formats a new VMFS on a disk partition.

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 | A data object that describes the VMware File System (VMFS) creation specification. Since 2.0

P Required privilege: createSpec

Return Value

Type | Description
--- | ---
HostVmfsVolume | A data object that represents the VMFS file system.

Faults

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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="FormatVmfs" type="sms:FormatVmfsRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="FormatVmfsResponse"> <complexType> <sequence> <element name="returnval" type="sms:HostVmfsVolume"/> </sequence> </complexType> </element>

# 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

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

P Required privilege: scsiDiskUuid

Return Value

Type | Description
--- | ---
ManagedObjectReference to a SmsTask |

Faults

Type | Description
--- | ---
HostConfigFault | Thrown for all other configuration failures.
NotFound | Thrown if the device could not be found.
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(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

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

P Required privilege: scsiDiskUuid

Return Value

Type | Description
--- | ---
ManagedObjectReference to a SmsTask |

Faults

Type | Description
--- | ---
HostConfigFault | Thrown for all other configuration failures.
NotFound | Thrown if the device could not be found.
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(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

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

P Required privilege: scsiDiskUuid

Return Value

Type | Description
--- | ---
ManagedObjectReference to a SmsTask |

Faults

Type | Description
--- | ---
HostConfigFault | Thrown for all other configuration failures.
NotFound | Thrown if the device could not be found.
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(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

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

P Required privilege: scsiDiskUuid

Return Value

Type | Description
--- | ---
ManagedObjectReference to a SmsTask |

Faults

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

Deprecated. As of vSphere API 8.0. Software FCoE not supported.

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

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

PRequired privilege - see tooltip for details

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
HostConfigFault | Thrown if the host does not support removing the given HBA.
NotFound | Thrown if the given HBA could not be found.
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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="MarkForRemoval" type="sms:MarkForRemovalRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="MarkForRemovalResponse"> <complexType/> </element>

# MarkPerenniallyReserved(markPerenniallyReserved)

Marks the specified LUN as perennially reserved.

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 | The UUID of the ScsiLun device to be marked as perennially reserved. Since vSphere API 6.7.2
state P | xsd:boolean | State of the ScsiLun perennially reserved flag to be set. Since vSphere API 6.7.2

PRequired privilege - see tooltip for details

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
HostConfigFault | Thrown if unable to change perennially reserved state.
NotFound | Thrown if the device could not be found.
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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="MarkPerenniallyReserved" type="sms:MarkPerenniallyReservedRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="MarkPerenniallyReservedResponse"> <complexType/> </element>

# MarkPerenniallyReservedEx_Task(markPerenniallyReservedEx)

Marks the specified one or more SCSI LUN's perennially reserved based on the sate.

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[] | The UUIDs of the ScsiLun devices that need a change in the perennially reserved flag state. Since vSphere API 6.7.2
state P | xsd:boolean | State of the ScsiLun perennially reserved flag to be set. Since vSphere API 6.7.2

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

Return Value

Type | Description
--- | ---
ManagedObjectReference to a SmsTask |

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(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

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 | Thrown for all other configuration failures.
InvalidState | Thrown if The volume is already mounted. The volume is inaccessible.
NotFound | Thrown if VFFS uuid is not found on the host.
ResourceInUse | VFFS volume is being used.
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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="MountVffsVolume" type="sms:MountVffsVolumeRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="MountVffsVolumeResponse"> <complexType/> </element>

# 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

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 | Thrown for all other configuration failures.
InvalidState | Thrown if The volume is already mounted. The volume is inaccessible.
NotFound | Thrown if VMFS Uuid is not found on the host.
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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="MountVmfsVolume" type="sms:MountVmfsVolumeRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="MountVmfsVolumeResponse"> <complexType/> </element>

# 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
vmfsUuid P | xsd: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 SmsTask |

Faults

Type | Description
--- | ---
HostConfigFault | Thrown for host configuration failures.
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(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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
vffsPath* P | xsd: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
--- | ---
HostConfigFault | Thrown if unable to query disk information.
NotFound | Thrown if the named VFFS volume is not found.
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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="QueryAvailableSsds" type="sms:QueryAvailableSsdsRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="QueryAvailableSsdsResponse"> <complexType> <sequence> <element name="returnval" type="sms:HostScsiDisk" minOccurs="0" maxOccurs="unbounded"/> </sequence> </complexType> </element>

# QueryNFSUser(queryNFSUser)

Query the NFS user configured on the esx host

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 | UserInfo objects. See HostNasVolumeUserInfo

Faults

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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="QueryNFSUser" type="sms:QueryNFSUserRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="QueryNFSUserResponse"> <complexType> <sequence> <element name="returnval" type="sms:HostNasVolumeUserInfo" minOccurs="0"/> </sequence> </complexType> </element>

# 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | 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
--- | ---
HostConfigFault | Thrown for system configuration failures.
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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="QueryPathSelectionPolicyOptions" type="sms:QueryPathSelectionPolicyOptionsRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="QueryPathSelectionPolicyOptionsResponse"> <complexType> <sequence> <element name="returnval" type="sms:HostPathSelectionPolicyOption" minOccurs="0" maxOccurs="unbounded"/> </sequence> </complexType> </element>

# 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | 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
--- | ---
HostConfigFault | Thrown for system configuration failures.
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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="QueryStorageArrayTypePolicyOptions" type="sms:QueryStorageArrayTypePolicyOptionsRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="QueryStorageArrayTypePolicyOptionsResponse"> <complexType> <sequence> <element name="returnval" type="sms:HostStorageArrayTypePolicyOption" minOccurs="0" maxOccurs="unbounded"/> </sequence> </complexType> </element>

# 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | 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
--- | ---
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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="QueryUnresolvedVmfsVolume" type="sms:QueryUnresolvedVmfsVolumeRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="QueryUnresolvedVmfsVolumeResponse"> <complexType> <sequence> <element name="returnval" type="sms:HostUnresolvedVmfsVolume" minOccurs="0" maxOccurs="unbounded"/> </sequence> </complexType> </element>

# QueryVmfsConfigOption(queryVmfsConfigOption)

Get the VMFS configuration options, including block size, unmap granularity.

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[] | VMFS configuration options.

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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="QueryVmfsConfigOption" type="sms:QueryVmfsConfigOptionRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="QueryVmfsConfigOptionResponse"> <complexType> <sequence> <element name="returnval" type="sms:VmfsConfigOption" minOccurs="0" maxOccurs="unbounded"/> </sequence> </complexType> </element>

# 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:

- Devices and storage topology (HostSystem.Config.storageDevice).
- VMFS and NFS datastores (HostSystem.Datastore).
- File system volumes (HostSystem.Config.fileSystemVolume).

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

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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="RefreshStorageSystem" type="sms:RefreshStorageSystemRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="RefreshStorageSystemResponse"> <complexType/> </element>

# 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
iScsiHbaDevice P | xsd:string | The device of the Internet SCSI HBA adapter. Since 2.0
targets P | HostInternetScsiHbaSendTarget[] | An array of iSCSI send targets to remove. Since 2.0
force* P | xsd:boolean | flag for forced removal of iSCSI send targets. If unset, force flag will be treated as false. Since 2.0

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

Return Value

Type | Description
--- | ---
None

Faults

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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="RemoveInternetScsiSendTargets" type="sms:RemoveInternetScsiSendTargetsRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="RemoveInternetScsiSendTargetsResponse"> <complexType/> </element>

# 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
iScsiHbaDevice P | xsd:string | The device of the Internet SCSI HBA adapter. Since 2.0
targets P | HostInternetScsiHbaStaticTarget[] | 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
--- | ---
HostConfigFault | Thrown for all other configuration failures.
NotFound | Thrown if at least one target was not found.
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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="RemoveInternetScsiStaticTargets" type="sms:RemoveInternetScsiStaticTargetsRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="RemoveInternetScsiStaticTargetsResponse"> <complexType/> </element>

# RemoveNvmeOverRdmaAdapter(removeNvmeOverRdmaAdapter)

Removes a software NVME over RDMA adapter.

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 | The device name of the NVME over RDMA adapter to be removed. Since vSphere API 7.0

P Required privilege: hbaDeviceName

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
HostConfigFault | Thrown if the host is unable to remove the given HBA.
NotFound | Thrown if the given HBA could not be found.
ResourceInUse | Thrown if the given HBA is in use.
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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="RemoveNvmeOverRdmaAdapter" type="sms:RemoveNvmeOverRdmaAdapterRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="RemoveNvmeOverRdmaAdapterResponse"> <complexType/> </element>

# RemoveSoftwareAdapter(removeSoftwareAdapter)

Removes a software host bus adapter, if the adapter type allows it.

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 | The device name of the adapter to be removed. Since vSphere API 7.0.3.0

P Required privilege: hbaDeviceName

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
HostConfigFault | Thrown if the host is unable to remove the given HBA.
NotFound | Thrown if the given HBA could not be found.
ResourceInUse | Thrown if the given HBA is in use.
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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="RemoveSoftwareAdapter" type="sms:RemoveSoftwareAdapterRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="RemoveSoftwareAdapterResponse"> <complexType/> </element>

# 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:

- Devices and storage topology (HostSystem.Config.storageDevice).
- VMFS and NFS datastores (HostSystem.Datastore).
- File system volumes (HostSystem.Config.fileSystemVolume).

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

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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="RescanAllHba" type="sms:RescanAllHbaRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="RescanAllHbaResponse"> <complexType/> </element>

# RescanHba(rescanHba)

Issues a request to rescan a specific host bus adapter for new storage devices.

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 | The device of the host bus adapter. Since 2.0

P Required privilege: hbaDevice

Return Value

Type | Description
--- | ---
None

Faults

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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="RescanHba" type="sms:RescanHbaRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="RescanHbaResponse"> <complexType/> </element>

# 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

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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="RescanVffs" type="sms:RescanVffsRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="RescanVffsResponse"> <complexType/> </element>

# 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

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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="RescanVmfs" type="sms:RescanVmfsRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="RescanVmfsResponse"> <complexType/> </element>

# 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
resolutionSpec P | HostUnresolvedVmfsResolutionSpec[] | 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
--- | ---
HostConfigFault | Thrown 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.
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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="ResolveMultipleUnresolvedVmfsVolumes" type="sms:ResolveMultipleUnresolvedVmfsVolumesRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="ResolveMultipleUnresolvedVmfsVolumesResponse"> <complexType> <sequence> <element name="returnval" type="sms:HostUnresolvedVmfsResolutionResult" minOccurs="0" maxOccurs="unbounded"/> </sequence> </complexType> </element>

# 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
resolutionSpec P | HostUnresolvedVmfsResolutionSpec[] | 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 SmsTask | 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
--- | ---
HostConfigFault | Thrown 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.
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(retrieveDiskPartitionInfo)

Gets the partition information for the disks named by the device names.

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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="RetrieveDiskPartitionInfo" type="sms:RetrieveDiskPartitionInfoRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="RetrieveDiskPartitionInfoResponse"> <complexType> <sequence> <element name="returnval" type="sms:HostDiskPartitionInfo" minOccurs="0" maxOccurs="unbounded"/> </sequence> </complexType> </element>

# SetMultipathLunPolicy(setMultipathLunPolicy)

Updates the path selection policy for a Logical Unit. Use the LUN uuid from HostMultipathInfoLogicalUnit.

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 | The logical unit ID Since 2.0
policy P | HostMultipathInfoLogicalUnitPolicy | 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
--- | ---
HostConfigFault | Thrown for all other configuration failures.
NotFound | Thrown if the LUN could not be found.
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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="SetMultipathLunPolicy" type="sms:SetMultipathLunPolicyRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="SetMultipathLunPolicyResponse"> <complexType/> </element>

# 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
user P | xsd:string | User to be saved on the the esx host Since vSphere API 6.0
password P | xsd:string | Password for the user. Since vSphere API 6.0

PRequired privilege - see tooltip for details

Return Value

Type | Description
--- | ---
None

Faults

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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="SetNFSUser" type="sms:SetNFSUserRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="SetNFSUserResponse"> <complexType/> </element>

# 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
scsiDiskUuids P | xsd: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 SmsTask |

Faults

Type | Description
--- | ---
HostConfigFault | Thrown for host configuration failures.
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(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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
scsiDiskUuids P | xsd: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 SmsTask |

Faults

Type | Description
--- | ---
HostConfigFault | Thrown for host configuration failures.
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(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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
vmfsUuid P | xsd: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 SmsTask |

Faults

Type | Description
--- | ---
HostConfigFault | Thrown for host configuration failures.
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(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

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 | Thrown for all other configuration failures.
NotFound | Thrown if VMFS Uuid is not found on the host.
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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="UnmountForceMountedVmfsVolume" type="sms:UnmountForceMountedVmfsVolumeRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="UnmountForceMountedVmfsVolumeResponse"> <complexType/> </element>

# 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

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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="UnmountVffsVolume" type="sms:UnmountVffsVolumeRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="UnmountVffsVolumeResponse"> <complexType/> </element>

# 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:

- Find out if the device is used as a Vmfs Extent. (See VmfsVolume.Extent API)
- Unmount the Vmfs Volume.
- Find out if device is used by the Diagnostic system (See Diagnostic System API).
- Deactivate the diagnostic system, if it is being used.
- Find out if this device is used to back a VM's RDM (See VirtualMachine API).
- Remove this device from the VM.
- Detach the Scsi device.
- On success, it is safe to decommision the Lun at this point.

See also 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.
vmfsUuid P | xsd:string | Since vSphere API 5.0

P Required privilege: vmfsUuid

Return Value

Type | Description
--- | ---
None

Faults

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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="UnmountVmfsVolume" type="sms:UnmountVmfsVolumeRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="UnmountVmfsVolumeResponse"> <complexType/> </element>

# 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
vmfsUuid P | xsd: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 SmsTask |

Faults

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

Changes the partitions on the disk by supplying a partition specification and the device name.

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 | The name of the device path for the specific disk. Since 2.0
spec P | HostDiskPartitionSpec | 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
--- | ---
HostConfigFault | Thrown for all other configuration failures.
NotFound | Thrown if the device could not be found.
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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="UpdateDiskPartitions" type="sms:UpdateDiskPartitionsRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="UpdateDiskPartitionsResponse"> <complexType/> </element>

# UpdateHppMultipathLunPolicy(updateHppMultipathLunPolicy)

Updates the path selection policy for a HPP claimed Logical Unit. Use the LUN uuid from HostMultipathInfoLogicalUnit.

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 | The logical unit ID Since vSphere API 7.0
policy P | HostMultipathInfoHppLogicalUnitPolicy | A data object that describes a path selection policy and its configuration for the logical unit. Since vSphere API 7.0

PRequired privilege - see tooltip for details

Return Value

Type | Description
--- | ---
None

Faults

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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="UpdateHppMultipathLunPolicy" type="sms:UpdateHppMultipathLunPolicyRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="UpdateHppMultipathLunPolicyResponse"> <complexType/> </element>

# 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
iScsiHbaDevice P | xsd:string | The device of the Internet SCSI HBA adapter. Since vSphere API 4.0
targetSet* P | HostInternetScsiHbaTargetSet | 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 P | HostInternetScsiHbaParamValue[] | 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
--- | ---
HostConfigFault | Thrown for all other configuration failures.
NotFound | Thrown if the host bus adapter could not be found.
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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="UpdateInternetScsiAdvancedOptions" type="sms:UpdateInternetScsiAdvancedOptionsRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="UpdateInternetScsiAdvancedOptionsResponse"> <complexType/> </element>

# UpdateInternetScsiAlias(updateInternetScsiAlias)

Updates the alias of an iSCSI host bus adapter.

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 | The device of the Internet SCSI HBA adapter. Since 2.0
iScsiAlias P | xsd: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
--- | ---
HostConfigFault | Thrown for all other configuration failures.
NotFound | Thrown if the host bus adapter could not be found.
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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="UpdateInternetScsiAlias" type="sms:UpdateInternetScsiAliasRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="UpdateInternetScsiAliasResponse"> <complexType/> </element>

# 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
iScsiHbaDevice P | xsd:string | The device of the Internet SCSI HBA adapter. associated with the target. Since 2.0
authenticationProperties P | HostInternetScsiHbaAuthenticationProperties | The data object that represents the authentication settings to set. Since 2.0
targetSet* P | HostInternetScsiHbaTargetSet | 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
--- | ---
HostConfigFault | Thrown for all other configuration failures.
NotFound | Thrown if the host bus adapter could not be found.
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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="UpdateInternetScsiAuthenticationProperties" type="sms:UpdateInternetScsiAuthenticationPropertiesRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="UpdateInternetScsiAuthenticationPropertiesResponse"> <complexType/> </element>

# 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
iScsiHbaDevice P | xsd:string | The device of the Internet SCSI HBA adapter. Since vSphere API 4.0
targetSet* P | HostInternetScsiHbaTargetSet | 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 P | HostInternetScsiHbaDigestProperties | 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
--- | ---
HostConfigFault | Thrown for all other configuration failures.
NotFound | Thrown if the host bus adapter could not be found.
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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="UpdateInternetScsiDigestProperties" type="sms:UpdateInternetScsiDigestPropertiesRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="UpdateInternetScsiDigestPropertiesResponse"> <complexType/> </element>

# UpdateInternetScsiDiscoveryProperties(updateInternetScsiDiscoveryProperties)

Updates the Discovery properties for an iSCSI host bus adapter.

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 | The device of the Internet SCSI HBA adapter. Since 2.0
discoveryProperties P | HostInternetScsiHbaDiscoveryProperties | 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
--- | ---
HostConfigFault | Thrown for all other configuration failures.
NotFound | Thrown if the host bus adapter could not be found.
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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="UpdateInternetScsiDiscoveryProperties" type="sms:UpdateInternetScsiDiscoveryPropertiesRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="UpdateInternetScsiDiscoveryPropertiesResponse"> <complexType/> </element>

# UpdateInternetScsiIPProperties(updateInternetScsiIPProperties)

Updates the IP properties for an iSCSI host bus adapter.

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 | The device of the Internet SCSI HBA adapter. Since 2.0
ipProperties P | HostInternetScsiHbaIPProperties | 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
--- | ---
HostConfigFault | Thrown for all other configuration failures.
NotFound | Thrown if the host bus adapter could not be found.
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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="UpdateInternetScsiIPProperties" type="sms:UpdateInternetScsiIPPropertiesRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="UpdateInternetScsiIPPropertiesResponse"> <complexType/> </element>

# UpdateInternetScsiName(updateInternetScsiName)

Updates the name of an iSCSI host bus adapter.

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 | The current name of the Internet SCSI HBA adapter. Since 2.0
iScsiName P | xsd: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
--- | ---
HostConfigFault | Thrown for all other configuration failures.
NotFound | Thrown if the host bus adapter could not be found.
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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="UpdateInternetScsiName" type="sms:UpdateInternetScsiNameRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="UpdateInternetScsiNameResponse"> <complexType/> </element>

# 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
lunUuid P | xsd:string | The uuid of the ScsiLun to update. Since vSphere API 4.0
displayName P | xsd: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
--- | ---
DuplicateName | Thrown 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.
HostConfigFault | Thrown for all other configuration failures.
InvalidName | Thrown if the name does not meet name restrictions such as an 80 character limit.
NotFound | Thrown if the device could not be found.
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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="UpdateScsiLunDisplayName" type="sms:UpdateScsiLunDisplayNameRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="UpdateScsiLunDisplayNameResponse"> <complexType/> </element>

# UpdateSoftwareInternetScsiEnabled(updateSoftwareInternetScsiEnabled)

Enables or disables Software iSCSI.

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 | True to enable the iSCSI; false to disable it Since 2.0

P Required privilege: enabled

Return Value

Type | Description
--- | ---
None

Faults

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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="UpdateSoftwareInternetScsiEnabled" type="sms:UpdateSoftwareInternetScsiEnabledRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="UpdateSoftwareInternetScsiEnabledResponse"> <complexType/> </element>

# 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

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

PRequired 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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="UpdateVmfsUnmapBandwidth" type="sms:UpdateVmfsUnmapBandwidthRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="UpdateVmfsUnmapBandwidthResponse"> <complexType/> </element>

# UpdateVmfsUnmapPriority(updateVmfsUnmapPriority)

Update VMFS unmap priority. This API updates the value of unmapPriority.

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 | The VMFS UUID. Since vSphere API 6.5
unmapPriority P | xsd: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
--- | ---
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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="UpdateVmfsUnmapPriority" type="sms:UpdateVmfsUnmapPriorityRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="UpdateVmfsUnmapPriorityResponse"> <complexType/> </element>

# 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call.
vmfsPath P | xsd:string | The path of the VMFS. Since 2.0

P Required privilege: vmfsPath

Return Value

Type | Description
--- | ---
None

Faults

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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="UpgradeVmfs" type="sms:UpgradeVmfsRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="UpgradeVmfsResponse"> <complexType/> </element>

# 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

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

Show WSDL type definition
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="UpgradeVmLayout" type="sms:UpgradeVmLayoutRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="UpgradeVmLayoutResponse"> <complexType/> </element>