|
| Local Properties | Local Methods | |
| Managed Object Types | Data Object Types | All Properties | All Methods |
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 | ||
Methods
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
| iScsiHbaDevice P | xsd:string |
The device of the Internet SCSI HBA adapter.
Since 2.0 |
| targets P | HostInternetScsiHbaSendTarget[] |
An array of iSCSI send targets.
Since 2.0 |
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 | |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
| iScsiHbaDevice P | xsd:string |
The device of the Internet SCSI HBA adapter.
Since 2.0 |
| targets P | HostInternetScsiHbaStaticTarget[] |
An array of iSCSI static targets to add.
Since 2.0 |
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 | |
attachScsiLun is part of the Unmount, Detach workflow used when a device will be permanently removed. See also UnmountVmfsVolume.
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
| lunUuid P | xsd:string |
The uuid of the ScsiLun to update.
Since vSphere API 5.0 |
Return Value
| Type | Description |
|---|---|
| None | |
Faults
| Type | Description |
|---|---|
| HostConfigFault | Thrown for all other configuration failures. |
| InvalidState | Thrown if
|
| 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 | |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
| lunUuid P | xsd:string[] |
each element specifies UUID of LUN to be attached.
Since vSphere API 6.0 |
Return Value
| Type | Description |
|---|---|
| ManagedObjectReference
to a Task |
Faults
| Type | Description |
|---|---|
| HostConfigFault | Thrown for host configuration failures. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
| vmfsPath P | xsd:string |
The path of the VMFS to extend. See FileSystemMountInfo.
Since 2.0 |
| extent P | HostScsiDiskPartition |
A data object that describes the specification of a
Disk partition.
Since 2.0 |
Return Value
| Type | Description |
|---|---|
| None | |
Faults
| Type | Description |
|---|---|
| HostConfigFault | Thrown for all other configuration failures. |
| NotFound | Thrown if the VMFS cannot be found or is unmounted. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
| password P | xsd:string |
New password.
Since vSphere API 6.0 |
Return Value
| Type | Description |
|---|---|
| None | |
Faults
| Type | Description |
|---|---|
| HostConfigFault | Unable to set passwords due to host configuration problem. |
| NotFound | NFS user is not set. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
Return Value
| Type | Description |
|---|---|
| None | |
Faults
| Type | Description |
|---|---|
| HostConfigFault | Unable to clear NFS user due to host configuration problem. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
| devicePath P | xsd:string |
The name of the device path for the specific disk. See HostDiskPartitionInfoPartitionFormat Since 2.0 |
| layout P | HostDiskPartitionLayout |
A data object that describes the disk partition layout. See HostDiskPartitionInfoPartitionFormat Since 2.0 |
| partitionFormat* P | xsd:string |
Specifies the desired partition format to be
computed from the block range.
If partitionFormat is not specified, the existing partitionFormat
on disk is used, if the disk is not blank and mbr otherwise. See HostDiskPartitionInfoPartitionFormat Since 2.0 |
Return Value
| Type | Description |
|---|---|
| HostDiskPartitionInfo | A data object that contains information about the partitions on a disk |
Faults
| Type | Description |
|---|---|
| HostConfigFault | Thrown if unable to get the current partition information for the device. See HostDiskPartitionInfoPartitionFormat |
| NotFound | Thrown if the device could not be found. See HostDiskPartitionInfoPartitionFormat |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
| partition P | HostScsiDiskPartition |
The disk partition to resize. See HostDiskPartitionInfoPartitionFormat Since vSphere API 4.0 |
| blockRange P | HostDiskPartitionBlockRange |
Specifies the desired block range for the resized
partition. The start of the block range specified should match
that of the current partition. See HostDiskPartitionInfoPartitionFormat Since vSphere API 4.0 |
| partitionFormat* P | xsd:string |
Specifies the desired partition format to be
computed from the block range.
If partitionFormat is not specified, the existing partitionFormat
on disk is used, if the disk is not blank and mbr otherwise. See HostDiskPartitionInfoPartitionFormat Since vSphere API 4.0 |
Return Value
| Type | Description |
|---|---|
| HostDiskPartitionInfo | resized disk partition information |
Faults
| Type | Description |
|---|---|
| HostConfigFault | Thrown if unable to get the current partition information for the device. See HostDiskPartitionInfoPartitionFormat |
| NotFound | Thrown if the device could not be found. See HostDiskPartitionInfoPartitionFormat |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
As a result, all the namespaces attached to the controller will be accessible through the adapter. For more details, see:
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
| connectSpec P | HostNvmeConnectSpec |
A data object that specifies the parameters
necessary to connect to the controller.
Since vSphere API 7.0 |
Return Value
| Type | Description |
|---|---|
| None | |
Faults
| Type | Description |
|---|---|
| HostConfigFault | Thrown if the host is unable to establish the connection. |
| NotFound | Thrown if the given HBA or transport target could not be found. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
| rdmaDeviceName P | xsd:string |
The device name of the RDMA device
to be used to create the software adapter.
Can be obtained from device.
Since vSphere API 7.0 |
Return Value
| Type | Description |
|---|---|
| None | |
Faults
| Type | Description |
|---|---|
| HostConfigFault | Thrown if the host is unable to create the adapter. |
| NotFound | Thrown if the given RDMA device could not be found. |
| ResourceInUse | Thrown if the RDMA device is already in use by an NVME over RDMA adapter. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
| lunCanonicalName P | xsd:string |
The 'canonicalName' of the ScsiLun
whose state needs to be deleted. See canonicalName Since vSphere API 5.0 |
Return Value
| Type | Description |
|---|---|
| None | |
Faults
| Type | Description |
|---|---|
| HostConfigFault | Thrown for any configuration failures. See canonicalName |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
deleteVffsVolumeState is part of the Unmount/Detach workflow used when the device will be permanently removed. See also UnmountVffsVolume. If the VFFS volume is unmounted using unmountVffsVolume, ESX maintains the state of VFFS volume. This API will remove the state from the host. If the underlying storage device is going to be un-provisioned on the array side, please detach the storage device. See also DetachScsiLun.
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
| vffsUuid P | xsd:string |
The VFFS UUID.
Since vSphere API 5.5 |
Return Value
| Type | Description |
|---|---|
| None | |
Faults
| Type | Description |
|---|---|
| HostConfigFault | Thrown for any configuration failures. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
deleteVmfsVolumeState is part of the Unmount/Detach workflow used when the device will be permanently removed. See also UnmountVmfsVolume. If the VMFS volume is unmounted using unmountVmfsVolume, ESX maintains the state of VMFS volume. This API will remove the state from the host. If the underlying storage device is going to be un-provisioned on the array side, please detach the storage device. See also DetachScsiLun.
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
| vmfsUuid P | xsd:string |
The VMFS UUID.
Since vSphere API 5.0 |
Return Value
| Type | Description |
|---|---|
| None | |
Faults
| Type | Description |
|---|---|
| HostConfigFault | Thrown for any configuration failures. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
| vffsPath P | xsd:string |
The path of the VFFS to destroy. See FileSystemMountInfo.
Since vSphere API 5.5 |
Return Value
| Type | Description |
|---|---|
| None | |
Faults
| Type | Description |
|---|---|
| HostConfigFault | Thrown for all other configuration failures. |
| NotFound | Thrown if the VFFS cannot be found or is unmounted. |
| ResourceInUse | VFFS volume is being used. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
detachScsiLun is part of the Unmount / Detach workflow used when a device will be permanently removed. See also UnmountVmfsVolume.
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
| lunUuid P | xsd:string |
The uuid of the ScsiLun device to detach.
Since vSphere API 5.0 |
Return Value
| Type | Description |
|---|---|
| None | |
Faults
| Type | Description |
|---|---|
| HostConfigFault | Thrown for all other configuration failures. |
| InvalidState | Thrown if
|
| NotFound | Thrown if the device could not be found. |
| ResourceInUse | Thrown if
|
| 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 | |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
| lunUuid P | xsd:string[] |
each element specifies UUID of LUN to be detached.
Since vSphere API 6.0 |
Return Value
| Type | Description |
|---|---|
| ManagedObjectReference
to a Task |
Faults
| Type | Description |
|---|---|
| HostConfigFault | Thrown for host configuration failures. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
| pathName P | xsd:string |
The name of the path to disable.
Since 2.0 |
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 | |
As a result, all the namespaces attached to the controller will no longer be accessible through the adapter.
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
| disconnectSpec P | HostNvmeDisconnectSpec |
A data object that specifies the parameters
necessary to perform the disconnection.
Since vSphere API 7.0 |
Return Value
| Type | Description |
|---|---|
| None | |
Faults
| Type | Description |
|---|---|
| HostConfigFault | Thrown if the host is unable to perform the disconnect. |
| NotFound | Thrown if the given HBA or controller could not be found. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
| fcoeSpec P | FcoeConfigFcoeSpecification |
Since vSphere API 5.0 |
Return Value
| Type | Description |
|---|---|
| None | |
Faults
| Type | Description |
|---|---|
| FcoeFaultPnicHasNoPortSet | |
| HostConfigFault | Thrown if the host is unable to issue FCoE discovery. |
| NotFound | Thrown if the given HBA could not be found. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
For more details, see:
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
| discoverSpec P | HostNvmeDiscoverSpec |
A data object that specifies the parameters
necessary to retrieve the Discovery Log.
Since vSphere API 7.0 |
Return Value
| Type | Description |
|---|---|
| HostNvmeDiscoveryLog | discoveryLog A data object that represents the Discovery Log. |
Faults
| Type | Description |
|---|---|
| HostConfigFault | Thrown if the host is unable to retrieve the discovery log. |
| NotFound | Thrown if the given HBA or transport target could not be found. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
| pathName P | xsd:string |
The name of the path to enable.
Since 2.0 |
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 | |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
| vmfsPath P | xsd:string |
The path of the VMFS to expand. See FileSystemMountInfo.
Since vSphere API 4.0 |
| extent P | HostScsiDiskPartition |
The disk partition corresponding to the extent to be
expanded.
Since vSphere API 4.0 |
Return Value
| Type | Description |
|---|---|
| None | |
Faults
| Type | Description |
|---|---|
| HostConfigFault | Thrown for all other configuration failures. |
| NotFound | Thrown if the VMFS cannot be found or is unmounted. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
| vffsPath P | xsd:string |
The path of the VFFS to extend. See FileSystemMountInfo. See devicePath Since vSphere API 5.5 |
| devicePath P | xsd:string |
Device path of the SSD disk. See devicePath Since vSphere API 5.5 |
| spec* P | HostDiskPartitionSpec |
A data object that describes the SSD disk partition
information. If this property is not provided, partition
information will be computed and generated. See devicePath Since vSphere API 5.5 |
Return Value
| Type | Description |
|---|---|
| None | |
Faults
| Type | Description |
|---|---|
| HostConfigFault | Thrown for all other configuration failures. See devicePath |
| NotFound | Thrown if the VFFS cannot be found or is unmounted. See devicePath |
| ResourceInUse | VFFS volume is being used. See devicePath |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
| createSpec P | HostVffsSpec |
A data object that describes the VFFS volume
creation specification.
Since vSphere API 5.5 |
Return Value
| Type | Description |
|---|---|
| HostVffsVolume | A data object that represents the VFFS file system. |
Faults
| Type | Description |
|---|---|
| AlreadyExists | Thrown if the volume name is already being used by another volume on the host. |
| HostConfigFault | Thrown for all other configuration failures. |
| ResourceInUse | VFFS volume is being used. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
| createSpec P | HostVmfsSpec |
A data object that describes the VMware File System
(VMFS) creation specification.
Since 2.0 |
Return Value
| Type | Description |
|---|---|
| HostVmfsVolume | A data object that represents the VMFS file system. |
Faults
| Type | Description |
|---|---|
| AlreadyExists | Thrown if the volume name is already being used by another volume on the host. |
| HostConfigFault | Thrown for all other configuration failures. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
| scsiDiskUuid P | xsd:string |
The SCSI disk UUID.
Since vSphere API 6.0 |
Return Value
| Type | Description |
|---|---|
| ManagedObjectReference
to a Task |
Faults
| Type | Description |
|---|---|
| HostConfigFault | Thrown for all other configuration failures. |
| NotFound | Thrown if the device could not be found. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
| scsiDiskUuid P | xsd:string |
The SCSI disk UUID.
Since vSphere API 6.0 |
Return Value
| Type | Description |
|---|---|
| ManagedObjectReference
to a Task |
Faults
| Type | Description |
|---|---|
| HostConfigFault | Thrown for all other configuration failures. |
| NotFound | Thrown if the device could not be found. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
| scsiDiskUuid P | xsd:string |
The SCSI disk UUID.
Since vSphere API 6.0 |
Return Value
| Type | Description |
|---|---|
| ManagedObjectReference
to a Task |
Faults
| Type | Description |
|---|---|
| HostConfigFault | Thrown for all other configuration failures. |
| NotFound | Thrown if the device could not be found. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
| scsiDiskUuid P | xsd:string |
The SCSI disk UUID.
Since vSphere API 6.0 |
Return Value
| Type | Description |
|---|---|
| ManagedObjectReference
to a Task |
Faults
| Type | Description |
|---|---|
| HostConfigFault | Thrown for all other configuration failures. |
| NotFound | Thrown if the device could not be found. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
| hbaName P | xsd:string |
Since vSphere API 5.0 |
| remove P | xsd:boolean |
Since vSphere API 5.0 |
Return Value
| Type | Description |
|---|---|
| None | |
Faults
| Type | Description |
|---|---|
| HostConfigFault | Thrown if the host does not support removing the given HBA. |
| NotFound | Thrown if the given HBA could not be found. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
| lunUuid P | xsd:string |
The UUID of the ScsiLun device to be marked as perennially
reserved.
Since vSphere API 6.7.2 |
| state P | xsd:boolean |
State of the ScsiLun perennially reserved flag to be set.
Since vSphere API 6.7.2 |
Return Value
| Type | Description |
|---|---|
| None | |
Faults
| Type | Description |
|---|---|
| HostConfigFault | Thrown if unable to change perennially reserved state. |
| NotFound | Thrown if the device could not be found. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
| lunUuid* P | xsd:string[] |
The UUIDs of the ScsiLun devices that need a change in
the perennially reserved flag state.
Since vSphere API 6.7.2 |
| state P | xsd:boolean |
State of the ScsiLun perennially reserved flag to be set.
Since vSphere API 6.7.2 |
Return Value
| Type | Description |
|---|---|
| ManagedObjectReference
to a Task |
Faults
| Type | Description |
|---|---|
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
mountVffsVolume is part of the Unmount / Detach workflow used when a device will be permanently removed. See also DetachScsiLun.
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
| vffsUuid P | xsd:string |
Since vSphere API 5.5 |
Return Value
| Type | Description |
|---|---|
| None | |
Faults
| Type | Description |
|---|---|
| HostConfigFault | Thrown for all other configuration failures. |
| InvalidState | Thrown if
|
| NotFound | Thrown if VFFS uuid is not found on the host. |
| ResourceInUse | VFFS volume is being used. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
mountVmfsVolume is part of the Unmount / Detach workflow used when a device will be permanently removed. See also DetachScsiLun.
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
| vmfsUuid P | xsd:string |
Since vSphere API 5.0 |
Return Value
| Type | Description |
|---|---|
| None | |
Faults
| Type | Description |
|---|---|
| HostConfigFault | Thrown for all other configuration failures. |
| InvalidState | Thrown if
|
| NotFound | Thrown if VMFS Uuid is not found on the host. |
| ResourceInUse | |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
| vmfsUuid P | xsd:string[] |
each element specifies the UUID of a VMFS volume to be unmounted.
Since vSphere API 6.0 |
Return Value
| Type | Description |
|---|---|
| ManagedObjectReference
to a Task |
Faults
| Type | Description |
|---|---|
| HostConfigFault | Thrown for host configuration failures. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
This operation will filter out SSD disks that are currently in use by an existing VFFS volume.
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
| vffsPath* P | xsd:string |
The path of the VFFS to extend. See FileSystemMountInfo.
Since vSphere API 5.5 |
Return Value
| Type | Description |
|---|---|
| HostScsiDisk[] | An array of data objects descrbing SSD disks. |
Faults
| Type | Description |
|---|---|
| HostConfigFault | Thrown if unable to query disk information. |
| NotFound | Thrown if the named VFFS volume is not found. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
Return Value
| Type | Description |
|---|---|
| HostNasVolumeUserInfo | UserInfo objects. See HostNasVolumeUserInfo |
Faults
| Type | Description |
|---|---|
| HostConfigFault | Unable to get NFS user due to host configuration problem. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
Filtering capabilities are not currently present but may be added in the future.
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 | |
Filtering capabilities are not currently present but may be added in the future.
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 | |
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 | |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
Return Value
| Type | Description |
|---|---|
| VmfsConfigOption[] | VMFS configuration options. |
Faults
| Type | Description |
|---|---|
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
This method may update the following inventory elements:
The Server performs asynchronous updates to the inventory. Use the PropertyCollector.WaitForUpdatesEx method to obtain the property changes.
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 | |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
| iScsiHbaDevice P | xsd:string |
The device of the Internet SCSI HBA adapter.
Since 2.0 |
| targets P | HostInternetScsiHbaSendTarget[] |
An array of iSCSI send targets to remove.
Since 2.0 |
| force* P | xsd:boolean |
flag for forced removal of iSCSI send targets.
If unset, force flag will be treated as false.
Since 2.0 |
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 | |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
| iScsiHbaDevice P | xsd:string |
The device of the Internet SCSI HBA adapter.
Since 2.0 |
| targets P | HostInternetScsiHbaStaticTarget[] |
An array of iSCSI static targets to remove.
Since 2.0 |
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 | |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
| hbaDeviceName P | xsd:string |
The device name of the NVME over RDMA adapter to be removed.
Since vSphere API 7.0 |
Return Value
| Type | Description |
|---|---|
| None | |
Faults
| Type | Description |
|---|---|
| HostConfigFault | Thrown if the host is unable to remove the given HBA. |
| NotFound | Thrown if the given HBA could not be found. |
| ResourceInUse | Thrown if the given HBA is in use. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
This method may update the following inventory elements:
The Server performs asynchronous updates to the inventory. Use the PropertyCollector.WaitForUpdatesEx method to obtain the property changes.
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 | |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
| hbaDevice P | xsd:string |
The device of the host bus adapter.
Since 2.0 |
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 | |
RescanVffs may update the HostSystem.Config.fileSystemVolume property. The Server performs asynchronous updates to the inventory. Use the PropertyCollector.WaitForUpdatesEx method to obtain the property changes.
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 | |
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.
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 | |
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.
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
| resolutionSpec P | HostUnresolvedVmfsResolutionSpec[] |
List of data object that describes what the disk
extents to be used for creating the new
VMFS volume.
Since vSphere API 4.0 |
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 | |
To safely enable sharing of the volume across hosts, a VMFS volume is bound to its underlying block device storage. When a low level block copy is performed to copy or move the VMFS volume, the copied volume will be unbound. In order for the VMFS volume to be usable, a resolution operation is needed to determine whether the VMFS volume should be treated as a new volume or not and what extents compose that volume in the event there is more than one unbound volume.
Resignature results in a new VMFS volume on the host. Operations performed at the HostStorageSystem interface apply only to a specific host. Hence, callers of this method are responsible for issuing rescan operations to detect the new VMFS volume on other hosts. Alternatively, callers that want VirtualCenter to handle rescanning the necessary hosts should use the HostDatastoreSystem interface.
When user wants to keep the original VMFS UUID and mount it on the host, set the resolutionSpec.uuidResolution (uuidResolution) to vim.host.UnresolvedVmfsResolutionSpec.VmfsUuidResolution#forceMount. This is per-host operation.
It will return an array of HostUnresolvedVmfsResolutionResult describing success or failure associated with each specification.
This method behaves the same as ResolveMultipleUnresolvedVmfsVolumes except that it returns a task to support monitoring the operation. This is important for operations with large number of unresolved volumes which may take potentially dozens of minutes to complete.
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
| resolutionSpec P | HostUnresolvedVmfsResolutionSpec[] |
List of data object that describes what the disk
extents to be used for creating the new
VMFS volume.
Since vSphere API 5.5 |
Return Value
| Type | Description |
|---|---|
| ManagedObjectReference
to a Task | This method returns a Task object with which to monitor the operation. The result property in the Task contains an array of HostUnresolvedVmfsResolutionResult describing success or failure associated with each specification. |
Faults
| Type | Description |
|---|---|
| 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 | |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
| devicePath P | xsd:string[] |
An array of device path names that identify disks.
See ScsiDisk.
Since 2.0 |
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 | |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
| lunId P | xsd:string |
The logical unit ID
Since 2.0 |
| policy P | HostMultipathInfoLogicalUnitPolicy |
A data object that describes a path selection policy for
the logical unit.
Since 2.0 |
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 | |
At present, this API supports only file system NFSv4.1.
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
| user P | xsd:string |
User to be saved on the the esx host
Since vSphere API 6.0 |
| password P | xsd:string |
Password for the user.
Since vSphere API 6.0 |
Return Value
| Type | Description |
|---|---|
| None | |
Faults
| Type | Description |
|---|---|
| HostConfigFault | Unable to set user/passwords due to host configuration problem. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
| scsiDiskUuids P | xsd:string[] |
The SCSI disk UUIDs for which the disk locator LED
should be turned off.
Since vSphere API 6.0 |
Return Value
| Type | Description |
|---|---|
| ManagedObjectReference
to a Task |
Faults
| Type | Description |
|---|---|
| HostConfigFault | Thrown for host configuration failures. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
| scsiDiskUuids P | xsd:string[] |
The SCSI disk UUIDs for which the disk locator LED
should be turned on.
Since vSphere API 6.0 |
Return Value
| Type | Description |
|---|---|
| ManagedObjectReference
to a Task |
Faults
| Type | Description |
|---|---|
| HostConfigFault | Thrown for host configuration failures. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
| vmfsUuid P | xsd:string[] |
each element specifies the UUID of a VMFS volume to be unmapped.
Since vSphere API 6.0 |
Return Value
| Type | Description |
|---|---|
| ManagedObjectReference
to a Task |
Faults
| Type | Description |
|---|---|
| HostConfigFault | Thrown for host configuration failures. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
| vmfsUuid P | xsd:string |
Since vSphere API 4.0 |
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 | |
unmountVffsVolume is part of the Unmount / Detach workflow used when a device will be permanently removed. See also DetachScsiLun.
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
| vffsUuid P | xsd:string |
Since vSphere API 5.5 |
Return Value
| Type | Description |
|---|---|
| None | |
Faults
| Type | Description |
|---|---|
| HostConfigFault | Thrown for all other configuration failures. |
| InvalidState | Thrown if
|
| NotFound | Thrown if VFFS uuid is not found on the host. |
| ResourceInUse | Thrown if
|
| 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 | |
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:
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
| vmfsUuid P | xsd:string |
Since vSphere API 5.0 |
Return Value
| Type | Description |
|---|---|
| None | |
Faults
| Type | Description |
|---|---|
| HostConfigFault | Thrown for all other configuration failures. |
| InvalidState | Thrown if
|
| NotFound | Thrown if VMFS Uuid is not found on the host. |
| ResourceInUse | Thrown if
|
| 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 | |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
| vmfsUuid P | xsd:string[] |
each element specifies the UUID of a VMFS volume to be unmounted.
Since vSphere API 6.0 |
Return Value
| Type | Description |
|---|---|
| ManagedObjectReference
to a Task |
Faults
| Type | Description |
|---|---|
| HostConfigFault | Thrown for host configuration failures. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
| devicePath P | xsd:string |
The name of the device path for the specific disk.
Since 2.0 |
| spec P | HostDiskPartitionSpec |
A data object that describes the disk partition table
specification used to configure the partitions on a disk.
Since 2.0 |
Return Value
| Type | Description |
|---|---|
| None | |
Faults
| Type | Description |
|---|---|
| HostConfigFault | Thrown for all other configuration failures. |
| NotFound | Thrown if the device could not be found. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
| Type | |
|---|---|
| None | |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
| lunId P | xsd:string |
The logical unit ID
Since vSphere API 7.0 |
| policy P | HostMultipathInfoHppLogicalUnitPolicy |
A data object that describes a path selection policy and
its configuration for the logical unit.
Since vSphere API 7.0 |
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 | |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
| iScsiHbaDevice P | xsd:string |
The device of the Internet SCSI HBA adapter.
Since vSphere API 4.0 |
| targetSet* P | HostInternetScsiHbaTargetSet |
The set the targets to configure. If not provided,
the settings will be applied to the host bus adapter itself.
Since vSphere API 4.0 |
| options P | HostInternetScsiHbaParamValue[] |
The list of options to set.
Since vSphere API 4.0 |
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 | |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
| iScsiHbaDevice P | xsd:string |
The device of the Internet SCSI HBA adapter.
Since 2.0 |
| iScsiAlias P | xsd:string |
The new value for the alias of the adapter.
Since 2.0 |
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 | |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
| iScsiHbaDevice P | xsd:string |
The device of the Internet SCSI HBA adapter.
associated with the target.
Since 2.0 |
| authenticationProperties P | HostInternetScsiHbaAuthenticationProperties |
The data object that represents
the authentication settings to set.
Since 2.0 |
| targetSet* P | HostInternetScsiHbaTargetSet |
The set the targets to configure. Optional,
when obmitted will configura the authentication properties
for the adapter instead.
Since 2.0 |
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 | |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
| iScsiHbaDevice P | xsd:string |
The device of the Internet SCSI HBA adapter.
Since vSphere API 4.0 |
| targetSet* P | HostInternetScsiHbaTargetSet |
The set the targets to configure. If not provided,
the settings will be applied to the host bus adapter itself.
Since vSphere API 4.0 |
| digestProperties P | HostInternetScsiHbaDigestProperties |
The data object that represents the digest
settings to set.
Since vSphere API 4.0 |
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 | |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
| iScsiHbaDevice P | xsd:string |
The device of the Internet SCSI HBA adapter.
Since 2.0 |
| discoveryProperties P | HostInternetScsiHbaDiscoveryProperties |
The discovery settings for this host bus adapter.
Since 2.0 |
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 | |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
| iScsiHbaDevice P | xsd:string |
The device of the Internet SCSI HBA adapter.
Since 2.0 |
| ipProperties P | HostInternetScsiHbaIPProperties |
A data object representing the IP properties
for the host bus adapter
Since 2.0 |
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 | |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
| iScsiHbaDevice P | xsd:string |
The current name of the Internet SCSI HBA adapter.
Since 2.0 |
| iScsiName P | xsd:string |
The new name for the Internet SCSI HBA adapter
Since 2.0 |
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 | |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
| lunUuid P | xsd:string |
The uuid of the ScsiLun to update.
Since vSphere API 4.0 |
| displayName P | xsd:string |
The new name to assign to the ScsiLun object.
Since vSphere API 4.0 |
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 | |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
| enabled P | xsd:boolean |
True to enable the iSCSI; false to disable it
Since 2.0 |
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 | |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
| vmfsUuid P | xsd:string |
The VMFS UUID.
Since vSphere API 6.7 |
| unmapBandwidthSpec P | VmfsUnmapBandwidthSpec |
Unmap bandwidth specification. See
VmfsUnmapBandwidthSpec
Since vSphere API 6.7 |
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 | |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
| vmfsUuid P | xsd:string |
The VMFS UUID.
Since vSphere API 6.5 |
| unmapPriority P | xsd:string |
Unmap priority. The supported values are defined in
HostVmfsVolumeUnmapPriority.
Since vSphere API 6.5 |
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 | |
Prerequisite:
All hosts that have mounted the volume must support the VMFS
version to which the volume will be upgraded.
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
| vmfsPath P | xsd:string |
The path of the VMFS.
Since 2.0 |
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 | |
On ESXi systems, this operation has no effect.
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 | |
| Top of page | Local Properties | Local Methods | |
| Managed Object Types | Data Object Types | All Properties | All Methods |