Scripting Object - VcHostStorageSystem

Scripting-object corresponding to
HostStorageSystem
Attribute of
VcHostConfigManager

Scripting 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.

Attributes

Name Type Description
availableFieldVcCustomFieldDef []

@since VI API 2.5
fileSystemVolumeInfoVcHostFileSystemVolumeInfo

@since VI API 2.5
idString

@since Unknown
morefVcManagedObjectReference

returns the ManagedObjectReference of this ManagedObject @since Unknown
multipathStateInfoVcHostMultipathStateInfo

@since vSphere API 4.0
sdkConnectionVcSdkConnection

@since Unknown
sdkIdString

@since Unknown
storageDeviceInfoVcHostStorageDeviceInfo

@since VI API 2.5
systemFileString []

@since vSphere API 4.1
typeStringDeprecated.

Returns the name for the this managed object's vim type @since Unknown
valueVcCustomFieldValue []

@since VI API 2.5
vimHostVcSdkConnection

@since Unknown
vimIdString

@since Unknown
vimTypeString

@since Unknown

Methods

Methods defined in this Scripting Object
_getRef, addInternetScsiSendTargets, addInternetScsiStaticTargets, attachScsiLun, attachScsiLunEx_Task, attachVmfsExtent, changeNFSUserPassword, clearNFSUser, computeDiskPartitionInfo, computeDiskPartitionInfoForResize, createTrigger, deleteScsiLunState, deleteVffsVolumeState, deleteVmfsVolumeState, destroyVffs, detachScsiLun, detachScsiLunEx_Task, disableMultipathPath, discoverFcoeHbas, enableMultipathPath, expandVmfsExtent, extendVffs, fetchIoFilterSharedSecret, formatVffs, formatVmfs, markAsLocal_Task, markAsNonLocal_Task, markAsNonSsd_Task, markAsSsd_Task, markForRemoval, mountVffsVolume, mountVmfsVolume, mountVmfsVolumeEx_Task, queryAvailableSsds, queryIoFilterProviderId, queryNFSUser, queryPathSelectionPolicyOptions, queryStorageArrayTypePolicyOptions, queryUnresolvedVmfsVolume, queryVmfsConfigOption, refreshStorageSystem, removeInternetScsiSendTargets, removeInternetScsiStaticTargets, rescanAllHba, rescanHba, rescanVffs, rescanVmfs, resolveMultipleUnresolvedVmfsVolumes, resolveMultipleUnresolvedVmfsVolumesEx_Task, retrieveDiskPartitionInfo, setCustomValue, setMultipathLunPolicy, setNFSUser, turnDiskLocatorLedOff_Task, turnDiskLocatorLedOn_Task, unmapVmfsVolumeEx_Task, unmountForceMountedVmfsVolume, unmountVffsVolume, unmountVmfsVolume, unmountVmfsVolumeEx_Task, updateDiskPartitions, updateInternetScsiAdvancedOptions, updateInternetScsiAlias, updateInternetScsiAuthenticationProperties, updateInternetScsiDigestProperties, updateInternetScsiDiscoveryProperties, updateInternetScsiIPProperties, updateInternetScsiName, updateScsiLunDisplayName, updateSoftwareInternetScsiEnabled, updateVmfsUnmapPriority, upgradeVmfs, upgradeVmLayout

disableMultipathPath

Disables an enabled path for a Logical Unit. Use the path name from {@link vim.host.MultipathStateInfo.Path} or {@link vim.host.MultipathInfo.Path}. @since VI API 2.5

Parameters

NameTypeDescription
arg0String


Return Value

Type Description
None

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.

@since vSphere API 4.0

Parameters

NameTypeDescription
arg0VcHostUnresolvedVmfsResolutionSpec []


Return Value

Type Description
VcHostUnresolvedVmfsResolutionResult []

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. @since VI API 2.5

Parameters

NameTypeDescription
arg0String

arg1VcHostInternetScsiHbaStaticTarget []


Return Value

Type Description
None

markAsNonLocal_Task

