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

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

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

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	xsd:string	The device of the Internet SCSI HBA adapter.
targets	HostInternetScsiHbaStaticTarget[]	An array of iSCSI static targets to add.

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

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	xsd:string	The path of the VMFS to extend. See FileSystemMountInfo.
extent	HostScsiDiskPartition	A data object that describes the specification of a Disk partition.

Return Value

Type	Description
None

Faults

Type	Description
HostConfigFault	Thrown for all other configuration failures.
InvalidArgument	Thrown if the new extent is already used by another vmfs volume, does not exist, or is of an invalid partition type.
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

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	xsd:string	The name of the device path for the specific disk. See HostDiskPartitionInfoPartitionFormat
layout	HostDiskPartitionLayout	A data object that describes the disk partition layout. See HostDiskPartitionInfoPartitionFormat

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
InvalidArgument	Thrown if the layout is invalid. 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

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	HostScsiDiskPartition	The disk partition to resize. See HostDiskPartitionInfoPartitionFormat
blockRange	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

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
InvalidArgument	Thrown if blockRange or partition is invalid. 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

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	xsd:string	The name of the path to disable.

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

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	xsd:string	The name of the path to enable.

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

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	xsd:string	The path of the VMFS to expand. See FileSystemMountInfo.
extent	HostScsiDiskPartition	The disk partition corresponding to the extent to be expanded.

Return Value

Type	Description
None

Faults

Type	Description
HostConfigFault	Thrown for all other configuration failures.
InvalidArgument	Thrown if the extent is not part of the VMFS volume.
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

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

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.
InvalidArgument	Thrown 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.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

QueryPathSelectionPolicyOptions

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

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

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

RefreshStorageSystem

Obtains the latest host storage information related to storage devices, topology, and file systems. The ESX host updates its storage information asynchronously. The RefreshStorageSystem method obtains information from the host platform and it performs a rescan of VMFS volumes. It does not look for new devices.

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

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	xsd:string	The device of the Internet SCSI HBA adapter.
targets	HostInternetScsiHbaSendTarget[]	An array of iSCSI send targets to remove.

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

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	xsd:string	The device of the Internet SCSI HBA adapter.
targets	HostInternetScsiHbaStaticTarget[]	An array of iSCSI static targets to remove.

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

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

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	xsd:string	The device of the host bus adapter.

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

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

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

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	xsd: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
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

SetMultipathLunPolicy

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	xsd:string	The logical unit ID
policy	HostMultipathInfoLogicalUnitPolicy	A data object that describes a path selection policy for the logical unit.

Return Value

Type	Description
None

Faults

Type	Description
HostConfigFault	Thrown for all other configuration failures.
InvalidArgument	Thrown if the policy is invalid.
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

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	xsd:string

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

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	xsd:string	The name of the device path for the specific disk.
spec	HostDiskPartitionSpec	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
HostConfigFault	Thrown for all other configuration failures.
InvalidArgument	Thrown if the spec is invalid.
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

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	xsd: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.
options	HostInternetScsiHbaParamValue[]	The list of options to set.

*Need not be set

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

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	xsd:string	The device of the Internet SCSI HBA adapter.
iScsiAlias	xsd:string	The new value for the alias of the adapter.

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

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	xsd:string	The device of the Internet SCSI HBA adapter. associated with the target.
authenticationProperties	HostInternetScsiHbaAuthenticationProperties	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
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

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	xsd: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.
digestProperties	HostInternetScsiHbaDigestProperties	The data object that represents the digest settings to set.

*Need not be set

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

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	xsd:string	The device of the Internet SCSI HBA adapter.
discoveryProperties	HostInternetScsiHbaDiscoveryProperties	The discovery settings for this host bus adapter.

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

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	xsd:string	The device of the Internet SCSI HBA adapter.
ipProperties	HostInternetScsiHbaIPProperties	A data object representing the IP properties for the host bus adapter

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

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	xsd:string	The current name of the Internet SCSI HBA adapter.
iScsiName	xsd:string	The new name for the Internet SCSI HBA adapter

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

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	xsd:string	The uuid of the ScsiLun to update.
displayName	xsd:string	The new name to assign to the ScsiLun object.

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

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	xsd:boolean	True to enable the iSCSI; false to disable it

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

UpgradeVmfs

Upgrades the VMFS to the latest supported VMFS version.

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	xsd:string	The path of the VMFS.

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

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