Managed Object - HostStorageSystem

Property of
HostConfigManager
Extends
ExtensibleManagedObject
See also
HostDiskPartitionBlockRange, HostDiskPartitionInfo, HostDiskPartitionLayout, HostDiskPartitionSpec, HostFileSystemVolumeInfo, HostInternetScsiHbaAuthenticationProperties, HostInternetScsiHbaDigestProperties, HostInternetScsiHbaDiscoveryProperties, HostInternetScsiHbaIPProperties, HostInternetScsiHbaParamValue, HostInternetScsiHbaSendTarget, HostInternetScsiHbaStaticTarget, HostInternetScsiHbaTargetSet, HostMultipathInfoLogicalUnitPolicy, HostMultipathStateInfo, HostPathSelectionPolicyOption, HostScsiDiskPartition, HostStorageArrayTypePolicyOption, HostStorageDeviceInfo, HostUnresolvedVmfsResolutionResult, HostUnresolvedVmfsResolutionSpec, HostUnresolvedVmfsVolume, HostVmfsSpec, HostVmfsVolume


Managed Object Description

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

Properties

Name Type Description
fileSystemVolumeInfoHostFileSystemVolumeInfo

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

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

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

Since vSphere API 4.0
storageDeviceInfo*HostStorageDeviceInfo

Host storage information up to the device level.
Properties inherited from ExtensibleManagedObject
availableField, value
*May not be present

Methods

Methods defined in this Managed Object
AddInternetScsiSendTargets, AddInternetScsiStaticTargets, AttachVmfsExtent, ComputeDiskPartitionInfo, ComputeDiskPartitionInfoForResize, DisableMultipathPath, EnableMultipathPath, ExpandVmfsExtent, FormatVmfs, QueryPathSelectionPolicyOptions, QueryStorageArrayTypePolicyOptions, QueryUnresolvedVmfsVolume, RefreshStorageSystem, RemoveInternetScsiSendTargets, RemoveInternetScsiStaticTargets, RescanAllHba, RescanHba, RescanVmfs, ResolveMultipleUnresolvedVmfsVolumes, RetrieveDiskPartitionInfo, SetMultipathLunPolicy, UnmountForceMountedVmfsVolume, UpdateDiskPartitions, UpdateInternetScsiAdvancedOptions, UpdateInternetScsiAlias, UpdateInternetScsiAuthenticationProperties, UpdateInternetScsiDigestProperties, UpdateInternetScsiDiscoveryProperties, UpdateInternetScsiIPProperties, UpdateInternetScsiName, UpdateScsiLunDisplayName, UpdateSoftwareInternetScsiEnabled, UpgradeVmfs, UpgradeVmLayout
Methods inherited from ExtensibleManagedObject
setCustomValue

AddInternetScsiSendTargets

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

Parameters

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

The device of the Internet SCSI HBA adapter.
targetsHostInternetScsiHbaSendTarget[]

An array of iSCSI send targets.

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for all other configuration failures.
NotFoundThrown if the discovery list could not be found.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



AddInternetScsiStaticTargets

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

Parameters

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

The device of the Internet SCSI HBA adapter.
targetsHostInternetScsiHbaStaticTarget[]

An array of iSCSI static targets to add.

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for all other configuration failures.
NotFoundThrown if the host bus adaptor discovery list was not found.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



AttachVmfsExtent

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

Parameters

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

The path of the VMFS to extend. See FileSystemMountInfo.
extentHostScsiDiskPartition

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

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for all other configuration failures.
InvalidArgumentThrown if the new extent is already used by another vmfs volume, does not exist, or is of an invalid partition type.
NotFoundThrown if the VMFS cannot be found.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



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.
Required Privileges
Host.Config.Storage

Parameters

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

The name of the device path for the specific disk.
layoutHostDiskPartitionLayout

A data object that describes the disk partition layout.

Return Value

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

Faults

Type Description
HostConfigFaultThrown if unable to get the current partition information for the device.
InvalidArgumentThrown if the layout is invalid.
NotFoundThrown if the device could not be found.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



ComputeDiskPartitionInfoForResize

Computes the disk partition information for the purpose of resizing a given partition.
Required Privileges
Host.Config.Storage
Since
vSphere API 4.0

Parameters

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

The disk partition to resize.
blockRangeHostDiskPartitionBlockRange

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

Return Value

Type Description
HostDiskPartitionInforesized disk partition information

Faults

