Managed Object -
HostStorageSystem
- Property of
-
HostConfigManager
- See also
-
HostDiskPartitionInfo, HostDiskPartitionLayout, HostDiskPartitionSpec, HostFileSystemVolumeInfo, HostInternetScsiHbaAuthenticationProperties, HostInternetScsiHbaDiscoveryProperties, HostInternetScsiHbaIPProperties, HostInternetScsiHbaSendTarget, HostInternetScsiHbaStaticTarget, HostMultipathInfoLogicalUnitPolicy, HostScsiDiskPartition, HostStorageDeviceInfo, HostVmfsSpec, HostVmfsVolume
Managed Object Description
This managed object gets and sets configuration information
about the host's storage subsystem. The properties and operations are
used to configure the host to make storage available for virtual machines.
This object contains properties that are specific to ESX Server and
general to both the ESX Server system and the hosted architecture.
Properties
Methods
|
Methods defined in this Managed Object
|
| AddInternetScsiSendTargets, AddInternetScsiStaticTargets, AttachVmfsExtent, ComputeDiskPartitionInfo, DisableMultipathPath, EnableMultipathPath, FormatVmfs, RefreshStorageSystem, RemoveInternetScsiSendTargets, RemoveInternetScsiStaticTargets, RescanAllHba, RescanHba, RescanVmfs, RetrieveDiskPartitionInfo, SetMultipathLunPolicy, UpdateDiskPartitions, UpdateInternetScsiAlias, UpdateInternetScsiAuthenticationProperties, UpdateInternetScsiDiscoveryProperties, UpdateInternetScsiIPProperties, UpdateInternetScsiName, UpdateSoftwareInternetScsiEnabled, UpgradeVmfs, UpgradeVmLayout |
AddInternetScsiSendTargets
Adds Send Target entries to the host bus adapter discovery list.
The DiscoveryProperties.sendTargetsDiscoveryEnabled flag
must be set to true.
- Required Privileges
- Host.Config.Storage
Parameters
Return Value
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. |
Show WSDL type definition
AddInternetScsiStaticTargets
Adds Static Target entries to the host bus adapter discovery list.
The DiscoveryProperty.staticTargetDiscoveryEnabled must be set to true.
- Required Privileges
- Host.Config.Storage
Parameters
Return Value
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. |
Show WSDL type definition
AttachVmfsExtent
Extends a VMFS by attaching a disk partition as an extent.
- Required Privileges
- Host.Config.Storage
Parameters
Return Value
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. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Show WSDL type definition
ComputeDiskPartitionInfo
Computes the disk partition information given the desired disk layout.
The server computes a new partition information object for a specific
disk representing the desired layout.
- Required Privileges
- Host.Config.Storage
Parameters
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. |
| InvalidArgument | Thrown if the layout 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. |
Show WSDL type definition
DisableMultipathPath
Disables an enabled path for a Logical Unit.
Use the path name from HostMultipathInfoPath.
- Required Privileges
- Host.Config.Storage
Parameters
Return Value
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. |
Show WSDL type definition
EnableMultipathPath
Enables a disabled path for a Logical Unit.
Use the path name from HostMultipathInfoPath.
- Required Privileges
- Host.Config.Storage
Parameters
Return Value
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. |
Show WSDL type definition
FormatVmfs
Formats a new VMFS on a disk partition.
- Required Privileges
- Host.Config.Storage
Parameters
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. |
Show WSDL type definition
RefreshStorageSystem
Refresh the storage information and settings to pick up any changes
that might have occurred.
- Required Privileges
- Host.Config.Storage
Parameters
Return Value
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. |
Show WSDL type definition
RemoveInternetScsiSendTargets
Removes Send Target entries from the host bus adapter discovery list.
The DiscoveryProperty.sendTargetsDiscoveryEnabled must be set to true.
If any of the targets provided as parameters are not found in
the existing list, the other targets are removed and an exception
is thrown.
- Required Privileges
- Host.Config.Storage
Parameters
Return Value
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. |
Show WSDL type definition
RemoveInternetScsiStaticTargets
Removes static target entries from the host bus adapter discovery list.
The DiscoveryProperty.staticTargetDiscoveryEnabled must be set to true.
If any of the targets provided as parameters are not found in
the existing list, the other targets are removed and an exception
is thrown.
- Required Privileges
- Host.Config.Storage
Parameters
Return Value
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. |
Show WSDL type definition
RescanAllHba
Issues a request to rescan all virtual machine host bus adapters
for new storage devices.
- Required Privileges
- Host.Config.Storage
Parameters
Return Value
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. |
Show WSDL type definition
RescanHba
Issues a request to rescan a specific virtual machine host bus adapter
for new storage devices.
- Required Privileges
- Host.Config.Storage
Parameters
Return Value
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. |
Show WSDL type definition
RescanVmfs
Rescans for new VMFSs that might have been added.
- Required Privileges
- Host.Config.Storage
Parameters
Return Value
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. |
Show WSDL type definition
RetrieveDiskPartitionInfo
Gets the partition information for the disks named by the device names.
- Required Privileges
- System.Read
Parameters
Return Value
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. |
Show WSDL type definition
SetMultipathLunPolicy
Sets the multipath policy for a Logical Unit.
Use the LUN uuid from HostMultipathInfoLogicalUnit.
- Required Privileges
- Host.Config.Storage
Parameters
Return Value
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. |
Show WSDL type definition
UpdateDiskPartitions
Changes the partitions on the disk by supplying a partition specification
and the device name.
- Required Privileges
- Host.Config.Storage
Parameters
| 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
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. |
Show WSDL type definition
UpdateInternetScsiAlias
Updates the alias of an iSCSI host bus adapter.
- Required Privileges
- Host.Config.Storage
Parameters
| Name | Type | Description |
| _this | ManagedObjectReference |
A reference to the
HostStorageSystem
used to make the method call.
|
| iScsiHbaDevice | xsd:string |
The device of the Internet SCSI HBA adapter.
|
| iScsiAlias | xsd:string |
The new value for the alias of the adapter.
|
Return Value
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. |
Show WSDL type definition
UpdateInternetScsiAuthenticationProperties
Updates the authentication properties for an iSCSI host bus adapter.
- Required Privileges
- Host.Config.Storage
Parameters
Return Value
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. |
Show WSDL type definition
UpdateInternetScsiDiscoveryProperties
Updates the Discovery properties for an iSCSI host bus adapter.
- Required Privileges
- Host.Config.Storage
Parameters
Return Value
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. |
Show WSDL type definition
UpdateInternetScsiIPProperties
Updates the IP properties for an iSCSI host bus adapter.
- Required Privileges
- Host.Config.Storage
Parameters
Return Value
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. |
Show WSDL type definition
UpdateInternetScsiName
Updates the name of an iSCSI host bus adapter.
- Required Privileges
- Host.Config.Storage
Parameters
| Name | Type | Description |
| _this | ManagedObjectReference |
A reference to the
HostStorageSystem
used to make the method call.
|
| iScsiHbaDevice | xsd:string |
The current name of the Internet SCSI HBA adapter.
|
| iScsiName | xsd:string |
The new name for the Internet SCSI HBA adapter
|
Return Value
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. |
Show WSDL type definition
UpdateSoftwareInternetScsiEnabled
Enables or disables Software iSCSI.
- Required Privileges
- Host.Config.Storage
Parameters
Return Value
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. |
Show WSDL type definition
UpgradeVmfs
Upgrades the VMFS to the current VMFS version.
- Required Privileges
- Host.Config.Storage
Parameters
Return Value
Faults
|
Type
|
Description
|
| HostConfigFault | Thrown for all other configuration failures. |
| NotFound | Thrown if the VMFS 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. |
Show WSDL type definition
UpgradeVmLayout
Iterates over all registered virtual machines. For each VM which .vmx file
is located on the service console and all disks are available on VMFS3 or NAS,
it will relocate the disks into directories if stored in the ROOT, and
relocate the VMX file into the directory too. Events are logged for each
virtual machine that is relocated.
- Required Privileges
- Host.Config.Storage
Parameters
Return Value
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. |
Show WSDL type definition