Mark a disk to remote disk, which is the opposite operation of {@link vim.host.StorageSystem#markAsLocal} Task failure might lose existing claim rules on the disk. @since vSphere API 6.0

Parameters

NameTypeDescription
arg0String


Return Value

Type Description
VcTask

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 {@link vim.host.MultipathInfo} data object.

Filtering capabilities are not currently present but may be added in the future. @since vSphere API 4.0

Parameters

NameTypeDescription
None

Return Value

Type Description
VcHostStorageArrayTypePolicyOption []

turnDiskLocatorLedOn_Task

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. @since vSphere API 6.0

Parameters

NameTypeDescription
arg0String []


Return Value

Type Description
VcTask

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. @since vSphere API 4.0

Parameters

NameTypeDescription
arg0String


Return Value

Type Description
None

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 {@link vim.host.StorageSystem#attachScsiLun}.

detachScsiLun is part of the Unmount / Detach workflow used when a device will be permanently removed. See also {@link vim.host.StorageSystem#unmountVmfsVolume}. @since vSphere API 5.0

Parameters

NameTypeDescription
arg0String


Return Value

Type Description
None

updateDiskPartitions

Changes the partitions on the disk by supplying a partition specification and the device name. @since VI API 2.5

Parameters

NameTypeDescription
arg0String

arg1VcHostDiskPartitionSpec


Return Value

Type Description
None

expandVmfsExtent

Expands a VMFS extent as specified by the Disk partition specification. @since vSphere API 4.0

Parameters

NameTypeDescription
arg0String

arg1VcHostScsiDiskPartition


Return Value

Type Description
None

rescanHba

Issues a request to rescan a specific host bus adapter for new storage devices. @since VI API 2.5

Parameters

NameTypeDescription
arg0String


Return Value

Type Description
None

resolveMultipleUnresolvedVmfsVolumesEx_Task

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 {@link vim.host.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 {@link vim.host.DatastoreSystem} interface.

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

It will return an array of {@link vim.host.UnresolvedVmfsResolutionResult} describing success or failure associated with each specification.

This method behaves the same as {@link #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.

@since vSphere API 5.5

Parameters

NameTypeDescription
arg0VcHostUnresolvedVmfsResolutionSpec []


Return Value

Type Description
VcTask

addInternetScsiStaticTargets

Adds Static Target entries to the host bus adapter discovery list. The DiscoveryProperty.staticTargetDiscoveryEnabled must be set to true. @since VI API 2.5

Parameters

NameTypeDescription
arg0String

arg1VcHostInternetScsiHbaStaticTarget []


Return Value

Type Description
None

destroyVffs

Destroy a VFFS volume. @since vSphere API 5.5

Parameters

NameTypeDescription
arg0String


Return Value

Type Description
None

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 {@link vim.host.StorageSystem#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 {@link vim.host.StorageSystem#detachScsiLun}. @since vSphere API 5.0

Parameters

NameTypeDescription
arg0String


Return Value

Type Description
None

createTrigger

@since Unknown

Parameters

NameTypeDescription
timeoutNumber

filterString

conditionString

filterToSyncString


Return Value

Type Description
Trigger

rescanAllHba

Scans all host bus adapters to obtain the current list of devices and device topology. The {@link vim.host.StorageSystem#rescanAllHba} method looks for new devices, removed devices, and path changes.

This method may update the following inventory elements:

The Server performs asynchronous updates to the inventory. Use the {@link vmodl.query.PropertyCollector}.{@link vmodl.query.PropertyCollector#waitForUpdatesEx} method to obtain the property changes. @since VI API 2.5

Parameters

NameTypeDescription
None

Return Value

Type Description
None

markAsNonSsd_Task

Mark a disk to Non-SSD, which is the opposite operation of {@link vim.host.StorageSystem#markAsSsd} Task failure might lose existing claim rules on the disk. @since vSphere API 6.0

Parameters

NameTypeDescription
arg0String


Return Value

Type Description
VcTask

updateInternetScsiAuthenticationProperties

Updates the authentication properties for one or more targets or discovery addresses associated with an iSCSI host bus adapter. @since VI API 2.5

Parameters

NameTypeDescription
arg0String

arg1VcHostInternetScsiHbaAuthenticationProperties

arg2VcHostInternetScsiHbaTargetSet


Return Value

Type Description
None

updateInternetScsiAlias

Updates the alias of an iSCSI host bus adapter. @since VI API 2.5

Parameters

NameTypeDescription
arg0String

arg1String


Return Value

Type Description
None

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 {@link vim.host.MultipathInfo} data object.

Filtering capabilities are not currently present but may be added in the future. @since vSphere API 4.0

Parameters

NameTypeDescription
None

Return Value

Type Description
VcHostPathSelectionPolicyOption []

fetchIoFilterSharedSecret

Get the shared secret generated by VAIO VASA provider. This API is internal and intended to be used by VMware internal modules only. @since vSphere API 6.0

Parameters

NameTypeDescription
None

Return Value

Type Description
String

updateInternetScsiName

Updates the name of an iSCSI host bus adapter. @since VI API 2.5

Parameters

NameTypeDescription
arg0String

arg1String


Return Value

Type Description
None

updateInternetScsiAdvancedOptions

Updates the advanced options the iSCSI host bus adapter or the discovery addresses and targets associated with it. @since vSphere API 4.0

Parameters

NameTypeDescription
arg0String

arg1VcHostInternetScsiHbaTargetSet

arg2VcHostInternetScsiHbaParamValue []


Return Value

Type Description
None

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

Parameters

NameTypeDescription
arg0String


Return Value

Type Description
VcHostScsiDisk []

setMultipathLunPolicy

Updates the path selection policy for a Logical Unit. Use the LUN uuid from {@link vim.host.MultipathInfo.LogicalUnit}. @since VI API 2.5

Parameters

NameTypeDescription
arg0String

arg1VcHostMultipathInfoLogicalUnitPolicy


Return Value

Type Description
None

markAsLocal_Task

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. @since vSphere API 6.0

Parameters

NameTypeDescription
arg0String


Return Value

Type Description
VcTask

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. @since vSphere API 4.0

Parameters

NameTypeDescription
None

Return Value

Type Description
VcHostUnresolvedVmfsVolume []

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 {@link vim.host.StorageSystem#unmountVmfsVolume}.

mountVmfsVolume is part of the Unmount / Detach workflow used when a device will be permanently removed. See also {@link vim.host.StorageSystem#detachScsiLun}. @since vSphere API 5.0

Parameters

NameTypeDescription
arg0String


Return Value

Type Description
None

detachScsiLunEx_Task

Detach one or more SCSI LUNs. This is an asynchronous, batch operation of detachScisLun. Please see {@link vim.host.StorageSystem#detachScsiLun} for operational details. @since vSphere API 6.0

Parameters

NameTypeDescription
arg0String []


Return Value

Type Description
VcTask

queryVmfsConfigOption

Get the VMFS configuration options, including block size, unmap granularity. @since vSphere API 6.5

Parameters

NameTypeDescription
None

Return Value

Type Description
VcVmfsConfigOption []

addInternetScsiSendTargets

Adds Send Target entries to the host bus adapter discovery list. The DiscoveryProperties.sendTargetsDiscoveryEnabled flag must be set to true. @since VI API 2.5

Parameters

NameTypeDescription
arg0String

arg1VcHostInternetScsiHbaSendTarget []


Return Value

Type Description
None

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 {@link vim.host.StorageSystem#detachScsiLun}. Please note: The API takes 'canonicalName' of the ScsiLun object instead of the ScsiLun.uuid. @since vSphere API 5.0

Parameters

NameTypeDescription
arg0String


Return Value

Type Description
None

updateInternetScsiDiscoveryProperties

Updates the Discovery properties for an iSCSI host bus adapter. @since VI API 2.5

Parameters

NameTypeDescription
arg0String

arg1VcHostInternetScsiHbaDiscoveryProperties


Return Value

Type Description
None

_getRef

@since Unknown

Parameters

NameTypeDescription
None

Return Value

Type Description
VcManagedObjectReference

unmapVmfsVolumeEx_Task

Unmap one or more VMFS volumes. This is an asynchronous, batch operation. The operation unmaps free blocks in each VMFS volume. @since vSphere API 6.0

Parameters

NameTypeDescription
arg0String []


Return Value

Type Description
VcTask

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. @since VI API 2.5

Parameters

NameTypeDescription
None

Return Value

Type Description
None

mountVffsVolume

Mount the unmounted VFFS volume. See {@link #unmountVffsVolume}.

mountVffsVolume is part of the Unmount / Detach workflow used when a device will be permanently removed. See also {@link vim.host.StorageSystem#detachScsiLun}. @since vSphere API 5.5

Parameters

NameTypeDescription
arg0String


Return Value

Type Description
None

attachVmfsExtent

Extends a VMFS by attaching a disk partition as an extent. @since VI API 2.5

Parameters

NameTypeDescription
arg0String

arg1VcHostScsiDiskPartition


Return Value

Type Description
None

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 {@link vim.host.StorageSystem#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 {@link vim.host.StorageSystem#detachScsiLun}. @since vSphere API 5.5

Parameters

NameTypeDescription
arg0String


Return Value

Type Description
None

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 {@link vim.host.StorageSystem#mountVmfsVolume}.

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

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

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

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

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

One typical workflow could be:

See also {@link vim.host.StorageSystem#detachScsiLun}. @since vSphere API 5.0

Parameters

NameTypeDescription
arg0String


Return Value

Type Description
None

changeNFSUserPassword

Change password for existing NFS user. This method shall be called after the NFS user has been created on the host. @since vSphere API 6.0

Parameters

NameTypeDescription
arg0String


Return Value

Type Description
None

updateSoftwareInternetScsiEnabled

Enables or disables Software iSCSI. @since VI API 2.5

Parameters

NameTypeDescription
arg0Boolean


Return Value

Type Description
None

computeDiskPartitionInfoForResize

Computes the disk partition information for the purpose of resizing a given partition. @since vSphere API 4.0

Parameters

NameTypeDescription
arg0VcHostScsiDiskPartition

arg1VcHostDiskPartitionBlockRange

arg2String


Return Value

Type Description
VcHostDiskPartitionInfo

formatVffs

Format a new VFFS on a SSD disk @since vSphere API 5.5

Parameters

NameTypeDescription
arg0VcHostVffsSpec


Return Value

Type Description
VcHostVffsVolume

queryIoFilterProviderId

Get the ID of VAIO (vSphere APIs for IO Filtering) VASA provider on the host. This API is internal and intended to be used by VMware internal modules only. @since vSphere API 6.0

Parameters

NameTypeDescription
None

Return Value

Type Description
String

enableMultipathPath

Enables a disabled path for a Logical Unit. Use the path name from {@link vim.host.MultipathStateInfo.Path} or {@link vim.host.MultipathInfo.Path}. @since VI API 2.5

Parameters

NameTypeDescription
arg0String


Return Value

Type Description
None

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 {@link vim.host.StorageSystem#mountVffsVolume}.

unmountVffsVolume is part of the Unmount / Detach workflow used when a device will be permanently removed. See also {@link vim.host.StorageSystem#detachScsiLun}. @since vSphere API 5.5

Parameters

NameTypeDescription
arg0String


Return Value

Type Description
None

attachScsiLun

Allow I/O issue to the specified detached ScsiLun. The ScsiLun is administratively configured on, if the attach operation is successful. See {@link vim.host.StorageSystem#detachScsiLun}.

attachScsiLun is part of the Unmount, Detach workflow used when a device will be permanently removed. See also {@link vim.host.StorageSystem#unmountVmfsVolume}. @since vSphere API 5.0

Parameters

NameTypeDescription
arg0String


Return Value

Type Description
None

unmountVmfsVolumeEx_Task

Unmount one or more VMFS volumes. This is an asynchronous, batch operation of unmountVmfsVolume. Please see {@link vim.host.StorageSystem#unmountVmfsVolume} for operational details. @since vSphere API 6.0

Parameters

NameTypeDescription
arg0String []


Return Value

Type Description
VcTask

retrieveDiskPartitionInfo

Gets the partition information for the disks named by the device names. @since VI API 2.5

Parameters

NameTypeDescription
arg0String []


Return Value

Type Description
VcHostDiskPartitionInfo []

setCustomValue

Assigns a value to a custom field. The setCustomValue method requires whichever updatePrivilege is defined as one of the {@link CustomFieldsManager.FieldDef#fieldInstancePrivileges} for the CustomFieldDef whose value is being changed. @since VI API 2.5

Parameters

NameTypeDescription
arg0String

arg1String


Return Value

Type Description
None

refreshStorageSystem

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

This method may update the following inventory elements:

The Server performs asynchronous updates to the inventory. Use the {@link vmodl.query.PropertyCollector}.{@link vmodl.query.PropertyCollector#waitForUpdatesEx} method to obtain the property changes. @since VI API 2.5

Parameters

NameTypeDescription
None

Return Value

Type Description
None

mountVmfsVolumeEx_Task

Mount one or more VMFS volumes. This is an asynchronous, batch operation of mountVmfsVolume. Please see {@link vim.host.StorageSystem#mountVmfsVolume} for operational details. @since vSphere API 6.0

Parameters

NameTypeDescription
arg0String []


Return Value

Type Description
VcTask

clearNFSUser

Clear the NFS user configured on the esx host @since vSphere API 6.0

Parameters

NameTypeDescription
None

Return Value

Type Description
None

attachScsiLunEx_Task

Attach one or more SCSI LUNs. This is an asynchronous, batch operation of attachScisLun. Please see {@link vim.host.StorageSystem#attachScsiLun} for operational details. @since vSphere API 6.0

Parameters

NameTypeDescription
arg0String []


Return Value

Type Description
VcTask

formatVmfs

Formats a new VMFS on a disk partition. @since VI API 2.5

Parameters

NameTypeDescription
arg0VcHostVmfsSpec


Return Value

Type Description
VcHostVmfsVolume

updateInternetScsiIPProperties

Updates the IP properties for an iSCSI host bus adapter. @since VI API 2.5

Parameters

NameTypeDescription
arg0String

arg1VcHostInternetScsiHbaIPProperties


Return Value

Type Description
None

queryNFSUser

Query the NFS user configured on the esx host @since vSphere API 6.0

Parameters

NameTypeDescription
None

Return Value

Type Description
VcHostNasVolumeUserInfo

updateVmfsUnmapPriority

Update VMFS unmap priority. This API updates the value of {@link vim.host.VmfsVolume#unmapPriority}. @since vSphere API 6.5

Parameters

NameTypeDescription
arg0String

arg1String


Return Value

Type Description
None

extendVffs

Extends a VFFS by attaching a SSD. @since vSphere API 5.5

Parameters

NameTypeDescription
arg0String

arg1String

arg2VcHostDiskPartitionSpec


Return Value

Type Description
None

markAsSsd_Task

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. @since vSphere API 6.0

Parameters

NameTypeDescription
arg0String


Return Value

Type Description
VcTask

rescanVffs

Rescans for new VFFS. The {@link vim.host.StorageSystem#refresh} method also performs a VFFS rescan.

{@link vim.host.StorageSystem#rescanVffs} may update the {@link vim.HostSystem}.{@link vim.HostSystem#config}.{@link vim.host.ConfigInfo#fileSystemVolume} property. The Server performs asynchronous updates to the inventory. Use the {@link vmodl.query.PropertyCollector}.{@link vmodl.query.PropertyCollector#waitForUpdatesEx} method to obtain the property changes. @since vSphere API 5.5

Parameters

NameTypeDescription
None

Return Value

Type Description
None

discoverFcoeHbas

Initiates FCoE discovery using the given FcoeSpecification. Upon success, discovered VNPorts will have registered with the system as FCoE HBAs. @since vSphere API 5.0

Parameters

NameTypeDescription
arg0VcFcoeConfigFcoeSpecification


Return Value

Type Description
None

turnDiskLocatorLedOff_Task

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 {@link vim.host.StorageSystem#turnDiskLocatorLedOn} @since vSphere API 6.0

Parameters

NameTypeDescription
arg0String []


Return Value

Type Description
VcTask

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. @since vSphere API 6.0

Parameters

NameTypeDescription
arg0String

arg1String


Return Value

Type Description
None

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. @since VI API 2.5

Parameters

NameTypeDescription
arg0String

arg1VcHostInternetScsiHbaSendTarget []


Return Value

Type Description
None

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. @since VI API 2.5

Parameters

NameTypeDescription
arg0String

arg1VcHostDiskPartitionLayout

arg2String


Return Value

Type Description
VcHostDiskPartitionInfo

updateInternetScsiDigestProperties

Updates the digest properties for the iSCSI host bus adapter or the discovery addresses and targets associated with it. @since vSphere API 4.0

Parameters

NameTypeDescription
arg0String

arg1VcHostInternetScsiHbaTargetSet

arg2VcHostInternetScsiHbaDigestProperties


Return Value

Type Description
None

updateScsiLunDisplayName

Update the mutable display name associated with a ScsiLun. The ScsiLun to be updated is identified using the specified uuid. @since vSphere API 4.0

Parameters

NameTypeDescription
arg0String

arg1String


Return Value

Type Description
None

markForRemoval

Mark or unmark the given FCoE HBA for removal from the host system. Marking an FCoE HBA for removal will result in the HBA not being discovered upon host reboot. Until reboot, the HBA remains visible in the storage topology. @since vSphere API 5.0

Parameters

NameTypeDescription
arg0String

arg1Boolean


Return Value

Type Description
None

upgradeVmfs

Upgrades the VMFS to the {@link vim.host.Capability#supportedVmfsMajorVersion latest supported VMFS version}.

Prerequisite:
All hosts that have mounted the volume must support the VMFS version to which the volume will be upgraded. @since VI API 2.5

Parameters

NameTypeDescription
arg0String


Return Value

Type Description
None

rescanVmfs

Rescans for new Virtual Machine File Systems (VMFS). The {@link vim.host.StorageSystem#refresh} method also performs a VMFS rescan.

{@link vim.host.StorageSystem#rescanVmfs} may update the {@link vim.HostSystem}.{@link vim.HostSystem#config}.{@link vim.host.ConfigInfo#fileSystemVolume} property. The Server performs asynchronous updates to the inventory. Use the {@link vmodl.query.PropertyCollector}.{@link vmodl.query.PropertyCollector#waitForUpdatesEx} method to obtain the property changes. @since VI API 2.5

Parameters

NameTypeDescription
None

Return Value

Type Description
None