Type Description
HostConfigFaultThrown if unable to get the current partition information for the device.
InvalidArgumentThrown if blockRange or partition is invalid.
NotFoundThrown if the device could not be found.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



DisableMultipathPath

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

Parameters

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

The name of the path to disable.

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for all other configuration failures.
NotFoundThrown if the LUN could not be found.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



EnableMultipathPath

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

Parameters

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

The name of the path to enable.

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for all other configuration failures.
NotFoundThrown if the LUN could not be found.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



ExpandVmfsExtent

Expands a VMFS extent as specified by the Disk partition specification.
Required Privileges
Host.Config.Storage
Since
vSphere API 4.0

Parameters

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

The path of the VMFS to expand. See FileSystemMountInfo.
extentHostScsiDiskPartition

The disk partition corresponding to the extent to be expanded.

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for all other configuration failures.
InvalidArgumentThrown if the extent is not part of the VMFS volume.
NotFoundThrown if the VMFS cannot be found.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



FormatVmfs

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

Parameters

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

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

Return Value

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

Faults

Type Description
AlreadyExistsThrown if the volume name is already being used by another volume on the host.
HostConfigFaultThrown for all other configuration failures.
InvalidArgumentThrown if VMFS version specified is not 2 or 3, if blocksize, lock mode, or volume label are invalid, the partition does not exist or is of an invalid type.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



QueryPathSelectionPolicyOptions

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

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

Required Privileges
System.Read
Since
vSphere API 4.0

Parameters

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

Return Value

Type Description
HostPathSelectionPolicyOption[]The list of path selection policy descriptions that match the search criteria. Details about the policies will also be provided in accordance to the query specification.

Faults

Type Description
HostConfigFaultThrown for system configuration failures.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



QueryStorageArrayTypePolicyOptions

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

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

Required Privileges
System.Read
Since
vSphere API 4.0

Parameters

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

Return Value

Type Description
HostStorageArrayTypePolicyOption[]The list of storage array type policy descriptions.

Faults

Type Description
HostConfigFaultThrown for system configuration failures.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



QueryUnresolvedVmfsVolume

Get the list of unbound VMFS volumes. For sharing a volume across hosts, a VMFS volume is bound to its underlying block device storage. When a low level block copy is performed to copy or move the VMFS volume, the copied volume will be unbound.
Required Privileges
System.Read
Since
vSphere API 4.0

Parameters

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

Return Value

Type Description
HostUnresolvedVmfsVolume[]An array of unbound VMFS volumes.

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



RefreshStorageSystem

Refresh the storage information and settings to pick up any changes that might have occurred.
Required Privileges
Host.Config.Storage

Parameters

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

Return Value

Type Description
None

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



RemoveInternetScsiSendTargets

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

Parameters

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

The device of the Internet SCSI HBA adapter.
targetsHostInternetScsiHbaSendTarget[]

An array of iSCSI send targets to remove.

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for all other configuration failures.
NotFoundThrown if at least one target was not found.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



RemoveInternetScsiStaticTargets

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

Parameters

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

The device of the Internet SCSI HBA adapter.
targetsHostInternetScsiHbaStaticTarget[]

An array of iSCSI static targets to remove.

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for all other configuration failures.
NotFoundThrown if at least one target was not found.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



RescanAllHba

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

Parameters

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

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown if rescan failed.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



RescanHba

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

Parameters

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

The device of the host bus adapter.

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for all other configuration failures.
NotFoundThrown if the host bus adapter cannot be found.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



RescanVmfs

Rescans for new VMFSs that might have been added.
Required Privileges
Host.Config.Storage

Parameters

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

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown if configuration fails.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



ResolveMultipleUnresolvedVmfsVolumes

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

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

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

Required Privileges
Host.Config.Storage
Since
vSphere API 4.0

Parameters

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

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

Return Value

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

Faults

Type Description
HostConfigFaultThrown if batch operation fails on the host.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



RetrieveDiskPartitionInfo

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

Parameters

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

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

Return Value

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

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



SetMultipathLunPolicy

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

Parameters

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

The logical unit ID
policyHostMultipathInfoLogicalUnitPolicy

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

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for all other configuration failures.
InvalidArgumentThrown if the policy is invalid.
NotFoundThrown if the LUN could not be found.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



UnmountForceMountedVmfsVolume

