Host Storage System APIs
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.
Operations
POST
Host Storage System Add Internet Scsi Send Targets
Adds Send Target entries to the host bus adapter discovery list.
POST
Host Storage System Add Internet Scsi Static Targets
Adds Static Target entries to the host bus adapter discovery list.
POST
Host Storage System Attach Scsi Lun
Allow I/O issue to the specified detached ScsiLun.
POST
Host Storage System Attach Scsi Lun Ex Task
Attach one or more SCSI LUNs.
POST
Host Storage System Attach Vmfs Extent
Extends a VMFS by attaching a disk partition as an extent.
POST
Host Storage System Change NFS User Password
Change password for existing NFS user.
POST
Host Storage System Clear NFS User
Clear the NFS user configured on the esx host
POST
Host Storage System Compute Disk Partition Info
Computes the disk partition information given the desired disk layout.
POST
Host Storage System Compute Disk Partition Info For Resize
Computes the disk partition information for the purpose of resizing
a given partition.
POST
Host Storage System Connect Nvme Controller
Establish a connection to an NVME controller.
POST
Host Storage System Connect Nvme Controller Ex Task
Establish a connection to one or more NVMe controllers.
POST
Host Storage System Create Nvme Over Rdma Adapter
Creates a software NVME over RDMA adapter.
POST
Host Storage System Create Software Adapter
Creates a software host bus adapter based on the provided spec.
POST
Host Storage System Delete Scsi Lun State
For previously detached SCSI Lun, remove the state information from
host.
POST
Host Storage System Delete Vffs Volume State
For previously unmounted VFFS volume, remove the state information from
host.
POST
Host Storage System Delete Vmfs Volume State
For previously unmounted VMFS volume, remove the state information from
host.
POST
Host Storage System Destroy Vffs
Destroy a VFFS volume.
POST
Host Storage System Detach Scsi Lun
Disallow I/O issue to the specified ScsiLun.
POST
Host Storage System Detach Scsi Lun Ex Task
Detach one or more SCSI LUNs.
POST
Host Storage System Disable Multipath Path
Disables an enabled path for a Logical Unit.
POST
Host Storage System Disconnect Nvme Controller
Disconnect from an NVME controller.
POST
Host Storage System Disconnect Nvme Controller Ex Task
Disconnect from one or more NVMe controllers.
POST
Host Storage System Discover Fcoe Hbas
Initiates FCoE discovery using the given FcoeSpecification.
POST
Host Storage System Discover Nvme Controllers
Connects to a Discovery Controller and retrieves the Discovery Log
using the provided NvmeDiscoverSpec.
POST
Host Storage System Enable Multipath Path
Enables a disabled path for a Logical Unit.
POST
Host Storage System Expand Vmfs Extent
Expands a VMFS extent as specified by the Disk partition specification.
POST
Host Storage System Extend Vffs
Extends a VFFS by attaching a SSD.
POST
Host Storage System Format Vffs
Format a new VFFS on a SSD disk
POST
Host Storage System Format Vmfs
Formats a new VMFS on a disk partition.
GET
Host Storage System Get Available Field
List of custom field definitions that are valid for the object's type.
GET
Host Storage System Get File System Volume Info
File system volume information for the host.
GET
Host Storage System Get Multipath State Info
Runtime information about the state of a multipath path.
GET
Host Storage System Get Storage Device Info
Host storage information up to the device level.
GET
Host Storage System Get System File
Datastore paths of files used by the host system on
mounted volumes, for instance, the COS vmdk file of the
host.
GET
Host Storage System Get Value
List of custom field values.
POST
Host Storage System Mark As Local Task
Mark a disk to local disk, due to the reason that local disks
behind some controllers might not be recongized as local correctly.
POST
Host Storage System Mark As Non Local Task
Mark a disk to remote disk, which is the opposite operation of
*HostStorageSystem.MarkAsLocal_Task*
Task failure might lose existing claim rules on the disk.
POST
Host Storage System Mark As Non Ssd Task
Mark a disk to Non-SSD, which is the opposite operation of
*HostStorageSystem.MarkAsSsd_Task*
Task failure might lose existing claim rules on the disk.
POST
Host Storage System Mark As Ssd Task
Mark a disk to SSD, due to the reason that SSDs behind some controllers
might not be recongized as SSD correctly.
POST
Host Storage System Mark For Removal
Mark or unmark the given FCoE HBA for removal from the host system.
POST
Host Storage System Mark Perennially Reserved
Marks the specified LUN as perennially reserved.
POST
Host Storage System Mark Perennially Reserved Ex Task
Marks the specified one or more SCSI LUN's perennially reserved based
on the sate.
POST
Host Storage System Mount Vffs Volume
Mount the unmounted VFFS volume.
POST
Host Storage System Mount Vmfs Volume
Mount the unmounted Vmfs volume.
POST
Host Storage System Mount Vmfs Volume Ex Task
Mount one or more VMFS volumes.
POST
Host Storage System Query Available Ssds
Query the list SSD disks that can be used to contain a VFFS volume.
POST
Host Storage System Query NFS User
Query the NFS user configured on the esx host
POST
Host Storage System Query Path Selection Policy Options
Queries the set of path selection policy options.
POST
Host Storage System Query Storage Array Type Policy Options
Queries the set of storage array type policy options.
POST
Host Storage System Query Unresolved Vmfs Volume
Get the list of unbound VMFS volumes.
POST
Host Storage System Query Vmfs Config Option
Get the VMFS configuration options, including block size,
unmap granularity.
POST
Host Storage System Refresh Storage System
Obtains the latest host storage information related to storage devices, topology,
and file systems.
POST
Host Storage System Remove Internet Scsi Send Targets
Removes Send Target entries from the host bus adapter discovery list.
POST
Host Storage System Remove Internet Scsi Static Targets
Removes static target entries from the host bus adapter discovery list.
POST
Host Storage System Remove Nvme Over Rdma Adapter
Removes a software NVME over RDMA adapter.
POST
Host Storage System Remove Software Adapter
Removes a software host bus adapter, if the adapter type allows it.
POST
Host Storage System Rescan All Hba
Scans all host bus adapters to obtain the current list of devices and device topology.
POST
Host Storage System Rescan Hba
Issues a request to rescan a specific host bus adapter
for new storage devices.
POST
Host Storage System Rescan Vffs
Rescans for new VFFS.
POST
Host Storage System Rescan Vmfs
Rescans for new Virtual Machine File Systems (VMFS).
POST
Host Storage System Resolve Multiple Unresolved Vmfs Volumes
Resignature or 'Force Mount' list of unbound VMFS volumes.
POST
Host Storage System Resolve Multiple Unresolved Vmfs Volumes Ex Task
Resignature or 'Force Mount' list of unbound VMFS volumes.
POST
Host Storage System Retrieve Disk Partition Info
Gets the partition information for the disks named by the device names.
POST
Host Storage System Set Custom Value
Assigns a value to a custom field.
POST
Host Storage System Set Multipath Lun Policy
Updates the path selection policy for a Logical Unit.
POST
Host Storage System Set NFS User
Set NFS username and password on the host.
POST
Host Storage System Turn Disk Locator Led Off Task
Turn off one or more disk locator LEDs.
POST
Host Storage System Turn Disk Locator Led On Task
Turn on one or more disk locator LEDs, duration is the maximum that
hardware can support.
POST
Host Storage System Unmap Vmfs Volume Ex Task
Unmap one or more VMFS volumes.
POST
Host Storage System Unmount Force Mounted Vmfs Volume
Unmount the 'forceMounted' Vmfs volume.
POST
Host Storage System Unmount Vffs Volume
Unmount the VFFS volume.
POST
Host Storage System Unmount Vmfs Volume
Unmount the Vmfs volume.
POST
Host Storage System Unmount Vmfs Volume Ex Task
Unmount one or more VMFS volumes.
POST
Host Storage System Update Disk Partitions
Changes the partitions on the disk by supplying a partition specification
and the device name.
POST
Host Storage System Update Hpp Multipath Lun Policy
Updates the path selection policy for a HPP claimed Logical Unit.
POST
Host Storage System Update Internet Scsi Advanced Options
Updates the advanced options the iSCSI host bus adapter or the
discovery addresses and targets associated with it.
POST
Host Storage System Update Internet Scsi Alias
Updates the alias of an iSCSI host bus adapter.
POST
Host Storage System Update Internet Scsi Authentication Properties
Updates the authentication properties for one or more targets or
discovery addresses associated with an iSCSI host bus adapter.
POST
Host Storage System Update Internet Scsi Digest Properties
Updates the digest properties for the iSCSI host bus adapter or the
discovery addresses and targets associated with it.
POST
Host Storage System Update Internet Scsi Discovery Properties
Updates the Discovery properties for an iSCSI host bus adapter.
POST
Host Storage System Update Internet Scsi IP Properties
Updates the IP properties for an iSCSI host bus adapter.
POST
Host Storage System Update Internet Scsi Name
Updates the name of an iSCSI host bus adapter.
POST
Host Storage System Update Scsi Lun Display Name
Update the mutable display name associated with a ScsiLun.
POST
Host Storage System Update Software Internet Scsi Enabled
Enables or disables Software iSCSI.
POST
Host Storage System Update Vmfs Unmap Bandwidth
Update VMFS unmap bandwidth.
POST
Host Storage System Update Vmfs Unmap Priority
Update VMFS unmap priority.
POST
Host Storage System Upgrade Vmfs
Upgrades the VMFS to the *latest
supported VMFS version*.
POST
Host Storage System Upgrade Vm Layout
Iterates over all registered virtual machines.