ESXCLI full commands list for ESXi 8.0

Last column indicate What is NEW in ESXi 8.0. ESXCLI 8.0 – MindMap

ESXi 8.0 ESXCLI Command Reference

The ESXCLI command set allows you to run common system administration commands against vSphere systems from an administration server of your choice. The actual list of commands depends on the system that you are running on. Run esxcli --help for a list of commands on your system.
NamespaceCommandDescriptionNEW
daemon controlrestartRestart the daemons for the specified solution ID.
daemon controlstartStart the daemons for the specified solution ID.
daemon controlstopStop the daemons for the specified DSDK built solution.
daemon entitlementaddAdd Partner REST entitlements to the partner user.1
daemon entitlementlistList the installed DSDK built daemons.1
daemon entitlementremoveRemove Partner REST entitlments from the partner user.1
daemon infogetGet running daemon status for the specified solution ID.
daemon infolistList the installed DSDK built daemons.
deviceaddAdd a device to enable a software device driver.
device aliasgetDisplay hardware location info for a device alias.
device aliaslistList device aliases.
device driverlistShow driver status for specific devices.
device softwareaddAdd a device to enable a software device driver.
device softwarelistList software devices.
device softwareremoveRemove a software device.
esxcli commandlistList all of the esxcli commands.
fcoe adapterlistList FCOE-capable CNA devices (Deprecated).
fcoe adapterremoveInitiate FCOE adapter removal (Deprecated).
fcoe nicdisableDisable rediscovery of FCOE storage on behalf of an FCOE-capable CNA upon next boot (Deprecated).
fcoe nicdiscoverInitiate FCOE adapter discovery on behalf of an FCOE-capable CNA (Deprecated).
fcoe nicenableEnable an FCOE-capable NIC if it is disabled (Deprecated).
fcoe niclistList FCOE-capable CNA devices (Deprecated).
fcoe nicremoveDeactivate FCOE configuration for given NIC (Deprecated).
fcoe nicsetSet options on FCOE-capable CNA (Deprecated).
graphics devicelistList all of the graphics devices on this host.
graphics devicesetSet graphics device property. If setting "type", restart Xorg e.g. "/etc/init.d/xorg restart" for change to take effect.
graphics device statslistList graphics device statistics.
graphics hostgetGet host graphics properties.
graphics hostrefreshRefresh host graphics properties.
graphics hostsetSet host graphics properties.
graphics vmlistList active VMs associated with graphics devices.
hardware bootdevicelistList the boot device order, if available, for this host.
hardware clockgetDisplay the current hardware clock time.
hardware clocksetSet the hardware clock time. Any missing parameters will default to the current time.
hardware cpu cpuidgetGet subset of CPUID fields for a CPU (deprecated, use: esxcli hardware cpu cpuid raw list).
hardware cpu cpuid rawlistGet all CPUID fields for a CPU.
hardware cpu globalgetGet properties that are global to all CPUs.
hardware cpu globalsetSet properties that are global to all CPUs.
hardware cpulistList all of the CPUs on this host.
hardware devicecomponentlistList all device components on this host.1
hardware ipmi bmcgetGet IPMI Baseboard Management Controller (BMC) properties.
hardware ipmi bmcsetSet IPMI Baseboard Management Controller (BMC) properties. Changes take effect immediately.
hardware ipmi frugetGet IPMI Field Replaceable Unit (FRU) device details.
hardware ipmi frulistList IPMI Field Replaceable Unit (FRU) inventory.
hardware ipmi sdrgetGet IPMI Sensor Data Repository (SDR) properties.
hardware ipmi sdrlistList IPMI Sensor Data Repository.
hardware ipmi selclearClear IPMI System Event Log.
hardware ipmi selgetGet IPMI System Event Log (SEL) properties.
hardware ipmi sellistList IPMI System Event Log.
hardware memorygetGet information about memory.
hardware pcilistList all of the PCI devices on this host.
hardware pci pcipassthrulistDisplay PCI device passthru configuration.
hardware pci pcipassthrusetConfigure PCI device for passthrough.
hardware platformgetGet information about the platform
hardware power policy choiceslistList the power policies.
hardware power policygetDisplay the current power policy.
hardware power policysetSet the power policy.
hardware smartcard certificatelistCertificates from inserted smart cards.
hardware smartcard infogetInformation about the smart card subsystem.
hardware smartcard slotlistInformation about connected smart card readers.
hardware smartcard tokenlistInformation about inserted smart cards.
hardware tpm tagclearClear the TPM's tag.
hardware tpm taggetGet the TPM's tag.
hardware tpm tagsetSet the TPM's tag.
hardware trustedbootgetInformation about the status of trusted boot. (TPM, DRTM status)
hardware usb passthrough devicedisableDisable usb passthrough
hardware usb passthrough deviceenableEnable usb passthrough
hardware usb passthrough devicelistList usb devices and their passthrough status
iscsi adapter auth chapgetGet the iSCSI CHAP authentication for the iSCSI Host Bus Adapter.
iscsi adapter auth chapsetSet the iSCSI CHAP authentication for the iSCSI Host Bus Adapter.
iscsi adapter capabilitiesgetList the iSCSI details for the iSCSI Host Bus Adapter.
iscsi adapter discoveryrediscoverDo the iSCSI Discovery for the iSCSI Host Bus Adapter.
iscsi adapter discovery sendtargetaddAdd a sendtarget address
iscsi adapter discovery sendtarget auth chapgetGet iSCSI CHAP authentication on a sendtarget address
iscsi adapter discovery sendtarget auth chapsetSet iSCSI CHAP authentication on a sendtarget address
iscsi adapter discovery sendtargetlistList sendtarget addresses
iscsi adapter discovery sendtarget paramgetGet iSCSI parameter on a sendtarget address
iscsi adapter discovery sendtarget paramsetSet the iSCSI parameter for the iSCSI Sendtarget.
iscsi adapter discovery sendtargetremoveRemove a sendtarget address
iscsi adapter discovery statictargetaddAdd a static target address
iscsi adapter discovery statictargetlistList static target addresses
iscsi adapter discovery statictargetremoveRemove a static target
iscsi adapter discovery statusgetGet the iSCSI adapter discovery status for the iSCSI Host Bus Adapter.
iscsi adapter firmwaregetValidate the iSCSI firmware for the iSCSI Host Bus Adapter.
iscsi adapter firmwaresetUpload the iSCSI firmware for the iSCSI Host Bus Adapter.
iscsi adaptergetList the iSCSI information for the iSCSI Host Bus Adapter.
iscsi adapterlistList all the iSCSI Host Bus Adapters on the system.
iscsi adapter paramgetGet the iSCSI parameters for the iSCSI Host Bus Adapter.
iscsi adapter paramsetSet the iSCSI parameter for the iSCSI Host Bus Adapter.
iscsi adaptersetSet the iSCSI name and alias for the iSCSI Host Bus Adapter.
iscsi adapter targetlistList iSCSI targets.
iscsi adapter target lunlistGet iSCSI LUN information
iscsi adapter target portal auth chapgetGet iSCSI CHAP authentication on a target
iscsi adapter target portal auth chapsetSet the iSCSI CHAP authentication for the iSCSI Target.
iscsi adapter target portallistList iSCSI target portals.
iscsi adapter target portal paramgetGet iSCSI parameter on a target
iscsi adapter target portal paramsetSet the iSCSI parameter for the iSCSI Target.
iscsi ibftbootgetGet iSCSI IBFT Boot details.
iscsi ibftbootimportImport iSCSI target configuration from iBFT to ESX iSCSI initiators. The boot target recorded in iBFT is added to all the eligible 'dependent' iSCSI adapters.
iscsi logicalnetworkportallistList Logical Network Portals for iSCSI Adapter
iscsi networkportaladdAdd a network portal for iSCSI adapter
iscsi networkportal ipconfiggetGet iSCSI network portal ipv4 configuration
iscsi networkportal ipconfigsetSet iSCSI network portal IPv4 configuration.
iscsi networkportal ipv6config addressaddAdd IPv6 addresses to the given iSCSI network portal.
iscsi networkportal ipv6config addresslistList the IPv6 addresses assigned to the iSCSI network portal.
iscsi networkportal ipv6config addressremoveRemove IPv6 addresses from the given iSCSI network portal.
iscsi networkportal ipv6configgetGet iSCSI network portal ipv6 configuration
iscsi networkportal ipv6configsetSet iSCSI network portal IPv6 configuration.
iscsi networkportallistList Network Portal for iSCSI Adapter
iscsi networkportalremoveRemove a network portal for iSCSI adapter
iscsi physicalnetworkportallistList Physical Network Portal for iSCSI Adapter
iscsi physicalnetworkportal paramgetGet network parameters on a Physical Network Portal (vmnic)
iscsi physicalnetworkportal paramsetSet network parameter on a Physical Network Portal
iscsi pluginlistList IMA plugins.
iscsi sessionaddLogin sessions on current iSCSI configuration.
iscsi session connectionlistList iSCSI connections.
iscsi sessionlistList iSCSI Sessions.
iscsi sessionremoveLogout sessions on current iSCSI configuration.
iscsi softwaregetSoftware iSCSI information.
iscsi softwaresetEnable or disable software iSCSI.
network diagpingSend ICMP echo requests to network hosts.
network ens lcoreaddCreate ENS context.
network ens lcore affinitygetGet the affinity for given ENS context.
network ens lcore affinitysetSet affinity for given ENS context.
network ens lcorelistList ENS contexts.
network ens lcoreremoveDestroy ENS context.
network ens lcore switchaddAssociate given ENS context with given switch.
network ens lcore switchgetGet the switch associated with given ENS context.
network ens lcore switchremoveDisassociate given ENS context from virtual switch.
network ens maxLcoresgetGet the maximum number of ENS contexts (lcores).
network ens maxLcoressetSet the maximum number of ENS contexts.
network firewallgetGet the firewall status.
network firewallloadLoad firewall module and rulesets configuration.
network firewallrefreshLoad ruleset configuration for firewall.
network firewall ruleset allowedipaddAdd allowed ip address/range to the ruleset ruleset.
network firewall ruleset allowediplistlist allowed ip addresses for rulesets.
network firewall ruleset allowedipremoveRemove allowed ip address/range from the ruleset.
network firewall ruleset clientaddAdd a new client to a firewall ruleset. This enables the firewall ruleset and increments the number of clients using the ruleset.
network firewall ruleset clientgetShow the number of clients using a firewall ruleset.
network firewall ruleset clientremoveRemove a client from a firewall ruleset. This decrements the number of clients using the ruleset and if the number reaches zero the ruleset is disabled.
network firewall rulesetlistList the rulesets in firewall.
network firewall ruleset rulelistList the rules of each ruleset in firewall.
network firewall rulesetsetSet firewall ruleset status (allowedAll flag and enabled status).
network firewallsetSet firewall enabled status and default action.
network firewallunloadAllow unload firewall module.
network ip connectionlistList active TCP/IP connections
network ip dns searchaddAdd a search domain to the list of domains to be searched when trying to resolve an host name on the ESXi host.
network ip dns searchlistList the search domains currently configured on the ESXi host in the order in which they will be used when searching.
network ip dns searchremoveRemove a search domain from the list of domains to be searched when trying to resolve an host name on the ESXi host.
network ip dns serveraddAdd a new DNS server to the end of the list of DNS servers to use for this ESXi host.
network ip dns serverlistPrint a list of the DNS server currently configured on the system in the order in which they will be used.
network ip dns serverremoveRemove a DNS server from the list of DNS servers to use for this ESXi host.
network ipgetGet global IP settings
network ip hostsaddAdd association of IP addresses with host names.1
network ip hostslistList the user specified associations of IP addresses with host names.1
network ip hostsremoveRemove association of IP addresses with host names.1
network ip interfaceaddAdd a new VMkernel network interface.
network ip interface ipv4 addresslistList the IPv4 addresses assigned to VMkernel network interfaces.
network ip interface ipv4getList the IPv4 addresses assigned to VMkernel network interfaces.
network ip interface ipv4setConfigure IPv4 setting for a given VMkernel network interface.
network ip interface ipv6 addressaddAdd a static IPv6 address to a given VMkernel network interface.
network ip interface ipv6 addresslistThis command will list all of the IPv6 addresses currently assigned to the system
network ip interface ipv6 addressremoveRemove an IPv6 address from a given VMkernel network interface.
network ip interface ipv6getGet IPv6 settings for VMkernel network interfaces. This does not include the IPv6 addresses which can be found in the "address list" command.
network ip interface ipv6setConfigure IPv6 settings for a given VMkernel network interface.
network ip interfacelistThis command will list the VMkernel network interfaces currently known to the system.
network ip interfaceremoveRemove a VMkernel network interface from the ESXi host. A VMKernel network interface can be uniquely specified by --interface-name or --portgroup-name or --dvs-name/--dvport-id. i.e. Providing its name or its connection point are two ways to uniquely specify a VMKernel network interface.
network ip interfacesetThis command sets the enabled status and MTU size of a given IP interface
network ip interface tagaddAdds a tag on a given VMkernel network interface. Supported tags are: Management, VMotion, faultToleranceLogging, vSphereReplication, vSphereReplicationNFC, vSphereProvisioning, VSAN, VSANWitness, vSphereBackupNFC, PrecisionTimeProtocol, NVMeTCP, NVMeRDMA
network ip interface taggetGets the tags set on the given VMkernel network interface.
network ip interface tagremoveRemoves a tag on a given VMkernel network interface.
network ip ipsec saaddAdd a Security Association.
network ip ipsec salistList configured Security Associations
network ip ipsec saremoveOperation to remove Security Association(s)
network ip ipsec spaddAdd a Security Policy.
network ip ipsec splistList configured Security Policys
network ip ipsec spremoveOperation to remove Security Policy
network ip neighborlistList ARP table entries
network ip neighborremoveRemove ARP table entries
network ip netstackaddAdd a new Netstack Instance.
network ip netstackgetGet runtime/configuration settings for a given Netstack Instance.
network ip netstacklistThis command will list the VMkernel Netstack instances currently known to the system.
network ip netstackremoveRemove a new Netstack Instance.
network ip netstacksetConfigure settings for a given Netstack Instance.
network ip route ipv4addAdd IPv4 route to the VMkernel.
network ip route ipv4listList configured IPv4 routes
network ip route ipv4removeRemove IPv4 route
network ip route ipv6addAdd IPv6 route to the VMkernel.
network ip route ipv6listList configured IPv6 routes
network ip route ipv6removeRemove IPv6 route from the VMkernel
network ipsetUpdate global IP settings
network multicast grouplistList all the multicast group members.
network nic attachmentaddAttach one uplink as a branch to a trunk uplink with specified VLAN ID.
network nic attachmentlistShow uplink attachment information.
network nic attachmentremoveDetach a branch uplink from its trunk.
network nic coalescegetGet coalesce parameters
network nic coalesce highgetGet information about the behavior of a NIC when it sends or receives packets at high packet rate.
network nic coalesce highsetSet parameters to control the behavior of a NIC when it sends or receives packets at high packet rate.
network nic coalesce lowgetGet information about the behavior of a NIC when it sends or receives packets at low packet rate.
network nic coalesce lowsetSet parameters to control the behavior of a NIC when it sends or receives packets at low packet rate.
network nic coalescesetSet coalesce parameters on a nic
network nic csogetGet checksum offload settings
network nic csosetSet checksum offload settings on a nic
network nic dcb statusgetGet the DCB information for a NIC.
network nicdownBring down the specified network device.
network nic eepromchangeChange EEPROM on a nic
network nic eepromdumpDump device EEPROM
network nicgetGet the generic configuration of a network device
network nic hwCap activatedlistList activated hardware capabilities of physical NICs.
network nic hwCap supportedlistList supported hardware capabilities of physical NICs.
network niclistThis command will list the Physical NICs currently installed and loaded on the system.
network nic negotiaterestartRestart N-Way negotiation on a nic
network nic pauseParamslistList pause parameters of all NICs
network nic pauseParamssetSet pause parameters for a NIC
network nic queue countgetGet netqueue count on a nic
network nic queue countsetSet number of netqueues on a nic
network nic queue filterclasslistList the netqueue supported filterclass of all physical NICs currently installed and loaded on the system.
network nic queue loadbalancerlistList the load balancer settings of all the installed and loaded physical NICs. (S:supported, U:unsupported, N:not-applicable, A:allowed, D:disallowed).
network nic queue loadbalancer pluginlistDetails of netqueue balancer plugins on all physical NICs currently installed and loaded on the system
network nic queue loadbalancer pluginsetEnable/disable netqueue balancer plugin on a NIC
network nic queue loadbalancersetEnable/disable netqueue load balancer setting on a NIC.
network nic queue loadbalancer statelistNetqueue balancer state of all physical NICs currently installed and loaded on the system
network nic queue loadbalancer statesetEnable/disable netqueue balancer on a NIC
network nic registerdumpDump device registers
network nic ring currentgetGet current RX/TX ring buffer parameters of a NIC
network nic ring currentsetSet current RX/TX ring buffer parameters of a NIC
network nic ring presetgetGet preset maximums for RX/TX ring buffer parameters of a NIC.
network nic selftestrunRun self test
network nicsetSet the general options for the specified ethernet device.
network nic sggetGet scatter-gather settings
network nic sgsetSet scatter-gatter settings on a nic
network nic softwarelistList software simulation settings of physical NICs currently installed and loaded on the system.
network nic softwaresetEnable and disable software simulation settings on a NIC.
network nic statsgetGet NIC statistics for a given interface.
network nic tsogetGet TCP segmentation offload settings
network nic tsosetSet TCP segmentation offload settings on a nic
network nicupBring up the specified network device.
network nic vlan statsgetList VLAN statistics for active VLAN's on the NIC.
network nic vlan statssetEnable/disable VLAN statistics collection on the NIC.
network port filter statsgetFilter statistics for a given port.
network port statsgetPacket statistics for a given port.
network sriovniclistThis command will list the SRIOV Enabled NICs (PFs) currently installed and loaded on the system.
network sriovnic vflistGet the generic configuration of VFs for SRIOV NIC.
network sriovnic vfstatsGet statistics for given VF of a SRIOV NIC.
network vmlistList networking information for the VM's that have active ports.
network vm portlistList of active ports for a given VM.
network vswitch dvs vmware lacp configgetGet LACP configuration on DVS
network vswitch dvs vmware lacp statsgetGet LACP stats on DVS uplinks
network vswitch dvs vmware lacp statusgetGet LACP status on DVS
network vswitch dvs vmware lacp timeoutsetSet long/short timeout for vmnics in one LACP LAG
network vswitch dvs vmwarelistList the VMware vSphere Distributed Switch currently configured on the ESXi host.
network vswitch standardaddAdd a new virtual switch to the ESXi networking system.
network vswitch standardlistList the virtual switches current on the ESXi host.
network vswitch standard policy failovergetGet the failover policy settings governing the given virtual switch
network vswitch standard policy failoversetConfigure the Failover policy for a virtual switch.
network vswitch standard policy securitygetGet the Security Policy governing the given virtual switch.
network vswitch standard policy securitysetSet the security policy for a given virtual switch
network vswitch standard policy shapinggetGet the shaping policy settings for the given virtual switch
network vswitch standard policy shapingsetSet the shaping policy settings for the given virtual switch
network vswitch standard portgroupaddAllows the addition of a standard port group to a virtual switch.
network vswitch standard portgrouplistList all of the port groups currently on the system.
network vswitch standard portgroup policy failovergetGet the network failover policy settings governing the given port group
network vswitch standard portgroup policy failoversetConfigure the Failover policy for a port group. These setting may potentially override virtual switch settings.
network vswitch standard portgroup policy securitygetGet the Security Policy governing the given port group.
network vswitch standard portgroup policy securitysetSet the security policy for a given port group
network vswitch standard portgroup policy shapinggetGet the network shaping policy settings governing the given port group
network vswitch standard portgroup policy shapingsetSet the shaping policy settings for the given port group
network vswitch standard portgroupremoveRemove a port group from the given virtual switch
network vswitch standard portgroupsetSet the vlan id for the given port group
network vswitch standardremoveRemove a virtual switch from the ESXi networking system.
network vswitch standardsetThis command sets the MTU size and CDP status of a given virtual switch.
network vswitch standard uplinkaddAdd an uplink to the given virtual switch. Note if this virtual switch has a NIC teaming policy assigned to it then the policy must also be modified to enable use of this uplink on this virtual switch
network vswitch standard uplinkremoveRemove an uplink from the given virtual switch. Note if this virtual switch has a NIC teaming policy assigned to it then the policy must also be modified to disable use of this uplink on this virtual switch
nvme adapterlistList all NVMe adapters.
nvme controlleridentifyGet NVMe Identify Controller data.
nvme controllerlistList NVMe controllers.
nvme device configlistList the configurable parameters for this plugin1
nvme device configsetSet the plugin's parameter1
nvme device controllerlistList all controllers on the device if namespace is not specified, otherwise list all controllers the namespace attached
nvme device feature aecgetGet NVMe device feature async event configuration information
nvme device feature aecsetSet NVMe device feature async event configuration information
nvme device feature apstgetGet NVMe device feature autonomous power state transition information
nvme device feature argetGet NVMe device feature arbitration information
nvme device feature arsetSet NVMe device feature arbitration information
nvme device featurecapGet NVMe device feature supported capabilities information
nvme device feature ergetGet NVMe device feature error recovery information
nvme device feature ersetSet NVMe device feature error recovery information
nvme device featuregetGet NVMe device feature
nvme device feature higetGet NVMe device feature host identifier information
nvme device feature hmbgetGet NVMe device feature host memory buffer information
nvme device feature icgetGet NVMe device feature interrupt coalescing information
nvme device feature icsetSet NVMe device feature interrupt coalescing information
nvme device feature ivcgetGet NVMe device feature interrupt vector configuration information
nvme device feature ivcsetSet NVMe device feature interrupt vector configuration information
nvme device feature katgetGet NVMe device feature keep alive timer information
nvme device feature katsetSet NVMe device feature keep alive timer information
nvme device feature lbagetGet NVMe device feature LBA range type information
nvme device feature nqgetGet NVMe device feature number of queue information
nvme device feature pmgetGet NVMe device feature power management information
nvme device feature pmsetSet NVMe device feature power management information
nvme device featuresetSet NVMe device feature
nvme device feature spmgetGet NVMe device feature software progress marker information
nvme device feature spmsetSet software progress marker feature information, will clear Pre-boot Software Load Count (PBSLC) to 0
nvme device feature ttgetGet NVMe device feature temperature threshold information
nvme device feature ttsetSet NVMe device feature temperature threshold information
nvme device feature vwcgetGet NVMe device feature volatile write cache information
nvme device feature vwcsetSet NVMe device feature volatile write cache information
nvme device feature wagetGet NVMe device feature write atomicity information
nvme device feature wasetSet NVMe device feature write atomicity information
nvme device firmwareactivateCommit downloaded firmware image to a specific slot
nvme device firmwaredownloadDownload firmware image to the device
nvme devicegetGet NVMe device information
nvme devicelistList NVMe devices registered to VMware NVMe driver
nvme device log errorgetGet NVMe device error log information
nvme device log fwslotgetGet NVMe device firmware slot log information
nvme device loggetGet NVMe log page1
nvme device log persistenteventgetGet NVMe persistent event log1
nvme device log smartgetGet NVMe device SMART log information
nvme device log telemetry controllergetGet NVMe telemetry controller-initiated data1
nvme device log telemetry hostgetGet NVMe telemetry host-initiated data1
nvme device namespaceattachAttach namespace on NVMe device
nvme device namespacecreateCreate namespace on NVMe device
nvme device namespacedeleteDelete namespace on NVMe device
nvme device namespacedetachDetach namespace on NVMe device
nvme device namespaceformatChange namespace format
nvme device namespacegetGet nvme namespace information
nvme device namespacelistList namespace on NVMe device
nvme device registergetDump NVMe device registers
nvme device timeoutgetGet timeout value of IO timeout checker
nvme device timeoutsetSet timeout value for IO timeout checker
nvme driver loglevelsetSet NVMe driver log level and debug level
nvme fabricsconnectConnect to an NVMe controller on a specified target through an adapter.
nvme fabrics connectiondeleteDelete persistent NVMe over Fabrics connection entries. Reboot required for settings to take effect.
nvme fabrics connectionlistList all persistent NVMe over Fabrics connection entries.
nvme fabricsdisableDisable NVMe over Fabrics for a transport protocol.
nvme fabricsdisconnectDisconnect specified NVMe controller(s) on the specified NVMe adapter.
nvme fabricsdiscoverDiscover NVMe controllers on the specified target port through the specified NVMe adapter and list all of them.
nvme fabricsenableEnable NVMe over Fabrics for a transport protocol.
nvme infogetGet NVMe host information.
nvme infosetSet NVMe host information.
nvme namespaceidentifyGet NVMe Identify Namespace data.
nvme namespacelistList all NVMe namespaces.
rdma devicelistList the logical RDMA devices currently registered on the system.
rdma device protocollistList the enabled RDMA protocols.
rdma device statsgetGet statistics for a given RDMA device.
rdma device vmkniclistList the vmknics associated with RDMA devices.
rdma iseraddAdd an iSER device to enable iser module driver.
rdma iserdeleteDelete an iser logical device.
rdma iser paramssetChange iSER kernel driver settings. (This operation is deprecated.)
sched reliablememgetCheck if the system is currently aware of reliable memory.
sched swap systemgetGet current state of the options of the system-wide shared swap space.
sched swap systemsetChange the configuration of system-wide shared swap space.
software acceptancegetGets the host acceptance level. This controls what VIBs will be allowed on a host.
software acceptancesetSets the host acceptance level. This controls what VIBs will be allowed on a host.
software addongetDisplay the installed Addon on the host and the managed DPU(s).
softwareapplyApplies a complete image with a software spec that specifies base image, addon and components to install on the host.
software baseimagegetDisplay the installed baseimage on the host.
software componentapplyInstalls Component packages from a depot. Components may be installed, upgraded. WARNING: If your installation requires a reboot, you need to disable HA first.
software componentgetDisplays detailed information about one or more installed Components on host and managed DPU(s).
software componentlistLists the installed Component packages on the host and the managed DPU(s).
software componentremoveRemoves components from the host. WARNING: If your installation requires a reboot, you need to disable HA first.
software component signatureverifyVerifies the signatures of installed Components on the host and the managed DPU(s) and displays the name, version, vendor, acceptance level and the result of signature verification for each of them.
software component viblistList VIBs in an installed Component on the host and the managed DPU(s).
software profilegetDisplay the installed image profile on host and managed DPU(s).
software profileinstallInstalls or applies an image profile from a depot to this host. This command completely replaces the installed image with the image defined by the new image profile, and may result in the loss of installed VIBs. The common vibs between host and image profile will be skipped. To preserve installed VIBs, use profile update instead. WARNING: If your installation requires a reboot, you need to disable HA first.
software profileupdateUpdates the host with VIBs from an image profile in a depot. Installed VIBs may be upgraded (or downgraded if --allow-downgrades is specified), but they will not be removed. Any VIBs in the image profile which are not related to any installed VIBs will be added to the host. WARNING: If your installation requires a reboot, you need to disable HA first.
software profilevalidateValidates the current image profile on the host and managed DPU(s) against an image profile in a depot.
software sources addongetDisplay details about Addons in the depots.
software sources addonlistList all Addons in the depots.
software sources baseimagegetDisplay details about a Base Image from the depot.
software sources baseimagelistList all the Base Images in a depot.
software sources componentgetDisplays detailed information about one or more Components in the depot
software sources componentlistList all the Components from depots.
software sources component viblistList VIB packages in the specified Component in a depot.
software sources profilegetDisplay details about an image profile from the depot.
software sources profilelistList all the image profiles in a depot.
software sources vibgetDisplays detailed information about one or more VIB packages in the depot
software sources viblistList all the VIBs from depots.
software vibgetDisplays detailed information about one or more installed VIBs on the host and the managed DPU(s).
software vibinstallInstalls VIB packages from a URL or depot. VIBs may be installed, upgraded, or downgraded. WARNING: If your installation requires a reboot, you need to disable HA first.
software viblistLists the installed VIB packages on the host and the managed DPU(s).
software vibremoveRemoves VIB packages from the host. WARNING: If your installation requires a reboot, you need to disable HA first.
software vib signatureverifyVerifies the signatures of installed VIB packages on the host and the managed DPU(s) and displays the name, version, vendor, acceptance level and the result of signature verification for each of them
software vibupdateUpdate installed VIBs to newer VIB packages. No new VIBs will be installed, only updates. WARNING: If your installation requires a reboot, you need to disable HA first.
storage core adapter capabilitieslistList the capabilities of the SCSI HBAs in the system.
storage core adapter devicelistList the devices associated with HBAs.
storage core adapterlistList all the SCSI Host Bus Adapters on the system.
storage core adapterrescanRescan 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 statsgetList the SCSI stats for the SCSI Host Bus Adapters in the system.
storage core claimingautoclaimControl 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 claimingreclaim 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 claimingunclaim1) 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 claimruleaddAdd a claimrule to the set of claimrules on the system.
storage core claimruleconvertConvert 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 claimrulelistList all the claimrules on the system.
storage core claimruleloadLoad path claiming rules from config file into the VMkernel.
storage core claimrulemoveMove a claimrule from one rule id to another
storage core claimruleremoveDelete a claimrule to the set of claimrules on the system.
storage core claimrulerunExecute path claiming rules.
storage core device capacitylistList capacity information for the known storage devices.
storage core device detachedlistLists all devices that were detached manually by changing their state on the system.
storage core device detachedremoveProvide control to allow a user to remove Detached devices from the persistent detached device list.
storage core device inquirycachelistList inquiry cache information for the known storage devices.
storage core device inquirycachesetManipulate inquiry cache settings of storage devices.
storage core device latencythresholdlistList latency sensitive threshold for the known storage devices.
storage core device latencythresholdsetSet 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 devicelistList the devices currently registered with the PSA.
storage core device partitionlistFor a given device list all of the partitions
storage core device partitionshowguidFor a given device list the GUID for GPT partitions
storage core device physicalgetGet information about a physical storage device.
storage core devicepurgeRemoves storage devices which have not been seen in some time interval.
storage core device raidlistList the physical devices that compose a given logical device.
storage core devicesetModify the state of a storage device.
storage core devicesetconfigSet device configuration
storage core device smart daemonstartEnable smartd.
storage core device smart daemon statusgetGet status of smartd.
storage core device smart daemonstopDisable smartd.
storage core device smartgetList Smart device parameters.
storage core device smart statusgetGet status of SMART stats on a device.
storage core device smart statussetEnable or disable SMART stats gathering on a device.
storage core device statsgetList the SCSI stats for SCSI Devices in the system.
storage core device uidmaplistGet a mapping between a device's primary UID and the alternative UIDs for that device on the system.
storage core device vaai atslistList the ATS VAAI attributes (as per SCSI standard) for the devices.
storage core device vaai clonelistList the Clone VAAI attributes (as per SCSI standard) for the devices.
storage core device vaai deletelistList the Delete VAAI attributes (as per SCSI standard) for the devices.
storage core device vaai statusgetList VAAI properties for devices currently registered with the PSA.
storage core device vaai statussetEnable/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 zerolistList the Zero VAAI attributes (as per SCSI standard) for the devices.
storage core device worldlistGet a list of the worlds that are currently using devices on the ESX host.
storage core nvme devicelistList the NVMe devices currently registered with the PSA.1
storage core nvme pathlistList all the NVMe paths on the system.1
storage core pathlistList all the storage paths on the system.
storage core pathsetProvide 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 statsgetList the SCSI stats for the SCSI Paths in the system.
storage core pluginlistList loaded PSA plugins on the system.
storage core plugin registrationaddRegister a plugin module with PSA.
storage core plugin registrationlistList modules currently registered with PSA.
storage core plugin registrationremoveUnRegister a plugin module with PSA.
storage core scsi devicelistList the SCSI devices currently registered with the PSA.1
storage core scsi pathlistList all the SCSI paths on the system.1
storage filesystemautomountRequest mounting of known datastores not explicitly unmounted.
storage filesystemlistList the volumes available to the host. This includes VMFS, NAS, VFAT and UFS partitions.
storage filesystemmountConnect to and mount an unmounted volume on the ESX host.
storage filesystemrescanScan storage devices for new mountable filesystems.
storage filesystemunmountDisconnect 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 hpp devicelistList the devices currently controlled by the VMware High Performance Plugin.
storage hpp devicesetConfigure settings for an HPP device.
storage hpp device usermarkedssdlistList the devices that were marked/unmarked as SSD by user.
storage hpp pathlistList the paths currently claimed by the VMware High Performance Plugin
storage iofilterenableEnable an iofilter.
storage iofilterlistList the iofilters installed on this host.
storage nfsaddAdd a new NAS volume to the ESX Host and mount it with the given volume name.
storage nfslistList the NAS volumes currently known to the ESX host.
storage nfs paramgetGet the volume parameters of the NAS volumes.
storage nfs paramsetSet the volume parameters of the NAS volumes.
storage nfsremoveRemove an existing NAS volume from the ESX host.
storage nfs41addAdd a new NFS v4.1 volume to the ESX Host and mount it with the given volume name.
storage nfs41listList the NFS v4.1 volumes currently known to the ESX host.
storage nfs41 paramgetGet the volume parameters of the NFS v4.1 volumes.
storage nfs41 paramsetSet the volume parameters of the NFS v4.1 volumes.
storage nfs41removeRemove an existing NFS v4.1 volume from the ESX host.
storage nmp devicelistList the devices currently controlled by the VMware NMP Multipath Plugin and show the SATP and PSP information associated with that device.
storage nmp devicesetAllow setting of the Path Selection Policy (PSP) for the given device to one of the loaded policies on the system.
storage nmp pathlistList the paths currently claimed by the VMware NMP Multipath Plugin and show the SATP and PSP information associated with that path.
storage nmp psp fixed deviceconfiggetAllow retrieving of Fixed Path Selection Policy settings for a given device.
storage nmp psp fixed deviceconfigsetAllow setting of the perferred path on a given device controlled by the Fixed Path Selection Policy.
storage nmp psp generic deviceconfiggetAllow retrieving of per device PSP configuration parameters.
storage nmp psp generic deviceconfigsetAllow 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 pathconfiggetAllow retrieving of per path PSP configuration parameters.
storage nmp psp generic pathconfigsetAllow 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 psplistList the Path Selection Plugins (PSP) that are currently loaded into the NMP system and display information about those PSPs
storage nmp psp roundrobin deviceconfiggetAllow retrieving of Round Robin Path Selection Policy settings for a given device.
storage nmp psp roundrobin deviceconfigsetAllow setting of the Round Robin path options on a given device controlled by the Round Robin Selection Policy.
storage nmp satp generic deviceconfiggetAllow retrieving of per device SATP configuration parameters.
storage nmp satp generic deviceconfigsetAllow 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 pathconfiggetAllow retrieving of per path SATP configuration parameters.
storage nmp satp generic pathconfigsetAllow 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 satplistList the Storage Array Type Plugins (SATP) that are currently loaded into the NMP system and display information about those SATPs
storage nmp satp ruleaddAdd a rule to the list of claim rules for the given SATP.
storage nmp satp rulelistList the claiming rules for Storage Array Type Plugins (SATP)
storage nmp satp ruleremoveDelete a rule from the list of claim rules for the given SATP.
storage nmp satpsetSet the default Path Selection Policy for a given Storage Array Type Plugin (SATP).
storage osdatacreateCreate an OSData partition on a disk.1
storage san fc eventsclearClear events for a given FC adapter on the system.
storage san fc eventsgetGet Events for FC Devices
storage san fclistList attributes of all FC adapters on the system.
storage san fcresetPerform LIP (Loop Initiation Primitive) Reset to a given FC adapter on the system.
storage san fc statsgetGet statistics for a given FC adapter, or all FC adapters on the system.
storage san fcoelistList attributes of all FCoE adapters on the system.
storage san fcoeresetPerform LIP (Loop Initiation Primitive) Reset to a given FCoE adapter on the system.
storage san fcoe statsgetGet statistics for a given FCoE adapter, or all FCoE adapters on the system.
storage san iscsilistList attributes of all Software iSCSI adapters on the system.
storage san iscsi statsgetGet statistics for Software iSCSI adapter.
storage san saslistList all SAS IO Device Management devices.
storage san sasresetPerform SAS Reset
storage san sas statsgetList Stats for given device, or all devices.
storage vflash devicelistList vflash SSD devices.
storage vflash modulegetGet vflash module info.
storage vflash modulelistList vflash modules.
storage vflash module statsgetGet vflash module statistics
storage vmfs extentlistList the VMFS extents available on the host.
storage vmfs hostlistList hosts accessing a particular VMFS Volume.
storage vmfs lockmodelistList the on-disk critical section locking mode for VMFS volumes available on this host.
storage vmfs lockmodesetUpdate the on-disk critical section locking mode for a particular VMFS Volume.
storage vmfs pbcachegetGet VMFS Pointer Block cache statistics.
storage vmfs pbcacheresetReset the VMFS Pointer Block cache statistics.
storage vmfs reclaim configgetGet space reclamation configuration parameters
storage vmfs reclaim configsetSet space reclamation configuration parameters
storage vmfs snapshot extentlistList extents of unresolved snapshots/replicas of VMFS volume.
storage vmfs snapshotlistList unresolved snapshots/replicas of VMFS volume.
storage vmfs snapshotmountMount a snapshot/replica of a VMFS volume.
storage vmfs snapshotresignatureResignature a snapshot/replica of a VMFS volume.
storage vmfsunmapReclaim the space by unmapping free blocks from VMFS Volume
storage vmfsupgradeUpgrade a VMFS3 volume to VMFS5.
storage vvol daemonunbindallUnbind all Virtual Volumes from all VASA Providers known to this host.
storage vvol protocolendpointlistList the VVol Protocol EndPoints currently known to this host.
storage vvol statsaddAdd entity for stats tracking1
storage vvol statsdisableDisable stats for complete namespace1
storage vvol statsenableEnable stats for complete namespace1
storage vvol statsgetGet stats for given stats namespace1
storage vvol statslistList all supported stats1
storage vvol statsremoveRemove tracked entity1
storage vvol statsresetReset stats for given namespace1
storage vvol storagecontainer abandonedvvolscanScans the specified storage container for abandoned VVols.
storage vvol storagecontainerlistList VVol storage containers known to this host.
storage vvol vasacontextgetGet the VVol VASA Context (vCenter UUID).
storage vvol vasaproviderlistList the VASA Providers registered on this host.
storage vvol vmstatsgetGet the VVol information and statistics for a specific virtual machine.1
system accountaddCreate a new local user account.
system accountlistList local user accounts.
system accountremoveRemove an existing local user account.
system accountsetModify an existing local user account.
system auditrecordsgetAudit record configuration settings.
system auditrecords localdisableDisable audit record storage.
system auditrecords localenableEnable audit record storage.
system auditrecords localsetSet audit record storage configuration options.
system auditrecords remotedisableDisable transmitting audit records to remote hosts.
system auditrecords remoteenableEnable transmitting audit records to remote hosts.
system boot devicegetGet the systems boot device.
system clockgetDisplay the current system clock parameters.
system clocksetSet system clock parameters.
system coredump fileaddCreate a VMkernel Dump VMFS file for this system.
system coredump filegetGet the dump file path. This command will print the path to the active and/or configured VMFS Dump File.
system coredump filelistList the active and configured VMFS Diagnostic Files.
system coredump fileremoveRemove a VMkernel Dump VMFS file from this system.
system coredump filesetSet the active and configured VMkernel Dump VMFS file for this system.
system coredump networkcheckCheck the status of the configured network dump server
system coredump networkgetGet the currently configured parameters for network coredump, if enabled.
system coredump networksetSet the parameters used for network core dump
system coredump partitiongetGet one of the dump partition configured values. This command will print either the active dump partition or the configured dump partition depending on the flags passed.
system coredump partitionlistList all of the partitions on the system that have a partition type matching the VMware Core partition type. Also indicate which partition, if any, is being used as the system's dump partition and which is configured to be used at next boot.
system coredump partitionsetSet the specific VMkernel dump partition for this system. This will configure the dump partition for the next boot. This command will change the active dump partition to the partition specified.
system health reportgetDisplays one or more health reports1
system health reportlistList all the health reports currently generated.1
system hostnamegetGet the host, domain or fully qualified name of the ESX host.
system hostnamesetThis command allows the user to set the hostname, domain name or fully qualified domain name of the ESX host.
system maintenanceModegetGet the maintenance mode state of the system.
system maintenanceModesetEnable or disable the maintenance mode of the system.
system modulegetShow information for a VMkernel module.
system modulelistList the VMkernel modules that the system knows about.
system moduleloadLoad a VMkernel module with the given name if it is enabled. If the module is disabled then the use of --force is required to load the module.
system module parametersclearClear the load time parameters for a given VMkernel module.
system module parameterscopyCopy the load time parameters from one VMkernel module to another.
system module parameterslistList the parameters, a descriptions of each parameter supported for a given module name and the user defined value for each parameter.
system module parameterssetSet the load time parameters for the given VMkernel module.
system modulesetAllow enabling and disabling of a VMkernel module.
system ntp configgetDisplay Network Time Protocol configuration.
system ntpgetDisplay Network Time Protocol configuration
system ntpsetConfigures the ESX Network Time Protocol agent.
system ntp statsgetReport operational state of Network Time Protocol Daemon1
system ntptestVerify operational status of ESX NTP service.
system permissionlistList permissions defined on the host.
system permissionsetSet permission for a user or group.
system permissionunsetRemove permission for a user or group.
system processlistList the VMkernel UserWorld processes currently on the host.
system process stats loadgetSystem load average over the last 1, 5 and 15 minutes.
system process stats runninggetNumber of currently running processes.
system ptpgetDisplay Precision Time Protocol configuration
system ptpsetConfigures the ESX Precision Time Protocol agent.
system ptp statsgetReport operational state of Precision Time Protocol Daemon
system ptptestVerify operational status of ESX PTP service.
system secpolicy domainlistList the enforcement level for each domain.
system secpolicy domainsetSet the enforcement level for a domain in the system. Any option specified here is not persistent and will not survive a reboot of the system.
system security certificatestoreaddAdd a new CA certificate to the CA certificate store.
system security certificatestorelistList all certificates in the CA certificate store.
system security certificatestoreremoveRemove a certificate from the CA certificate store.
system security fips140 rhttpproxygetGet FIPS140 mode of rhttpproxy.
system security fips140 rhttpproxysetSet FIPS140 mode of rhttpproxy.
system security fips140 sshgetGet FIPS140 mode of ssh.
system security fips140 sshsetSet FIPS140 mode of ssh.
system security keypersistencedisableDisable key persistence daemon.1
system security keypersistenceenableEnable key persistence daemon.1
system settings advancedaddAdd a user defined advanced option to the /UserVars/ advanced option tree.
system settings advancedlistList the advanced options available from the VMkernel.
system settings advancedremoveRemove a user defined advanced option from the /UserVars/ advanced option tree.
system settings advancedsetSet the value of an advanced option.
system settings encryptiongetGet the encryption mode and policy.1
system settings encryption recoverylistList recovery keys.1
system settings encryption recoveryrotateRotate the recover key.1
system settings encryptionsetSet the encryption mode and policy.1
system settings gueststore repositorygetGet GuestStore repository.1
system settings gueststore repositorysetSet or clear GuestStore repository.1
system settings kernellistList VMkernel kernel settings.
system settings kernelsetSet a VMKernel setting.
system settings keyboard layoutgetGet the keyboard layout
system settings keyboard layoutlistList the keyboard layout
system settings keyboard layoutsetSet the keyboard layout
system shutdownpoweroffPower off the system. The host must be in maintenance mode.
system shutdownrebootReboot the system. The host must be in maintenance mode.
system slpgetGet SLP Agent configuration.
system slpsearchPerform SLP search for neighboring services
system slpsetConfigure ESX SLP agent.
system slp statsgetReport operational state of Service Location Protocol Daemon
system snmpgetGet SNMP Agent configuration
system snmphashGenerate localized hash values based on this agents snmp engine id.
system snmpsetThis command allows the user to set up ESX SNMP agent.
system snmptestVerify ESX SNMP notifications can be delivered to target destinations.
system stats installtimegetDisplay the date and time when this system was first installed. Value will not change on subsequent updates.
system stats uptimegetDisplay the number of microseconds the system has been running.
system syslog configgetShow the current global configuration values.
system syslog config logfilteraddAdd a log filter.1
system syslog config logfiltergetShow the current log filter configuration values.1
system syslog config logfilterlistShow the added log filters.1
system syslog config logfilterremoveRemove a log filter.1
system syslog config logfiltersetSet log filtering configuration options.1
system syslog config loggerlistShow the currently configured sub-loggers.
system syslog config loggersetSet configuration options for a specific sub-logger.
system syslog configsetSet syslog daemon configuration options.
system syslogmarkIssue a message to all outputs.
system syslogreloadReload the log daemon to apply any new configuration options.
system timegetDisplay the current system time.
system timesetSet the system clock time. Any missing parameters will default to the current time
system uuidgetGet the system UUID.
system versiongetDisplay the product name, version and build information.
system visorfsgetObtain status information on the memory filesystem as a whole.
system visorfs ramdiskaddAdd a new Visorfs RAM disk to the ESXi Host and mount it.
system visorfs ramdisklistList the RAM disks used by the host.
system visorfs ramdiskremoveRemove a Visorfs RAM disk from the ESXi Host.
system visorfs tardisklistList the tardisks used by the host.
system wbemgetDisplay WBEM Agent configuration.
system wbem providerlistDisplay WBEM provider configuration.
system wbem providersetThis command is used to manage ESX CIMOM providers.
system wbemsetThis command allows the user to set up ESX CIMOM agent.
system welcomemsggetGet the Welcome Message for DCUI.
system welcomemsgsetSet the welcome message string.
vm appinfogetGet the state of appinfo component on the ESXi host.
vm appinfosetModify the appinfo component on the ESXi host.
vm processkillUsed to forcibly kill Virtual Machines that are stuck and not responding to normal stop operations.
vm processlistList the virtual machines on this system. This command currently will only list running VMs on the system.
vsan clustergetGet information about the vSAN cluster that this host is joined to.
vsan clusterjoinJoin the host to a vSAN cluster.
vsan clusterleaveLeave the vSAN cluster the host is currently joined to.
vsan clusterlistGet information about the vSAN clusters that this host is joined to.
vsan clusternewCreate a vSAN cluster with current host joined. A random sub-cluster UUID will be generated.
vsan cluster preferredfaultdomaingetGet the preferred fault domain for a stretched cluster.
vsan cluster preferredfaultdomainlistList the preferred fault domain for all attached stretched clusters.
vsan cluster preferredfaultdomainsetSet the preferred fault domain for a stretched cluster.
vsan clusterrestoreRestore the persisted vSAN cluster configuration.
vsan cluster unicastagentaddAdd a unicast agent to the vSAN cluster configuration.
vsan cluster unicastagentclearRemoves all unicast agents in the vSAN cluster configuration.
vsan cluster unicastagentlistList all unicast agents in the vSAN cluster configuration.
vsan cluster unicastagentremoveRemove a unicast agent from the vSAN cluster configuration.
vsan cmmds timemachinegetGet vSAN CMMDS time machine configuration.
vsan cmmds timemachinesetConfigure vSAN CMMDS time machine.
vsan datastoreaddAdd a new datastore to the vSAN cluster. This operation may be used to add either a new local datastore or a remote datastore. Adding local datastore is only allowed if vSAN is enabled on the host. In general, add should be done at cluster level. Across a vSAN cluster vSAN datastores should be in sync.
vsan datastoreclearRemove all but the default datastore from the vSAN cluster. This operation is only allowed if vSAN is enabled on the host. In general, clear should be done at cluster level. Across a vSAN cluster vSAN datastores should be in sync.
vsan datastorelistList datastores in the vSAN cluster.
vsan datastore namegetGet vSAN datastore name.
vsan datastore namesetConfigure vSAN datastore name. In general, rename should always be done at cluster level. Across a vSAN cluster vSAN datastore name should be in sync.
vsan datastoreremoveRemove a datastore from the vSAN cluster. This operation is only allowed if vSAN is enabled on the host. In general, remove should be done at cluster level. Across a vSAN cluster vSAN datastores should be in sync.
vsan debug advcfglistList all advanced configuration options with non-default values.
vsan debug controllerlistPrint detailed information about all vSAN disk controllers (output may change between releases)
vsan debug disklistPrint detailed information about all vSAN disks in the cluster.
vsan debug diskoverviewPrint overview information about all vSAN disks in the cluster.
vsan debug disk summarygetPrint summary information about all vSAN disks in the cluster.
vsan debug evacuationprecheckExamine what it takes if an entity (disk group or host) is evacuated in various modes (Action). The result is accurate when all hosts in the vSAN cluster are of the same version and have the same disk format.
vsan debug limitgetPrint summary information about vSAN limits (output may change between releases)
vsan debug memorylistPrint both userworld and kernel memory consumptions of vSAN.
vsan debug mobstartStart vSAN Managed Object Browser Service.
vsan debug mobstatusQuery vSAN Managed Object Browser Service is running or not.
vsan debug mobstopStop vSAN Managed Object Browser Service.
vsan debug object health summarygetPrint health summary information about all vSAN objects in the cluster (output may change between releases)
vsan debug objectlistPrint detailed information about vSAN objects in the cluster. This command would only show 100 objects at most by default.
vsan debug objectoverviewPrint overview information about all vSAN objects in the cluster. This command would only show 100 objects at most by default.
vsan debug resynclistPrint detailed information about vSAN resyncing objects (output may change between releases)
vsan debug resync summarygetPrint summary information about vSAN resyncing objects (output may change between releases)
vsan debug vmdklistPrint summary information about VMDKs on local vSAN datastore (output may change between releases)
vsan encryption certgetGet encryption KMS server certificate contents.
vsan encryption cert pathlistList encryption certificate file paths.
vsan encryption hostkeygetGet host key from keycache used for vSAN encryption.
vsan encryption infogetGet vSAN encryption infomation.
vsan encryption kmslistList the KMS configurations used for vSAN encryption.
vsan faultdomaingetGet the fault domain name for this host.
vsan faultdomainresetReset Host fault domain to default value
vsan faultdomainsetSet the fault domain for this host
vsan hardware vcgaddMap unidentified vSAN hardware device with VCG ID.1
vsan hardware vcggetGet the vSAN VCG ID for a vSAN hardware device. Output is VCG ID while "N/A" means device ID is not mapped.1
vsan health clustergetGet a specific health check status and its details
vsan health clusterlistList a cluster wide health check across all types of health checks
vsan iscsi defaultconfiggetGet default values for vSAN iSCSI Target configurations.
vsan iscsi defaultconfigsetSet default values for vSAN iSCSI Target configurations.
vsan iscsi homeobjectcreateCreate vSAN iSCSI target home object. Once created, the home object will be available for all the hosts in vSAN cluster. vSAN iSCSI target home object should be created only once for the vSAN cluster.
vsan iscsi homeobjectdeleteDelete vSAN iSCSI target home object. This operation will destroy all vSAN iSCSI target configuration
vsan iscsi homeobjectgetGet status for the vSAN iSCSI target home object
vsan iscsi homeobjectsetUpdate configuration for the vSAN iSCSI target home object
vsan iscsi initiatorgroupaddAdd a new initiator group. An initiator group is a collection of iSCSI initiator hosts. A LUN can be exposed to multiple initiators via initiator group.
vsan iscsi initiatorgroupgetGet initiator group properties.
vsan iscsi initiatorgroup initiatoraddAdd new initiator iSCSI names to the vSAN iSCSI initiator group.
vsan iscsi initiatorgroup initiatorremoveRemove initiator iSCSI names from the vSAN iSCSI initiator group.
vsan iscsi initiatorgrouplistGet the list of initiator groups.
vsan iscsi initiatorgroupremoveRemove an initiator group. Group should be empty. If you want to remove non-empty group use --force option.
vsan iscsi statusgetGets current status (Enabled or Disabled).
vsan iscsi statussetEnable or disable iSCSI target support, query status
vsan iscsi targetaddAdd a new vSAN iSCSI target.
vsan iscsi targetgetGet configuration for vSAN iSCSI target
vsan iscsi targetlistList vSAN iSCSI targets.
vsan iscsi target lunaddAdd a new vSAN iSCSI LUN to specified target
vsan iscsi target lungetGet configuration for vSAN iSCSI LUN
vsan iscsi target lunlistList vSAN iSCSI LUNs in specified target.
vsan iscsi target lunremoveRemove a vSAN iSCSI LUN from specified target.
vsan iscsi target lunsetUpdate configuration for given vSAN iSCSI target LUN.
vsan iscsi targetremoveRemove a vSAN iSCSI target.
vsan iscsi targetsetUpdate configuration of the given iSCSI target.
vsan maintenancemodecancelCancel an in-progress vSAN maintenance mode operation.The command is not used for exit host maintenance mode. Please run esxcli system maintenanceMode set -e 0 to exit host maintenance mode
vsan networkclearClear the vSAN network configuration.
vsan network ipaddAdd an IP interface to the vSAN network configuration.
vsan network ipremoveRemove an IP interface from the vSAN network configuration.
vsan network ipsetReconfigure an IP interface in the vSAN network configuration.
vsan network ipv4addAdd an IP interface to the vSAN network configuration.
vsan network ipv4removeRemove an IP interface from the vSAN network configuration.
vsan network ipv4setReconfigure an IP interface in the vSAN network configuration.
vsan networklistList the network configuration currently in use by vSAN.
vsan networkremoveRemove an interface from the vSAN network configuration.
vsan networkrestoreRestore the persisted vSAN network configuration.
vsan network securitygetGet vSAN network security configurations for a subcluster.
vsan network securitylistList vSAN network security configurations.
vsan network securitysetConfigure vSAN network security settings for a subcluster.
vsan perf diagnosticgetGets current status about diagnostic mode.
vsan perf diagnosticsetSet vSAN diagnostic mode configuration.
vsan perfgetGets current status (Enabled or Disabled).
vsan perfsetSet vSAN performance service configuration.
vsan policycleardefaultClear default vSAN storage policy values.
vsan policygetdefaultGet default vSAN storage policy values.
vsan policysetdefaultSet default vSAN storage policy values.
vsan resync bandwidthgetGet information about vSAN resync bandwidth in Mbps for the disk group with the heaviest resync workload.
vsan resync throttlegetGet information about vSAN resync throttling
vsan resync throttlesetConfigure vSAN resync throttling
vsan storageaddAdd physical disk for vSAN usage.
vsan storage automodeget Get status of storage auto claim mode.
vsan storage automodesetConfigure storage auto claim mode
vsan storage diskgroupmountMount a vSAN disk or disk group.
vsan storage diskgrouprebuildRebuild vSAN diskgroup.
vsan storage diskgroupunmountUnmount vSAN disk or disk group.
vsan storagelistList vSAN storage configuration.
vsan storageremoveRemove physical disks from vSAN disk groups.
vsan storage tagaddAdd a vSAN storage tag.
vsan storage tagremoveRemove a vSAN storage tag.
vsan storagepooladdAdd physical disk for vSAN usage.1
vsan storagepoollistList vSAN storage pool configuration.1
vsan storagepoolmountMount vSAN disk from storage pool.1
vsan storagepoolrebuildRebuild vSAN storage pool disks.1
vsan storagepoolremoveRemove physical disk from storage pool usage. Exactly one of --disk or --uuid param is required.1
vsan storagepoolunmountUnmount vSAN disk from storage pool.1
vsan tracegetGet the vSAN tracing configuration.
vsan tracesetConfigure vSAN trace. Please note: This command is not thread safe.