Unmount the 'forceMounted' Vmfs volume. When a low level block copy is performed to copy or move the VMFS volume, the copied volume is unresolved. For the VMFS volume to be usable, a resolution operation is applied. As part of resolution operation, user may decide to keep the original VMFS Uuid. Once the resolution is applied, the VMFS volume is mounted on the host for its use. User can unmount the VMFS volume if it is not being used by any registered VMs.
Required Privileges
Host.Config.Storage
Since
vSphere API 4.0

Parameters

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



Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for all other configuration failures.
NotFoundThrown if VMFS Uuid is not found on the host.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



UpdateDiskPartitions

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

Parameters

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

The name of the device path for the specific disk.
specHostDiskPartitionSpec

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

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for all other configuration failures.
InvalidArgumentThrown if the spec is invalid.
NotFoundThrown if the device could not be found.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



UpdateInternetScsiAdvancedOptions

Updates the advanced options the iSCSI host bus adapter or the discovery addresses and targets associated with it.
Required Privileges
Host.Config.Storage
Since
vSphere API 4.0

Parameters

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

The device of the Internet SCSI HBA adapter.
targetSet*HostInternetScsiHbaTargetSet

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

The list of options to set.
*Need not be set

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for all other configuration failures.
NotFoundThrown if the host bus adapter could not be found.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



UpdateInternetScsiAlias

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

Parameters

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

The device of the Internet SCSI HBA adapter.
iScsiAliasxsd:string

The new value for the alias of the adapter.

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for all other configuration failures.
NotFoundThrown if the host bus adapter could not be found.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



UpdateInternetScsiAuthenticationProperties

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

Parameters

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

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

The data object that represents the authentication settings to set.
targetSet*HostInternetScsiHbaTargetSet

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

Since vSphere API 4.0
*Need not be set

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for all other configuration failures.
NotFoundThrown if the host bus adapter could not be found.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



UpdateInternetScsiDigestProperties

Updates the digest properties for the iSCSI host bus adapter or the discovery addresses and targets associated with it.
Required Privileges
Host.Config.Storage
Since
vSphere API 4.0

Parameters

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

The device of the Internet SCSI HBA adapter.
targetSet*HostInternetScsiHbaTargetSet

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

The data object that represents the digest settings to set.
*Need not be set

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for all other configuration failures.
NotFoundThrown if the host bus adapter could not be found.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



UpdateInternetScsiDiscoveryProperties

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

Parameters

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

The device of the Internet SCSI HBA adapter.
discoveryPropertiesHostInternetScsiHbaDiscoveryProperties

The discovery settings for this host bus adapter.

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for all other configuration failures.
NotFoundThrown if the host bus adapter could not be found.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



UpdateInternetScsiIPProperties

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

Parameters

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

The device of the Internet SCSI HBA adapter.
ipPropertiesHostInternetScsiHbaIPProperties

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

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for all other configuration failures.
NotFoundThrown if the host bus adapter could not be found.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



UpdateInternetScsiName

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

Parameters

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

The current name of the Internet SCSI HBA adapter.
iScsiNamexsd:string

The new name for the Internet SCSI HBA adapter

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for all other configuration failures.
NotFoundThrown if the host bus adapter could not be found.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



UpdateScsiLunDisplayName

Update the mutable display name associated with a ScsiLun. The ScsiLun to be updated is identified using the specified uuid.
Required Privileges
Host.Config.Storage
Since
vSphere API 4.0

Parameters

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

The uuid of the ScsiLun to update.
displayNamexsd:string

The new name to assign to the ScsiLun object.

Return Value

Type Description
None

Faults

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

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

When this method is invoked on a VC server, uniqueness checks will be performed on the name. The uniqueness check will ensure that the name is unique with respect to the entire VC instance.
HostConfigFaultThrown for all other configuration failures.
InvalidNameThrown if the name does not meet name restrictions such as an 80 character limit.
NotFoundThrown if the device could not be found.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



UpdateSoftwareInternetScsiEnabled

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

Parameters

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

True to enable the iSCSI; false to disable it

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for any configuration failure.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



UpgradeVmfs

Upgrades the VMFS to the current VMFS version.
Required Privileges
Host.Config.Storage

Parameters

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

The path of the VMFS.

Return Value

Type Description
None

Faults

Type Description
HostConfigFaultThrown for all other configuration failures.
NotFoundThrown if the VMFS cannot be found.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



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.
Required Privileges
Host.Config.Storage

Parameters

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

Return Value

Type Description
None

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition