|
| 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 | 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 | |
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 | |
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 | xsd:string |
The uuid of the ScsiLun to update.
|
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. |
| 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 | |
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 |
| partitionFormat* | 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 5.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 |
| 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 | |
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 |
| partitionFormat* | 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 5.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 |
| 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 | |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
| lunCanonicalName | xsd:string |
The 'canonicalName' of the ScsiLun
whose state needs to be deleted. See canonicalName |
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 | |
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 | xsd:string |
The VMFS UUID.
|
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 | |
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 | xsd:string |
The uuid of the ScsiLun device to detach.
|
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. |
| 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 | |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
| fcoeSpec | FcoeConfigFcoeSpecification |
|
Return Value
| Type | Description |
|---|---|
| None | |
Faults
| Type | Description |
|---|---|
| FcoeFaultPnicHasNoPortSet | |
| HostConfigFault | Thrown if the host is unable to issue FCoE discovery. |
| InvalidArgument | Thrown if any parameter in the given FcoeSpecification is invalid. |
| 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. |
| 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 | |
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 | |
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 | |
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the HostStorageSystem used to make the method call. |
| hbaName | xsd:string |
|
| remove | xsd:boolean |
|
Return Value
| Type | Description |
|---|---|
| None | |
Faults
| Type | Description |
|---|---|
| HostConfigFault | Thrown if the host does not support removing the given HBA. |
| InvalidArgument | Thrown if the given HBA is not an FCoE 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 | |
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 | xsd:string |
|
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 | |
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 | |
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 | 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 | |
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 | |
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 | 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 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 | 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 | |
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 | |
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 | |
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 | |
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 | xsd:string |
|
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. |
| 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 | |
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.
|
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 | 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 | |
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 |
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 | 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.
|
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 | 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 | |
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 | |
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 | |
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 | |
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 | |
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 | 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 | |
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 |