ESXCLI Commands
esxcli storage Commands
Command | Description | Options Help |
---|---|---|
storage core adapter list |
List all the SCSI Host Bus Adapters on the system. |
|
storage core adapter rescan |
Rescan SCSI HBAs to search for new Devices, remove DEAD paths and update path state. This operation will also run an claim operation equivalent to the claimrule run command and a filesystem rescan. |
|
storage core adapter capabilities list |
List the capabilities of the SCSI HBAs in the system. |
|
storage core adapter device list |
List the devices associated with HBAs. |
|
storage core adapter stats get |
List the SCSI stats for the SCSI Host Bus Adapters in the system. |
|
storage core claiming autoclaim |
Control the automatic PSA (path/device) claiming code allowing the disabling of the automatic claiming process or re-enabling of the claiming process if it was previously disabled. By default the automatic PSA claiming process is on and should not be disabled by users unless specifically instructed to do so. |
|
storage core claiming reclaim |
Attempt to unclaim all paths to a device and then run the loaded claimrules on each of the paths unclaimed to attempt to reclaim them. |
|
storage core claiming unclaim |
1) Unclaim a path or set of paths, disassociating them from a PSA plugin. NOTES: It is normal for path claiming to fail especially when unclaiming by plugin or adapter. Only inactive paths with no I/O will be able to be unclaimed. Typically the ESXi USB partition and devices with VMFS volumes on them will not be unclaimable. Also NOTE unclaiming will not persist and periodic path claiming will reclaim these paths in the near future unless claim rules are configured to mask the path. 2) Detach a (set of) filter(s) from one or more devices. |
|
storage core claimrule add |
Add a claimrule to the set of claimrules on the system. |
|
storage core claimrule convert |
Convert ESX 3.x style /adv/Disk/MaskLUNs LUN masks to Claim Rule format. WARNING: This conversion will not work for all input MaskLUNs variations! Please inspect the list of generated claim rules carefuly, then if the suggested LUN mask claim rules are correct use the --commit parameter to write the list to the config file. |
|
storage core claimrule list |
List all the claimrules on the system. |
|
storage core claimrule load |
Load path claiming rules from config file into the VMkernel. |
|
storage core claimrule move |
Move a claimrule from one rule id to another |
|
storage core claimrule remove |
Delete a claimrule to the set of claimrules on the system. |
|
storage core claimrule run |
Execute path claiming rules. |
|
storage core device list |
List the devices currently registered with the PSA. |
|
storage core device purge |
Removes storage devices which have not been seen in some time interval. |
|
storage core device set |
Modify the state of a storage device. |
|
storage core device setconfig |
Set device configuration |
|
storage core device capacity list |
List capacity information for the known storage devices. |
|
storage core device detached list |
Lists all devices that were detached manually by changing their state on the system. |
|
storage core device detached remove |
Provide control to allow a user to remove Detached devices from the persistent detached device list. |
|
storage core device inquirycache list |
List inquiry cache information for the known storage devices. |
|
storage core device inquirycache set |
Manipulate inquiry cache settings of storage devices. |
|
storage core device latencythreshold list |
List latency sensitive threshold for the known storage devices. |
|
storage core device latencythreshold set |
Set latency sensitive threshold for devices. This option is applicable only for devices claimed by MPPs that support fastpath. The device(s) can be selected based on the mutually exclusive parameters device name, vendor/model, NVMe controller model (For NVMe devices), PCIe vendor ID/PCIe sub vendor ID. See the examples for more details. |
|
storage core device partition list |
For a given device list all of the partitions |
|
storage core device partition showguid |
For a given device list the GUID for GPT partitions |
|
storage core device physical get |
Get information about a physical storage device. |
|
storage core device raid list |
List the physical devices that compose a given logical device. |
|
storage core device smart get |
List Smart device parameters. |
|
storage core device smart daemon start |
Enable smartd. |
|
storage core device smart daemon stop |
Disable smartd. |
|
storage core device smart daemon status get |
Get status of smartd. |
|
storage core device smart status get |
Get status of SMART stats on a device. |
|
storage core device smart status set |
Enable or disable SMART stats gathering on a device. |
|
storage core device stats get |
List the SCSI stats for SCSI Devices in the system. |
|
storage core device uidmap list |
Get a mapping between a device's primary UID and the alternative UIDs for that device on the system. |
|
storage core device vaai ats list |
List the ATS VAAI attributes (as per SCSI standard) for the devices. |
|
storage core device vaai clone list |
List the Clone VAAI attributes (as per SCSI standard) for the devices. |
|
storage core device vaai delete list |
List the Delete VAAI attributes (as per SCSI standard) for the devices. |
|
storage core device vaai status get |
List VAAI properties for devices currently registered with the PSA. |
|
storage core device vaai status set |
Enable/Disable VAAI operations on local SCSI disks. (NOTE: A request to enable an operation will take effect only if the underlying device supports the VAAI operation.) |
|
storage core device vaai zero list |
List the Zero VAAI attributes (as per SCSI standard) for the devices. |
|
storage core device world list |
Get a list of the worlds that are currently using devices on the ESX host. |
|
storage core nvme device list |
List the NVMe devices currently registered with the PSA. |
|
storage core nvme path list |
List all the NVMe paths on the system. |
|
storage core path list |
List all the storage paths on the system. |
|
storage core path set |
Provide control to allow a user to modify a single path's state. This efffectively allows a user to enable or disable storage paths. The user is not able to change the full range of path states, but can toggle between 'active' and 'off'. Please NOTE changing the Path state on any path that is the only path to a given device is likely to fail. The VMkernel will not change the path's state if changing the state would cause an 'All paths down' state or the device is currently in use. |
|
storage core path stats get |
List the SCSI stats for the SCSI Paths in the system. |
|
storage core plugin list |
List loaded PSA plugins on the system. |
|
storage core plugin registration add |
Register a plugin module with PSA. |
|
storage core plugin registration list |
List modules currently registered with PSA. |
|
storage core plugin registration remove |
UnRegister a plugin module with PSA. |
|
storage core scsi device list |
List the SCSI devices currently registered with the PSA. |
|
storage core scsi path list |
List all the SCSI paths on the system. |
|
storage filesystem automount |
Request mounting of known datastores not explicitly unmounted. |
|
storage filesystem list |
List the volumes available to the host. This includes VMFS, NAS, VFAT and UFS partitions. |
|
storage filesystem mount |
Connect to and mount an unmounted volume on the ESX host. |
|
storage filesystem rescan |
Scan storage devices for new mountable filesystems. |
|
storage filesystem unmount |
Disconnect and unmount and existing VMFS or NAS volume. This will not delete the configuration for the volume, but will remove the volume from the list of mounted volumes. |
|
storage fpin fc adapter list |
List FC adapters that support FPIN. |
|
storage fpin fc event list |
List all FPIN statistics of FC transport. |
|
storage fpin fc stats get |
Get the summary of FPIN statistics of FC transport. |
|
storage fpin fc target get |
Get FC targets connected to a FPIN supported HBA. |
|
storage fpin info get |
Get general FPIN information. |
|
storage hpp device list |
List the devices currently controlled by the VMware High Performance Plugin. |
|
storage hpp device set |
Configure settings for an HPP device. |
|
storage hpp device usermarkedssd list |
List the devices that were marked/unmarked as SSD by user. |
|
storage hpp path list |
List the paths currently claimed by the VMware High Performance Plugin |
|
storage iofilter enable |
Enable an iofilter. |
|
storage iofilter list |
List the iofilters installed on this host. |
|
storage nfs add |
Add a new NAS volume to the ESX Host and mount it with the given volume name. |
|
storage nfs list |
List the NAS volumes currently known to the ESX host. |
|
storage nfs remove |
Remove an existing NAS volume from the ESX host. |
|
storage nfs firewall add |
Add a new allowed IP/Mask entry in the nfsClient firewall ruleset |
|
storage nfs firewall list |
List the allowed IP/Mask entries from the nfsClient firewall ruleset. |
|
storage nfs firewall remove |
Remove an existing IP/Mask entry from the nfsClient firewall ruleset |
|
storage nfs param get |
Get the volume parameters of the NAS volumes. |
|
storage nfs param set |
Set the volume parameters of the NAS volumes. |
|
storage nfs41 add |
Add a new NFS v4.1 volume to the ESX Host and mount it with the given volume name. |
|
storage nfs41 list |
List the NFS v4.1 volumes currently known to the ESX host. |
|
storage nfs41 remove |
Remove an existing NFS v4.1 volume from the ESX host. |
|
storage nfs41 firewall add |
Add a new allowed IP/Mask entry in the nfs41Client firewall ruleset |
|
storage nfs41 firewall list |
List the allowed IP/Mask entries from the nfs41Client firewall ruleset. |
|
storage nfs41 firewall remove |
Remove an existing IP/Mask entry from the nfs41Client firewall ruleset |
|
storage nfs41 param get |
Get the volume parameters of the NFS v4.1 volumes. |
|
storage nfs41 param set |
Set the volume parameters of the NFS v4.1 volumes. |
|
storage nmp device list |
List the devices currently controlled by the VMware NMP Multipath Plugin and show the SATP and PSP information associated with that device. |
|
storage nmp device set |
Allow setting of the Path Selection Policy (PSP) for the given device to one of the loaded policies on the system. |
|
storage nmp path list |
List the paths currently claimed by the VMware NMP Multipath Plugin and show the SATP and PSP information associated with that path. |
|
storage nmp psp list |
List the Path Selection Plugins (PSP) that are currently loaded into the NMP system and display information about those PSPs |
|
storage nmp psp fixed deviceconfig get |
Allow retrieving of Fixed Path Selection Policy settings for a given device. |
|
storage nmp psp fixed deviceconfig set |
Allow setting of the perferred path on a given device controlled by the Fixed Path Selection Policy. |
|
storage nmp psp generic deviceconfig get |
Allow retrieving of per device PSP configuration parameters. |
|
storage nmp psp generic deviceconfig set |
Allow setting of per device PSP configuration parameters. This command will set the configuration for the given device with whichever PSP it is currently configurated with. |
|
storage nmp psp generic pathconfig get |
Allow retrieving of per path PSP configuration parameters. |
|
storage nmp psp generic pathconfig set |
Allow setting of per path PSP configuration parameters. This command will set the configuration for the given path with whichever PSP it is currently configurated with. |
|
storage nmp psp roundrobin deviceconfig get |
Allow retrieving of Round Robin Path Selection Policy settings for a given device. |
|
storage nmp psp roundrobin deviceconfig set |
Allow setting of the Round Robin path options on a given device controlled by the Round Robin Selection Policy. |
|
storage nmp satp list |
List the Storage Array Type Plugins (SATP) that are currently loaded into the NMP system and display information about those SATPs |
|
storage nmp satp set |
Set the default Path Selection Policy for a given Storage Array Type Plugin (SATP). |
|
storage nmp satp generic deviceconfig get |
Allow retrieving of per device SATP configuration parameters. |
|
storage nmp satp generic deviceconfig set |
Allow setting of per device SATP configuration parameters. This command will set the configuration for the given device with whichever SATP it is currently configurated with. |
|
storage nmp satp generic pathconfig get |
Allow retrieving of per path SATP configuration parameters. |
|
storage nmp satp generic pathconfig set |
Allow setting of per path SATP configuration parameters. This command will set the configuration for the given path with whichever SATP it is currently configurated with. |
|
storage nmp satp rule add |
Add a rule to the list of claim rules for the given SATP. |
|
storage nmp satp rule list |
List the claiming rules for Storage Array Type Plugins (SATP) |
|
storage nmp satp rule remove |
Delete a rule from the list of claim rules for the given SATP. |
|
storage osdata create |
Create an OSData partition on a disk. |
|
storage san fc list |
List attributes of all FC adapters on the system. |
|
storage san fc reset |
Perform LIP (Loop Initiation Primitive) Reset to a given FC adapter on the system. |
|
storage san fc events clear |
Clear events for a given FC adapter on the system. |
|
storage san fc events get |
Get Events for FC Devices |
|
storage san fc stats get |
Get statistics for a given FC adapter, or all FC adapters on the system. |
|
storage san fcoe list |
List attributes of all FCoE adapters on the system. |
|
storage san fcoe reset |
Perform LIP (Loop Initiation Primitive) Reset to a given FCoE adapter on the system. |
|
storage san fcoe stats get |
Get statistics for a given FCoE adapter, or all FCoE adapters on the system. |
|
storage san iscsi list |
List attributes of all Software iSCSI adapters on the system. |
|
storage san iscsi stats get |
Get statistics for Software iSCSI adapter. |
|
storage san sas list |
List all SAS IO Device Management devices. |
|
storage san sas reset |
Perform SAS Reset |
|
storage san sas stats get |
List Stats for given device, or all devices. |
|
storage vflash device list |
List vflash SSD devices. |
|
storage vflash module get |
Get vflash module info. |
|
storage vflash module list |
List vflash modules. |
|
storage vflash module stats get |
Get vflash module statistics |
|
storage vmfs unmap |
Reclaim the space by unmapping free blocks from VMFS Volume |
|
storage vmfs upgrade |
Upgrade a VMFS3 volume to VMFS5. |
|
storage vmfs extent list |
List the VMFS extents available on the host. |
|
storage vmfs host list |
List hosts accessing a particular VMFS Volume. |
|
storage vmfs lockmode list |
List the on-disk critical section locking mode for VMFS volumes available on this host. |
|
storage vmfs lockmode set |
Update the on-disk critical section locking mode for a particular VMFS Volume. |
|
storage vmfs pbcache get |
Get VMFS Pointer Block cache statistics. |
|
storage vmfs pbcache reset |
Reset the VMFS Pointer Block cache statistics. |
|
storage vmfs reclaim config get |
Get space reclamation configuration parameters |
|
storage vmfs reclaim config set |
Set space reclamation configuration parameters |
|
storage vmfs snapshot list |
List unresolved snapshots/replicas of VMFS volume. |
|
storage vmfs snapshot mount |
Mount a snapshot/replica of a VMFS volume. |
|
storage vmfs snapshot resignature |
Resignature a snapshot/replica of a VMFS volume. |
|
storage vmfs snapshot extent list |
List extents of unresolved snapshots/replicas of VMFS volume. |
|
storage vvol daemon unbindall |
Unbind all Virtual Volumes from all VASA Providers known to this host. |
|
storage vvol nvme info get |
Get vVol NVMe host information. |
|
storage vvol protocolendpoint list |
List the VVol Protocol EndPoints currently known to this host. |
|
storage vvol protocolendpoint startforceunbind |
Unbind all Virtual Volumes on the PE with zero open handle count. |
|
storage vvol stats add |
Add entity for stats tracking |
|
storage vvol stats disable |
Disable stats for complete namespace |
|
storage vvol stats enable |
Enable stats for complete namespace |
|
storage vvol stats get |
Get stats for given stats namespace |
|
storage vvol stats list |
List all supported stats |
|
storage vvol stats remove |
Remove tracked entity |
|
storage vvol stats reset |
Reset stats for given namespace |
|
storage vvol storagearray list |
VVol VASA Storage Array |
|
storage vvol storagearray container list |
List VVol containers for storage arrays known to this host. |
|
storage vvol storagearray protocolendpoint list |
List Protocol Endpoints for storage arrays known to this host. |
|
storage vvol storagecontainer list |
List VVol storage containers known to this host. |
|
storage vvol storagecontainer abandonedvvol scan |
Scans the specified storage container for abandoned VVols. |
|
storage vvol vasacontext get |
Get the VVol VASA Context (vCenter UUID). |
|
storage vvol vasaprovider list |
List the VASA Providers registered on this host. |
|
storage vvol virtualvolume unmap |
Reclaim the space by unmapping free blocks from VMFS config volume. |
|
storage vvol vmstats get |
Get the VVol information and statistics for a specific virtual machine. |
|