嘘~ 正在从服务器偷取页面 . . .

VMware ESXCLI命令总结


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.

ESXCLI Commands

Namespace Description
esxcli device Lists descriptions of device commands.
esxcli esxcli Lists descriptions of esxcli commands.
esxcli fcoe FCOE (Fibre Channel over Ethernet) comands
esxcli graphics Graphics commands
esxcli hardware Hardware namespace. Used primarily for extracting information about the current system setup.
esxcli iscsi iSCSI namespace for monitoring and managing hardware and software iSCSI.
esxcli network Network namespace for managing virtual networking including virtual switches and VMkernel network interfaces.
esxcli nvme Commands for managing NVMe devices.
esxcli rdma Commands for monitoring RDMA devices.
esxcli sched Manage the shared system-wide swap space.
esxcli software Software namespace. Includes commands for managing and installing image profiles and VIBs.
esxcli storage Includes core storage commands and other storage management commands.
esxcli system System monitoring and management command.
esxcli vm Namespace for listing virtual machines and shutting them down forcefully.
esxcli vsan Namespace for vSAN management commands. See the vSphere Storage publication for details.

esxcli device Commands

COMMAND DESCRIPTION OPTIONS HELP
device add Add a device to enable a software device driver. --device-identifier or -d
Device identifier from the device specification for the software device driver. Valid input is in reverse domain name format (e.g. com.company.device). (required)
--instance-address or -i
Unique number to address this instance of the device, if multiple instances of the same device identifier are added. Valid values are integer in the range 0-31. Default is 0.
--help
Show the help message.
device alias get Display hardware location info for a device alias. --alias or -n
Alias to lookup (required)
--help
Show the help message.
device alias list List device aliases. --help
Show the help message.
device driver list Show driver status for specific devices. --devices or -d
List of device aliases to look up.
--help
Show the help message.
device software add Add a device to enable a software device driver. --device-identifier or -d
Device identifier from the device specification for the software device driver. Valid input is in reverse domain name format (e.g. com.company.device…). (required)
--instance-address or -i
Unique number to address this instance of the device, if multiple instances of the same device identifier are added. Valid values are integer in the range 0-31. Default is 0.
--help
Show the help message.
device software list List software devices. --help
Show the help message.
device software remove Remove a software device. --device-identifier or -d
Device identifier from the device specification for the software device driver. Valid input is in reverse domain name format (e.g. com.company.device…). (required)
--instance-address or -i
Unique number to address this instance of the device.
--help
Show the help message.

esxcli esxcli Commands

COMMAND DESCRIPTION OPTIONS HELP
esxcli command list List all of the esxcli commands. --command-filter or -c
Show only commands containing the specified string in their name.
--description-filter or -d
Show only commands containing the specified string in their description.
--namespace-filter or -n
Show only commands containing the specified string in their namespace path.
--help
Show the help message.

esxcli fcoe Commands

COMMAND DESCRIPTION OPTIONS HELP
fcoe adapter list List FCOE-capable CNA devices. --help
Show the help message.
fcoe adapter remove Initiate FCOE adapter removal. --adapter-name or -a
The FCOE adapter name (vmhbaX) (required)
--help
Show the help message.
fcoe nic disable Disable rediscovery of FCOE storage on behalf of an FCOE-capable CNA upon next boot. --nic-name or -n
The CNA adapter name (vmnicX) (required)
--help
Show the help message.
fcoe nic discover Initiate FCOE adapter discovery on behalf of an FCOE-capable CNA. --nic-name or -n
The CNA adapter name (vmnicX) (required)
--help
Show the help message.
fcoe nic enable Enable an FCOE-capable NIC if it is disabled. --nic-name or -n
The CNA adapter name (vmnicX) (required)
--help
Show the help message.
fcoe nic list List FCOE-capable CNA devices. --help
Show the help message.
fcoe nic remove Initiate FCOE device destroy on behalf of an FCOE-capable PNIC. --nic-name or -n
The CNA adapter name (vmnicX) (required)
--help
Show the help message.
fcoe nic set Set options on FCOE-capable CNA. --enable-vn2vn or -V
Enable or Disable VN2VN mode on the nic (Reboot Required)
--nic-name or -n
The CNA adapter name (vmnicX) (required)
--priority or -p
Priority class (0 - 7) to use for FCOE traffic
--vlan-id or -v
The VLAN id for this nic, range ‘0 - 4095’(Reboot Required)
--help
Show the help message.

esxcli graphics Commands

COMMAND DESCRIPTION OPTIONS HELP
graphics device list List all of the graphics devices on this host. --help
Show the help message.
graphics device stats list List graphics device statistics. --help
Show the help message.
graphics host get Get host graphics properties. --help
Show the help message.
graphics host refresh Refresh host graphics properties. --help
Show the help message.
graphics host set Set host graphics properties. --default-type
Host default graphics type.
--shared-passthru-assignment-policy
Shared passthru assignment policy.
--help
Show the help message.
graphics vm list List active VMs associated with graphics devices. --help
Show the help message.

esxcli hardware Commands

COMMAND DESCRIPTION OPTIONS HELP
hardware bootdevice list List the boot device order, if available, for this host. --help
Show the help message.
hardware clock get Disply the current hardware clock time. --help
Show the help message.
hardware clock set Set the hardware clock time. Any missing parameters will default to the current time. --day or -d
Day
--hour or -H
Hour
--min or -m
Minute
--month or -M
Month
--sec or -s
Second
--year or -y
Year
--help
Show the help message.
hardware cpu list List all of the CPUs on this host. --help
Show the help message.
hardware cpu cpuid get Get subset of CPUID fields for a CPU (deprecated, use: esxcli hardware cpu cpuid raw list). --cpu or -c
The ID of the CPU to query for CPUID data. (required)
--help
Show the help message.
hardware cpu cpuid raw list Get all CPUID fields for a CPU. --cpu or -c
The ID of the CPU to query for all CPUID data. (required)
--help
Show the help message.
hardware cpu global get Get properties that are global to all CPUs. --help
Show the help message.
hardware cpu global set Set properties that are global to all CPUs. --hyperthreading or -t
Enable or disable hyperthreading (required)
--help
Show the help message.
hardware ipmi bmc get Get IPMI Baseboard Management Controller (BMC) properties. --help
Show the help message.
hardware ipmi bmc set Set IPMI Baseboard Management Controller (BMC) properties. Changes take effect immediately. --os-hostname or -H
OS hostname that BMC will report.
--os-name or -n
OS name that BMC will report.
--os-version or -v
OS system version that BMC will report.
--help
Show the help message.
hardware ipmi fru get Get IPMI Field Replaceable Unit (FRU) device details. --ignore-missing or -i
Do not fail command if ipmi device is not present
--include-all-sensors or -a
Include all SDR entries including those for entities that do not exist, or have no health state.
--include-pretty-raw or -p
Include a hex dump where each byte is separated by a space and its value is presented with two hexidecimal characters using a leading zero if needed
--include-raw or -r
Include a hex dump where the value of each byte is presented as hexidecimal characters joined without spaces
--node or -n
Specify which IPMI device (0..3) to query, defaults to ‘all’ for all ipmi nodes
--help
Show the help message.
hardware ipmi fru list List IPMI Field Replaceable Unit (FRU) inventory. --ignore-missing or -i
Do not fail command if ipmi device is not present
--include-all-sensors or -a
Include all SDR entries including those for entities that do not exist, or have no health state.
--include-pretty-raw or -p
Include a hex dump where each byte is separated by a space and its value is presented with two hexidecimal characters using a leading zero if needed
--include-raw or -r
Include a hex dump where the value of each byte is presented as hexidecimal characters joined without spaces
--node or -n
Specify which IPMI device (0..3) to query, defaults to ‘all’ for all ipmi nodes
--help
Show the help message.
hardware ipmi sdr get Get IPMI Sensor Data Repository (SDR) properties. --ignore-missing or -i
Do not fail command if ipmi device is not present
--include-all-sensors or -a
Include all SDR entries including those for entities that do not exist, or have no health state.
--include-pretty-raw or -p
Include a hex dump where each byte is separated by a space and its value is presented with two hexidecimal characters using a leading zero if needed
--include-raw or -r
Include a hex dump where the value of each byte is presented as hexidecimal characters joined without spaces
--node or -n
Specify which IPMI device (0..3) to query, defaults to ‘all’ for all ipmi nodes
--help
Show the help message.
hardware ipmi sdr list List IPMI Sensor Data Repository. --formatter or -f
Override the formatter to use for a given command. Available formatter: simple ,table.
--ignore-missing or -i
Do not fail command if ipmi device is not present
--include-all-sensors or -a
Include all SDR entries including those for entities that do not exist, or have no health state.
--include-pretty-raw or -p
Include a hex dump where each byte is separated by a space and its value is presented with two hexidecimal characters using a leading zero if needed
--include-raw or -r
Include a hex dump where the value of each byte is presented as hexidecimal characters joined without spaces
--node or -n
Specify which IPMI device (0..3) to query, defaults to ‘all’ for all ipmi nodes
--help
Show the help message.
hardware ipmi sel clear Clear IPMI System Event Log. --ignore-missing or -i
Do not fail command if ipmi device is not present
--include-all-sensors or -a
Include all SDR entries including those for entities that do not exist, or have no health state.
--include-pretty-raw or -p
Include a hex dump where each byte is separated by a space and its value is presented with two hexidecimal characters using a leading zero if needed
--include-raw or -r
Include a hex dump where the value of each byte is presented as hexidecimal characters joined without spaces
--node or -n
Specify which IPMI device (0..3) to query, defaults to ‘all’ for all ipmi nodes
--help
Show the help message.
hardware ipmi sel get Get IPMI System Event Log (SEL) properties. --ignore-missing or -i
Do not fail command if ipmi device is not present
--include-all-sensors or -a
Include all SDR entries including those for entities that do not exist, or have no health state.
--include-pretty-raw or -p
Include a hex dump where each byte is separated by a space and its value is presented with two hexidecimal characters using a leading zero if needed
--include-raw or -r
Include a hex dump where the value of each byte is presented as hexidecimal characters joined without spaces
--node or -n
Specify which IPMI device (0..3) to query, defaults to ‘all’ for all ipmi nodes
--help
Show the help message.
hardware ipmi sel list List IPMI System Event Log. --ignore-missing or -i
Do not fail command if ipmi device is not present
--include-all-sensors or -a
Include all SDR entries including those for entities that do not exist, or have no health state.
--include-pretty-raw or -p
Include a hex dump where each byte is separated by a space and its value is presented with two hexidecimal characters using a leading zero if needed
--include-raw or -r
Include a hex dump where the value of each byte is presented as hexidecimal characters joined without spaces
--node or -n
Specify which IPMI device (0..3) to query, defaults to ‘all’ for all ipmi nodes
--help
Show the help message.
hardware memory get Get information about memory. --help
Show the help message.
hardware pci list List all of the PCI devices on this host. --class or -c
Filter the PCI devices based on their hexadecimal Class ID
--mask or -m
Mask the filter provided by the class flag
--help
Show the help message.
hardware pci pcipassthru list Display PCI device passthru configuration. --help
Show the help message.
hardware pci pcipassthru set Configure PCI device for passthrough. --apply-now or -a
If this flag is present, the change takes effect immediately; otherwise the change takes effect after a host reboot. This flag causes the device to be unbound from its native driver andbound to the VMkernel’s PCI passthrough driver(or vice-versa depending on the setting of the –enable parameter).
--device-id or -d
The bus ID of the PCI device (e.g., 0000:0a:00.1). (required)
--enable or -e
Enable or disable passthrough of the device. (required)
--help
Show the help message.
hardware platform get Get information about the platform --help
Show the help message.
hardware power policy get Display the current power policy. --help
Show the help message.
hardware power policy set Set the power policy. --id or -i
Power policy numeric id
--name or -n
Power policy name
--short-name or -s
Power policy short name
--help
Show the help message.
hardware power policy choices list List the power policies. --help
Show the help message.
hardware smartcard certificate list Certificates from inserted smart cards. --slot or -s
List certificates from only the token in the given slot.
--help
Show the help message.
hardware smartcard info get Information about the smart card subsystem. --help
Show the help message.
hardware smartcard slot list Information about connected smart card readers. --help
Show the help message.
hardware smartcard token list Information about inserted smart cards. --slot or -s
List tokens only for the given slot.
--help
Show the help message.
hardware tpm tag clear Clear the TPM’s tag (at index 0x40000010). --help
Show the help message.
hardware tpm tag get Get the TPM’s tag (from index 0x40000010). --help
Show the help message.
hardware tpm tag set Set the TPM’s tag (at index 0x40000010). --data or -d
The tag data to store in the TPM in hexadecimal byte encoding. Format: a string matching the regular expression [0-9a-f]{1,40}. (required)
--help
Show the help message.
hardware trustedboot get Information about the status of trusted boot. (TPM, DRTM status) --help
Show the help message.
hardware usb passthrough device disable Disable usb passthrough --device or -d
The device you wish to disable passthrough for. Please enter the Bus#,Dev#,vendorId and productId of the device in the format Bus#:Dev#:vendorId:productId using hexadecimal values(as shown by the list command) (required)
--help
Show the help message.
hardware usb passthrough device enable Enable usb passthrough --device or -d
The device you wish to enable passthrough for. Please note that this command only makes the device eligible for passthrough. The device can be connected to the VM only if usbarbitrator is running. See /etc/init.d/usbarbitrator status to check the status of the usbarbitrator. Please enter the information of the device in the format Bus#:Dev#:vendorId:productId using hexadecimal values(as shown by the list command) (required)
--help
Show the help message.
hardware usb passthrough device list List usb devices and their passthrough status --help
Show the help message.

esxcli iscsi Commands

COMMAND DESCRIPTION OPTIONS HELP
iscsi adapter get List the iSCSI information for the iSCSI Host Bus Adapter. --adapter or -A
The iSCSI adapter name. (required)
--help
Show the help message.
iscsi adapter list List all the iSCSI Host Bus Adapters on the system. --adapter or -A
The iSCSI adapter name.
--help
Show the help message.
iscsi adapter set Set the iSCSI name and alias for the iSCSI Host Bus Adapter. --adapter or -A
The iSCSI adapter name. (required)
--alias or -a
The iSCSI initiator alias.
--name or -n
The iSCSI initiator name.
--skip-if-session-active or -s
Do not change initiator name if a session is active on the adapter.
--help
Show the help message.
iscsi adapter auth chap get Get the iSCSI CHAP authentication for the iSCSI Host Bus Adapter. --adapter or -A
The iSCSI adapter name. (required)
--direction or -d
The iSCSI CHAP authentication direction. Options are: [uni, mutual]
--help
Show the help message.
iscsi adapter auth chap set Set the iSCSI CHAP authentication for the iSCSI Host Bus Adapter. --adapter or -A
The iSCSI adapter name. (required)
--authname or -N
The iSCSI CHAP authentication name
--default or -D
Resetting iSCSI CHAP authenthication setting to default.
--direction or -d
The iSCSI CHAP authentication direction. Options are: [uni, mutual]
--level or -l
The iSCSI CHAP authentication level. Options are: [prohibited, discouraged, preferred, required]
--secret or -S
The iSCSI CHAP authentication secret. The recommended length is at least 12 bytes. (secret)
--help
Show the help message.
iscsi adapter capabilities get List the iSCSI details for the iSCSI Host Bus Adapter. --adapter or -A
The iSCSI adapter name. (required)
--help
Show the help message.
iscsi adapter discovery rediscover Do the iSCSI Discovery for the iSCSI Host Bus Adapter. --adapter or -A
The iSCSI adapter name. (required)
--help
Show the help message.
iscsi adapter discovery sendtarget add Add a sendtarget address --adapter or -A
The iSCSI adapter name. (required)
--address or -a
The iSCSI sendtarget address: ip/dns[:port]. IPv6 address can be specified as [XX:XX:XX:XX::XX]:port or XX:XX:XX:XX::XX (required)
--help
Show the help message.
iscsi adapter discovery sendtarget list List sendtarget addresses --adapter or -A
The iSCSI adapter name.
--help
Show the help message.
iscsi adapter discovery sendtarget remove Remove a sendtarget address --adapter or -A
The iSCSI adapter name. (required)
--address or -a
The iSCSI sendtarget address: ip/dns[:port]. IPv6 address can be specified as [XX:XX:XX:XX::XX]:port or XX:XX:XX:XX::XX (required)
--help
Show the help message.
iscsi adapter discovery sendtarget auth chap get Get iSCSI CHAP authentication on a sendtarget address --adapter or -A
The iSCSI adapter name. (required)
--address or -a
The iSCSI sendtarget address: ip/dns[:port] (required)
--direction or -d
The iSCSI authentication direction. Options are: [uni, mutual]
--help
Show the help message.
iscsi adapter discovery sendtarget auth chap set Set iSCSI CHAP authentication on a sendtarget address --adapter or -A
The iSCSI adapter name. (required)
--address or -a
The iSCSI sendtarget address: ip/dns[:port] (required)
--authname or -N
The iSCSI authentication name
--default or -D
Resetting iSCSI authentication setting to default.
--direction or -d
The iSCSI authentication direction. Options are: [uni, mutual]
--inherit or -I
Inheriting iSCSI authentication setting from parent.
--level or -l
The iSCSI authentication level. Options are: [prohibited, discouraged, preferred, required]
--secret or -S
The iSCSI authentication secret. The recommended length is at least 12 bytes. (secret)
--help
Show the help message.
iscsi adapter discovery sendtarget param get Get iSCSI parameter on a sendtarget address --adapter or -A
The iSCSI adapter name. (required)
--address or -a
The iSCSI sendtarget address: ip/dns[:port] (required)
--help
Show the help message.
iscsi adapter discovery sendtarget param set Set the iSCSI parameter for the iSCSI Sendtarget. --adapter or -A
The iSCSI adapter name. (required)
--address or -a
The iSCSI sendtarget address: ip/dns[:port] (required)
--default or -D
Resetting iSCSI parameter setting to default.
--inherit or -I
Inheriting iSCSI parameter setting from parent.
--key or -k
The iSCSI parameter key (required)
--value or -v
The iSCSI parameter value
--help
Show the help message.
iscsi adapter discovery statictarget add Add a static target address --adapter or -A
The iSCSI adapter name. (required)
--address or -a
The iSCSI target address: ip/dns[:port]. IPv6 address can be specified as [XX:XX:XX:XX::XX]:port or XX:XX:XX:XX::XX (required)
--name or -n
The iSCSI target name. (required)
--help
Show the help message.
iscsi adapter discovery statictarget list List static target addresses --adapter or -A
The iSCSI adapter name.
--help
Show the help message.
iscsi adapter discovery statictarget remove Remove a static target --adapter or -A
The iSCSI adapter name. (required)
--address or -a
The iSCSI target address: ip/dns[:port]. IPv6 address can be specified as [XX:XX:XX:XX::XX]:port or XX:XX:XX:XX::XX (required)
--name or -n
The iSCSI target name. (required)
--help
Show the help message.
iscsi adapter discovery status get Get the iSCSI adapter discovery status for the iSCSI Host Bus Adapter. --adapter or -A
The iSCSI adapter name. (required)
--help
Show the help message.
iscsi adapter firmware get Validate the iSCSI firmware for the iSCSI Host Bus Adapter. --adapter or -A
The iSCSI adapter name. (required)
--file or -f
Path to the firmware file to retrieve information from. (required)
--help
Show the help message.
iscsi adapter firmware set Upload the iSCSI firmware for the iSCSI Host Bus Adapter. --adapter or -A
The iSCSI adapter name. (required)
--file or -f
Path to the firmware file to download. (required)
--help
Show the help message.
iscsi adapter param get Get the iSCSI parameters for the iSCSI Host Bus Adapter. --adapter or -A
The iSCSI adapter name. (required)
--help
Show the help message.
iscsi adapter param set Set the iSCSI parameter for the iSCSI Host Bus Adapter. --adapter or -A
The iSCSI adapter name. (required)
--default or -D
Resetting iSCSI parameter setting to default.
--key or -k
The iSCSI initiator parameter key. (required)
--value or -v
The iSCSI initiator parameter value.
--help
Show the help message.
iscsi adapter target list List iSCSI targets. --adapter or -A
The iSCSI adapter name.
--name or -n
The iSCSI target name.
--help
Show the help message.
iscsi adapter target lun list Get iSCSI LUN information --adapter or -A
The iSCSI adapter name.
--target or -t
The iSCSI target number. If a target number is specified, an adapter name must also be specified.
--help
Show the help message.
iscsi adapter target portal list List iSCSI target portals. --adapter or -A
The iSCSI adapter name.
--name or -n
The iSCSI target name.
--help
Show the help message.
iscsi adapter target portal auth chap get Get iSCSI CHAP authentication on a target --adapter or -A
The iSCSI adapter name. (required)
--address or -a
The iSCSI target address: ip/dns[:port] (required)
--direction or -d
The iSCSI authentication direction. Options are: [uni, mutual]
--method or -m
The iSCSI authentication method. Options are: [chap]
--name or -n
The iSCSI target name: iqn/eui (required)
--help
Show the help message.
iscsi adapter target portal auth chap set Set the iSCSI CHAP authentication for the iSCSI Target. --adapter or -A
The iSCSI adapter name. (required)
--address or -a
The iSCSI target address: ip/dns[:port] (required)
--authname or -N
The iSCSI authentication name
--default or -D
Resetting iSCSI authentication setting to default.
--direction or -d
The iSCSI authentication direction. Options are: [uni, mutual]
--inherit or -I
Inheriting iSCSI authentication setting from parent.
--level or -l
The iSCSI authentication level. Options are: [prohibited, discouraged, preferred, required]
--name or -n
The iSCSI target name: iqn/eui (required)
--secret or -S
The iSCSI authentication secret. The recommended length is at least 12 bytes. (secret)
--help
Show the help message.
iscsi adapter target portal param get Get iSCSI parameter on a target --adapter or -A
The iSCSI adapter name. (required)
--address or -a
The iSCSI target address: ip/dns[:port] (required)
--name or -n
The iSCSI target name: iqn/eui (required)
--help
Show the help message.
iscsi adapter target portal param set Set the iSCSI parameter for the iSCSI Target. --adapter or -A
The iSCSI adapter name. (required)
--address or -a
The iSCSI target address: ip/dns[:port] (required)
--default or -D
Resetting iSCSI parameter setting to default.
--inherit or -I
Inheriting iSCSI parameter setting from parent.
--key or -k
The iSCSI parameter key (required)
--name or -n
The iSCSI target name: iqn/eui (required)
--value or -v
The iSCSI parameter value
--help
Show the help message.
iscsi ibftboot get Get iSCSI IBFT Boot details. --help
Show the help message.
iscsi ibftboot import Import iSCSI target configuration from iBFT to ESX iSCSI initiators. The boot target recorded in iBFT is added to all the eligible ‘dependent’ iSCSI adapters. --help
Show the help message.
iscsi logicalnetworkportal list List Logical Network Portals for iSCSI Adapter --adapter or -A
The iSCSI adapter name.
--help
Show the help message.
iscsi networkportal add Add a network portal for iSCSI adapter --adapter or -A
The iSCSI adapter name. (required)
--force or -f
The force flag (force add of iSCSI vmknic even it’s not compatible for iscsi multipathing)
--nic or -n
The iSCSI network portal (bound vmknic) (required)
--help
Show the help message.
iscsi networkportal list List Network Portal for iSCSI Adapter --adapter or -A
The iSCSI adapter name.
--help
Show the help message.
iscsi networkportal remove Remove a network portal for iSCSI adapter --adapter or -A
The iSCSI adapter name. (required)
--force or -f
The force flag (force removal of iSCSI vmknic when sessions are active using it)
--nic or -n
The iSCSI network portal (bound vmknic) (required)
--help
Show the help message.
iscsi networkportal ipconfig get Get iSCSI network portal ipv4 configuration --adapter or -A
The iSCSI adapter name. (required)
--nic or -n
The iSCSI network portal (vmknic)
--help
Show the help message.
iscsi networkportal ipconfig set Set iSCSI network portal IPv4 configuration. --adapter or -A
The iSCSI adapter name. (required)
--dns1 or -x
The iSCSI network portal primary DNS address
--dns2 or -y
The iSCSI network portal secondary DNS address
--enable or -e
Enable/Disable IPv4. All other options will be ignored if IPv4 is being disabled.
--enable-dhcpv4 or -d
Enable/Disable IPv4 configuration using DHCPv4. If DHCPv4 is being enabled, static configuration parameters (ip,subnet,gateway,dns1,dns2) are ignored.
--gateway or -g
The iSCSI network portal IPv4 gateway address
--ip or -i
The iSCSI network portal IPv4 address
--nic or -n
The iSCSI network portal (vmknic)
--subnet or -s
The iSCSI network portal IPv4 subnet mask
--help
Show the help message.
iscsi networkportal ipv6config get Get iSCSI network portal ipv6 configuration --adapter or -A
The iSCSI adapter name. (required)
--help
Show the help message.
iscsi networkportal ipv6config set Set iSCSI network portal IPv6 configuration. --adapter or -A
The iSCSI adapter name. (required)
--enable or -e
Enable/Disable IPv6
--enable-dhcpv6 or -d
Enable/Disable IPv6 configuration using DHCPv6
--enable-linklocal-autoconfiguration or -l
Enable/Disable auto configuration of linklocal address
--enable-router-advertisement or -r
Enable/Disable IPv6 configuration using Router Advertisement
--gateway6 or -g
The iSCSI network portal IPv6 gateway address
--help
Show the help message.
iscsi networkportal ipv6config address add Add IPv6 addresses to the given iSCSI network portal. --adapter or -A
The iSCSI adapter name. (required)
--address-list or -a
An IPv6 address to add in X:X:X::/X format. Multiple addresses can be provided using format -a address1 -a address2 -a address3.
--remove-all-existing or -r
Remove all existing routable IPv6 addresses before adding the addresses specified by –address-list. If this flag is passed and –address-list is empty, all existing routable addresses are removed.
--help
Show the help message.
iscsi networkportal ipv6config address list List the IPv6 addresses assigned to the iSCSI network portal. --adapter or -A
The iSCSI adapter name. (required)
--help
Show the help message.
iscsi networkportal ipv6config address remove Remove IPv6 addresses from the given iSCSI network portal. --adapter or -A
The iSCSI adapter name. (required)
--address-list or -a
An IPv6 address to remove in X:X:X::/X format. Multiple addresses can be provided using format -a address1 -a address2 -a address3. (required)
--help
Show the help message.
iscsi physicalnetworkportal list List Physical Network Portal for iSCSI Adapter --adapter or -A
The iSCSI adapter name.
--help
Show the help message.
iscsi physicalnetworkportal param get Get network parameters on a Physical Network Portal (vmnic) --adapter or -A
The iSCSI adapter name. (required)
--nic or -n
The physical network portal name: vmnic
--help
Show the help message.
iscsi physicalnetworkportal param set Set network parameter on a Physical Network Portal --adapter or -A
The iSCSI adapter name. (required)
--nic or -n
The physical network portal name: vmnic
--option or -o
The network parameter option. Supported options are [MTU, ArpRedirect]. (required)
--value or -v
Input value for a Physical Network Portal option (use 0/1 for bool, and number for int) (required)
--help
Show the help message.
iscsi plugin list List IMA plugins. --adapter or -A
The iSCSI adapter name.
--plugin or -p
The IMA plugin file name.
--help
Show the help message.
iscsi session add Login sessions on current iSCSI configuration. --adapter or -A
The iSCSI adapter name. (required)
--isid or -s
The isid of a session to duplicate for login.
--name or -n
The iSCSI target name.
--help
Show the help message.
iscsi session list List iSCSI Sessions. --adapter or -A
The iSCSI adapter name.
--isid or -s
The iSCSI session identifier.
--name or -n
The iSCSI target name.
--help
Show the help message.
iscsi session remove Logout sessions on current iSCSI configuration. --adapter or -A
The iSCSI adapter name. (required)
--isid or -s
The isid of a session to duplicate for login.
--name or -n
The name of the target to login to.
--help
Show the help message.
iscsi session connection list List iSCSI connections. --adapter or -A
The iSCSI adapter name.
--cid or -c
The iSCSI connection identifier(CID).
--isid or -s
The iSCSI session identifier(ISID).
--name or -n
The iSCSI target name.
--help
Show the help message.
iscsi software get Software iSCSI information. --help
Show the help message.
iscsi software set Enable or disable software iSCSI. --enabled or -e
Enable or disable the module. (required)
--name or -n
The iSCSI initiator name. The initiator name must not be specified when disabling software iSCSI.
--help
Show the help message.

esxcli network Commands

COMMAND DESCRIPTION OPTIONS HELP
network diag ping Send ICMP echo requests to network hosts. --count or -c
Specify the number of packets to send.
--debug or -D
VMKPing debug mode.
--df or -d
Set DF bit on IPv4 packets.
--host or -H
Specify the host to send packets to. This parameter is required when not executing ping in debug mode (-D)
--interface or -I
Specify the outgoing interface.
--interval or -i
Set the interval for sending packets in seconds.
--ipv4
Ping with ICMPv4 echo requests.
--ipv6
Ping with ICMPv6 echo requests.
--netstack
Specify the TCP/IP netstack which the interface resides on
--nexthop or -N
Override the system’s default route selection, in dotted quad notation. (IPv4 only. Requires interface option)
--size or -s
Set the payload size of the packets to send.
--ttl or -t
Set IPv4 Time To Live or IPv6 Hop Limit
--wait or -W
Set the timeout to wait if no responses are received in seconds.
--help
Show the help message.
network ens lcore add Create ENS context. --lcore-id or -l
ENS context id to be created. (required)
--help
Show the help message.
network ens lcore list List ENS contexts. --help
Show the help message.
network ens lcore remove Destroy ENS context. --lcore-id or -l
ENS context id to be destroyed. (required)
--help
Show the help message.
network ens lcore affinity get Get the affinity for given ENS context. --lcore-id or -l
ENS context id. (required)
--help
Show the help message.
network ens lcore affinity set Set affinity for given ENS context. --affinity or -a
Numa node affinity. (required)
--lcore-id or -l
ENS context id. (required)
--help
Show the help message.
network ens lcore switch add Associate given ENS context with given switch. --lcore-id or -l
ENS context id. (required)
--switch or -s
Switch name. (required)
--help
Show the help message.
network ens lcore switch get Get the switch associated with given ENS context. --lcore-id or -l
ENS context id. (required)
--help
Show the help message.
network ens lcore switch remove Disassociate given ENS context from virtual switch. --lcore-id or -l
ENS context id. (required)
--help
Show the help message.
network ens maxLcores get Get the maximum number of ENS contexts (lcores). --help
Show the help message.
network ens maxLcores set Set the maximum number of ENS contexts. --maxlcores or -n
Number of maximum ENS contexts to be assigned. (required)
--help
Show the help message.
network firewall get Get the firewall status. --help
Show the help message.
network firewall load Load firewall module and rulesets configuration. --help
Show the help message.
network firewall refresh Load ruleset configuration for firewall. --help
Show the help message.
network firewall set Set firewall enabled status and default action. --default-action or -d
Set to true to set defaultaction PASS, set to false to DROP.
--enabled or -e
Set to true to enable the firewall, set to false to disable the firewall.
--help
Show the help message.
network firewall unload Allow unload firewall module. --help
Show the help message.
network firewall ruleset list List the rulesets in firewall. --ruleset-id or -r
List configuration for specfic ruleset
--help
Show the help message.
network firewall ruleset set Set firewall ruleset status (allowedAll flag and enabled status). --allowed-all or -a
Set to true to allowed all ip, set to false to use allowed ip list.
--enabled or -e
Set to true to enable ruleset, set to false to disable it.
--ruleset-id or -r
The label of the ruleset. (required)
--help
Show the help message.
network firewall ruleset allowedip add Add allowed ip address/range to the ruleset ruleset. --ip-address or -i
Allowed ip address/range for the ruleset. (required)
--ruleset-id or -r
The label of the ruleset. (required)
--help
Show the help message.
network firewall ruleset allowedip list list allowed ip addresses for rulesets. --ruleset-id or -r
The label of the ruleset.
--help
Show the help message.
network firewall ruleset allowedip remove Remove allowed ip address/range from the ruleset. --ip-address or -i
Allowed ip address/range for the ruleset. (required)
--ruleset-id or -r
The label of the ruleset. (required)
--help
Show the help message.
network firewall ruleset client add Add a new client to a firewall ruleset. This enables the firewall ruleset and increments the number of clients using the ruleset. --ruleset-id or -r
The label of the ruleset. (required)
--help
Show the help message.
network firewall ruleset client get Show the number of clients using a firewall ruleset. --ruleset-id or -r
The label of the ruleset. (required)
--help
Show the help message.
network firewall ruleset client remove Remove 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. --ruleset-id or -r
The label of the ruleset. (required)
--help
Show the help message.
network firewall ruleset rule list List the rules of each ruleset in firewall. --ruleset-id or -r
List rules for specfic ruleset
--help
Show the help message.
network ip get Get global IP settings --help
Show the help message.
network ip set Update global IP settings --ipv6-enabled or -e
Enable or disable IPv6 (Reboot Required)
--help
Show the help message.
network ip connection list List active TCP/IP connections --netstack or -N
The network stack instance; if unspecified, use the default netstack instance--type or -t
Connection type : [ip, tcp, udp, all]
--help
Show the help message.
network ip dns search add Add a search domain to the list of domains to be searched when trying to resolve an host name on the ESXi host. --domain or -d
The string name of a domain to add to the list of search domains. (required)
--netstack or -N
The network stack instance; if unspecified, use the default netstack instance
--help
Show the help message.
network ip dns search list List the search domains currently configured on the ESXi host in the order in which they will be used when searching. --netstack or -N
The network stack instance; if unspecified, use the default netstack instance
--help
Show the help message.
network ip dns search remove Remove a search domain from the list of domains to be searched when trying to resolve an host name on the ESXi host. --domain or -d
The string name of a domain to remove from the list of search domains. (required)
--netstack or -N
The network stack instance; if unspecified, use the default netstack instance
--help
Show the help message.
network ip dns server add Add a new DNS server to the end of the list of DNS servers to use for this ESXi host. --netstack or -N
The network stack instance; if unspecified, use the default netstack instance
--server or -s
The IP address (v4 or v6) of the DNS server to add to the DNS server list. (required)
--help
Show the help message.
network ip dns server list Print a list of the DNS server currently configured on the system in the order in which they will be used. --netstack or -N
The network stack instance; if unspecified, use the default netstack instance
--help
Show the help message.
network ip dns server remove Remove a DNS server from the list of DNS servers to use for this ESXi host. --all or -a
--netstack | -N
The network stack instance; if unspecified, use the default netstack instance
--server or -s
--help
Show the help message.
network ip interface add Add a new VMkernel network interface. --dvport-id or -P
DVPort ID of the connection point. This requires –dvs-name to be given in the same command
--dvs-name or -s
DVSwitch name of the connection point. This requires –dvport-id to be given in the same command
--interface-name or -i
The name of the VMkernel network interface to create. This name must be in the form vmkX, where X is a number 0-255
--mac-address or -M
Set the MAC address for the newly created VMkernel network interface.
--mtu or -m
Set the MTU setting for a given VMkernel network interface on creation
--netstack or -N
The network stack instance; if unspecified, use the default netstack instance
--num-rxqueue or -R
Set the number of RX dispatch queues for a given VMkernel network interface on creation
--portgroup-name or -p
The name of the vswitch port group to add this VMkernel network interface to.
--help
Show the help message.
network ip interface list This command will list the VMkernel network interfaces currently known to the system. --netstack or -N
The network stack instance; if unspecified, consider all netstack instances
--help
Show the help message.
network ip interface remove Remove 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. --dvport-id or -P
DVPort ID of the connection point. This requires –dvs-name to be given in the same command
--dvs-name or -s
DVSwitch name of the connection point. This requires –dvport-id to be given in the same command
--interface-name or -i
The name of the VMkernel network interface to remove. This name must be in the form vmkX, where X is a number 0-255
--netstack or -N
The network stack instance; if unspecified, use the default netstack instance
--portgroup-name or -p
The name of the vswitch port group to delete this VMkernel network interface from.
--help
Show the help message.
network ip interface set This command sets the enabled status and MTU size of a given IP interface --enabled or -e
Set to true to enable the interface, set to false to disable it.
--interface-name or -i
The name of the interface to apply the configurations. (required)
--mtu or -m
The MTU size of the IP interface.
--help
Show the help message.
network ip interface ipv4 get List the IPv4 addresses assigned to VMkernel network interfaces. --interface-name or -i
The name of the VMkernel network interface to limit the output of this command to.
--netstack or -N
The network stack instance; if unspecified, consider all netstack instances
--help
Show the help message.
network ip interface ipv4 set Configure IPv4 setting for a given VMkernel network interface. --gateway or -g
The default gateway for this interface. The value must be a valid IPv4 address. Gateway would be reset if not provided
--interface-name or -i
The name of the VMkernel network interface to set IPv4 settings for. This name must be an interface listed in the interface list command. (required)
--ipv4 or -I
The static IPv4 address for this interface.
--netmask or -N
The static IPv4 netmask for this interface.
--peer-dns or -P
A boolean value to indicate if the system should use the DNS settings published via DHCPv4 for this interface.
--type or -t
IPv4 Address type : dhcp: Use DHCP to aquire IPv4 setting for this interface. none: Remove IPv4 settings form this interface. static: Set Static IPv4 information for this interface. Requires –ipv4 and –netmask options.
--help
Show the help message.
network ip interface ipv4 address list List the IPv4 addresses assigned to VMkernel network interfaces. --interface-name or -i
The name of the VMkernel network interface to limit the output of this command to.
--netstack or -N
The network stack instance; if unspecified, consider all netstack instances
--help
Show the help message.
network ip interface ipv6 get Get IPv6 settings for VMkernel network interfaces. This does not include the IPv6 addresses which can be found in the “address list” command. --interface-name or -n
The name of the VMkernel network interface to limit the output of this command to.
--netstack or -N
The network stack instance; if unspecified, consider all netstack instances
--help
Show the help message.
network ip interface ipv6 set Configure IPv6 settings for a given VMkernel network interface. --enable-dhcpv6 or -d
Setting this value to true will enable DHCPv6 on this interface and attempt to aquire an IPv6 address from the network
--enable-ipv6 or -e
Setting this value to true enables IPv6 on thisinterface while setting it to false disables IPv6 on this interface.
--enable-router-adv or -r
Setting this value to true will enable IPv6 Router Advertised IPv6 addresses to be added to this interface from any routers broadcasting on the local network.
--gateway or -g
A default gateway for this interface. The value must be a valid IPv6 address.
--interface-name or -i
The name of the VMkernel network interface to set IPv6 settings for. This name must be an interface listed in the interface list command. (required)
--peer-dns or -P
A boolean value to indicate if the system should use the DNS settings published via DHCPv6 for this interface.
--help
Show the help message.
network ip interface ipv6 address add Add a static IPv6 address to a given VMkernel network interface. --interface-name or -i
The name of the VMkernel network interface to add a static IPv6 address to. This name must be an interface listed in the interface list command. (required)
--ipv6 or -I
The IPv6 address to add to the given VMkernel network interface. This must be in X:X:X::/X format (required)
--help
Show the help message.
network ip interface ipv6 address list This command will list all of the IPv6 addresses currently assigned to the system --interface-name or -i
The name of the VMkernel network interface to limit the output of this command to.
--help
Show the help message.
network ip interface ipv6 address remove Remove an IPv6 address from a given VMkernel network interface. --interface-name or -i
The name of the VMkernel network interface to remove an IPv6 address from. This name must be an interface listed in the interface list command. (required)
--ipv6 or -I
The IPv6 address to remove from the given VMkernel network interface. This must be in X:X:X::/X format (required)
--help
Show the help message.
network ip interface tag add Adds a tag on a given VMkernel network interface. Supported tags are: Management, VMotion, faultToleranceLogging, vSphereReplication, vSphereReplicationNFC, vSphereProvisioning, VSAN, VSANWitness, vSphereBackupNFC, PrecisionTimeProtocol, VSANReplication --interface-name or -i
The name of the VMkernel network interface on which tags should be set. This name must be an interface listed in the interface list command. (required)
--tagname or -t
Tag name to assign to the interface (required)
--help
Show the help message.
network ip interface tag get Gets the tags set on the given VMkernel network interface. --interface-name or -i
Name of vmknic whose tags are to be read (required)
--help
Show the help message.
network ip interface tag remove Removes a tag on a given VMkernel network interface. --interface-name or -i
The name of the VMkernel network interface from which tags should be removed. This name must be an interface listed in the interface list command. (required)
--tagname or -t
Tag name to assign to the interface (required)
--help
Show the help message.
network ip ipsec sa add Add a Security Association. --encryption-algorithm or -e
Encryption algorithm for the Security Association. Should be one in set [null, 3des-cbc, aes128-cbc]. (required)
--encryption-key or -k
Encryption key(ASCII or hex). Length of hex key is dependent upon algorithm used. Required when a encryption algorithm has been specified.
--integrity-algorithm or -i
Integrity algorithm for the Security Association. Should be one in set [hmac-sha1, hmac-sha2-256]. (required)
--integrity-key or -K
Integrity key(ASCII or hex). Length of hex key is dependent upon algorithm used. (required)
--sa-destination or -d
Ipv6 address of Security Association destination. Can be specified as ‘any’ or a correct IPv6 address. (required)
--sa-mode or -m
Security Association mode. Should be one in set [transport, tunnel].
--sa-name or -n
Name for the Security Association to be added. (required)
--sa-source or -s
Ipv6 address of Security Association source. Can be specified as ‘any’ or a correct IPv6 address. (required)
--sa-spi or -p
SPI value for the Security Association(hex). (required)
--help
Show the help message.
network ip ipsec sa list List configured Security Associations --help
Show the help message.
network ip ipsec sa remove Operation to remove Security Association(s) --remove-all or -a
Set to remove all Security Associations.
--sa-destination or -d
Ipv6 address of Security Association destination. This option needs to be specified when removing an auto SA.
--sa-name or -n
Name for the Security Association to be removed. Specify ‘auto’ to remove an auto SA.
--sa-source or -s
Ipv6 address of Security Association source. This option needs to be specified when removing an auto SA.
--sa-spi or -p
SPI value for the Security Association (hex). This option needs to be specified when removing an auto SA
--help
Show the help message.
network ip ipsec sp add Add a Security Policy. --action or -A
Action for Security Policy. Should be one in set [none, discard, ipsec].
--destination-port or -P
Destination Port for Security Policy. ‘0’ stands for ‘any’ (required)
--flow-direction or -w
Flow direction for Security Policy. Should be one in set [in, out].
--sa-name or -a
Name for the Security Association. Not being Specified lets vmkernel automatically choose an Security Association. If no applicable Security Association exists, then vmkernel may request one using IKE.
--source-port or -p
Source Port for Security Policy. ‘0’ stands for ‘any’ (required)
--sp-destination or -d
Ipv6 address and prefix length of Security Policy destination. Can be specified as ‘any’ or a correct Ipv6 network address. (required)
--sp-mode or -m
Security Policy mode. Should be one in set [transport, tunnel].
--sp-name or -n
Name for the Security Policy to be added. (required)
--sp-source or -s
Ipv6 address and prefix length of Security Policy source. Can be specified as ‘any’ or a correct IPv6 network address. (required)
--upper-layer-protocol or -u
Upper layer protocol for Security Policy, Should be one in set [any, tcp, udp, icmp6].
--help
Show the help message.
network ip ipsec sp list List configured Security Policys --help
Show the help message.
network ip ipsec sp remove Operation to remove Security Policy --remove-all or -a
Set to remove all Security Policys
--sp-name or -n
Name for the Security Policy to be removed.
--help
Show the help message.
network ip neighbor list List ARP table entries --interface-name or -i
The name of the VMkernel network interface to limit the output of this command to; if unspecified, list neighbors on all interfaces.
--netstack or -N
The network stack instance; if unspecified, use the default netstack instance
--version or -v
IP version : [4, 6, all]
--help
Show the help message.
network ip neighbor remove Remove ARP table entries --interface-name or -i
The name of the VMkernel network interface to remove the neighbor entry from. If not specified, neighbor will be removed from all interfaces
--neighbor-addr or -a
The IPv4/IPv6 address of the neighbor. (required)
--netstack or -N
The network stack instance; if unspecified, use the default netstack instance
--version or -v
IP version : [4, 6] (required)
--help
Show the help message.
network ip netstack add Add a new Netstack Instance. --disabled or -d
Create the netstack instance only in config i.e. in disabled state. Does not create in kernel.
--netstack or -N
The network stack instance (required)
--help
Show the help message.
network ip netstack get Get runtime/configuration settings for a given Netstack Instance. --netstack or -N
The network stack instance (required)
--help
Show the help message.
network ip netstack list This command will list the VMkernel Netstack instances currently known to the system. --help
Show the help message.
network ip netstack remove Remove a new Netstack Instance. --netstack or -N
The network stack instance (required)
--help
Show the help message.
network ip netstack set Configure settings for a given Netstack Instance. --ccalgo or -c
The TCP Congestion Contol Algorithm for this netstack instance (not applied to existing connections).: cubic: Set cubic as the algorithm dctcp: Set dctcp as the algorithm newreno: Set newreno as the algorithm--ecnThe status of ECN (Explicit Congestion Notification). disabled: Completely disable ECN functionality echo-only: Only echoing ECN, won’t initiate enabled: Fully enable ECN functionality
--enable or -e
Enable the netstack instance (create in kernel)
--ipv6enabled or -i
To enable IPv6 for this netstack instance (aplied only during netstack creation).
--maxconn or -m
The maximum number of connections for this netstack instance (applied only during netstack creation).
--name or -n
The name for this netstack instance.
--netstack or -N
The network stack instance. This name must be an interface listed in the netstack list command. (required)
--help
Show the help message.
network ip route ipv4 add Add IPv4 route to the VMkernel. --gateway or -g
The Ipv4 address of the gateway through which a route to be added. (required)
--netstack or -N
The network stack instance; if unspecified, use the default netstack instance
--network or -n
The Ipv4 address and prefix length of the network to add the route to. Specify ‘default’ to indicate the default network. (required)
--help
Show the help message.
network ip route ipv4 list List configured IPv4 routes --netstack or -N
The network stack instance; if unspecified, use the default netstack instance
--help
Show the help message.
network ip route ipv4 remove Remove IPv4 route --gateway or -g
The Ipv4 address of the gateway through which a route to be removed (required)
--netstack or -N
The network stack instance; if unspecified, use the default netstack instance
--network or -n
The Ipv4 address and prefix length of the network to remove the route from. Specify ‘default’ to indicate the default network. (required)
--help
Show the help message.
network ip route ipv6 add Add IPv6 route to the VMkernel. --gateway or -g
The Ipv6 address of the gateway through which a route to be added. (required)
--netstack or -N
The network stack instance; if unspecified, use the default netstack instance
--network or -n
The Ipv6 address and prefix length of the network to add the route to. Specify ‘default’ to indicate the default network. (required)
--help
Show the help message.
network ip route ipv6 list List configured IPv6 routes --netstack or -N
The network stack instance; if unspecified, use the default netstack instance
--help
Show the help message.
network ip route ipv6 remove Remove IPv6 route from the VMkernel --gateway or -g
The Ipv6 address of the gateway through which a route to be removed (required)
--netstack or -N
The network stack instance; if unspecified, use the default netstack instance
--network or -n
The Ipv6 address and prefix length of the network to remove the route from. Specify ‘default’ to indicate the default network. (required)
--help
Show the help message.
network multicast group list List all the multicast group members. --help
Show the help message.
network nic down Bring down the specified network device. --nic-name or -n
The name of the NIC to configured. This must be one of the cards listed in the nic list command. (required)
--help
Show the help message.
network nic get Get the generic configuration of a network device --nic-name or -n
The name of the NIC to configured. This must be one of the cards listed in the nic list command. (required)
--help
Show the help message.
network nic list This command will list the Physical NICs currently installed and loaded on the system. --help
Show the help message.
network nic set Set the general options for the specified ethernet device. --auto or -a
Set the speed and duplexity settings to autonegotiate.
--duplex or -D
The duplex to set this NIC to. Acceptable values are : [full, half]
--message-level or -l
Sets the driver message level. Meaning differ per driver.
--nic-name or -n
The name of the NIC to configured. This must be one of the cards listed in the nic list command. (required)
--phy-address or -P
Set the PHY address of the device
--port or -p
Selects device port. Available device ports are aui: Select AUI (Attachment Unit Interface) as the device port backplane: Select Backplane as the device port bnc: Select BNC (Bayonet Neill-Concelman) as the device port da: Select DA (Direct Attach copper) as the device port fibre: Select fibre as the device port mii: Select MII (Media Independent Interface) as the device port tp: Select TP (Twisted Pair) as the device port
--speed or -S
The speed to set this NIC to, in Mbps. Acceptable values are : [10, 100, 1000, 2500, 5000, 10000, 20000, 25000, 40000, 50000, 56000, 100000, 200000, 400000]
--transceiver-type or -t
Selects transeiver type. Currently only internal and external can be specified, in the future future types might be added. Available transeiver types are external: Set the transceiver type to external internal: Set the transceiver type to internal
--virtual-address or -V
Set the virtual address of the device
--wake-on-lan or -w
Sets Wake-on-LAN options. Not all devices support this. The argument to this option is a string of characters specifying which options to enable. p Wake on phy activity u Wake on unicast messages m Wake on multicast messages b Wake on broadcast messages a Wake on ARP g Wake on MagicPacket(tm) s Enable SecureOn(tm) password for MagicPacket(tm)
--help
Show the help message.
network nic up Bring up the specified network device. --nic-name or -n
The name of the NIC to configured. This must be one of the cards listed in the nic list command. (required)
--help
Show the help message.
network nic attachment add Attach one uplink as a branch to a trunk uplink with specified VLAN ID. --branch or -b
The name of the NIC to be attached as branch uplink. (required)
--trunk or -t
The name of the NIC to be configured as trunk uplink. (required)
--vlan-id or -v
The vlan ID for the branch uplink. Valid values: integer in the range 1-4094 (required)
--help
Show the help message.
network nic attachment list Show uplink attachment information. --trunk or -t
Show information only for the specified NIC.
--help
Show the help message.
network nic attachment remove Detach a branch uplink from its trunk. --branch or -b
The name of the branch uplink. (required)
--trunk or -t
The name of the trunk uplink. (required)
--help
Show the help message.
network nic coalesce get Get coalesce parameters --vmnic or -n
The name of pnic to get coalesce parameters
--help
Show the help message.
network nic coalesce set Set coalesce parameters on a nic --adaptive-rx or -a
enable or disable adaptive RX algorithm in driver.
--adaptive-tx or -A
enable or disable adaptive TX algorithm in driver.
--rx-max-frames or -R
Maximum number of RX frames driver to process before interrupting.
--rx-usecs or -r
Number of microseconds driver to wait for RX before interrupting.
--sample-interval or -i
Packet rate sampling internal in seconds for the adaptive coalescing algorithm in driver.
--tx-max-frames or -T
Maximum number of completed TX frames driver to process before interrupting.
--tx-usecs or -t
Number of microseconds driver to wait for completed TX before interrupting.
--vmnic or -n
Name of vmnic to set coalesce parameters. (required)
--help
Show the help message.
network nic coalesce high get Get information about the behavior of a NIC when it sends or receives packets at high packet rate. --vmnic or -n
The name of the pnic for which information should be retrieved. (required)
--help<br>Show the help message.
network nic coalesce high set Set parameters to control the behavior of a NIC when it sends or receives packets at high packet rate. --pkt-rate or -p
The high packet rate measured in number of packets per second. When packet rate is above this parameter, the RX/TX coalescing parameters configured by this command are used.
--rx-max-frames or -R
The maximum number of RX packets to delay an RX interrupt after they arrive under high packet rate conditions.
--rx-usecs or -rThe number of microseconds to delay an RX interrupt after a packet arrives under high packet rate conditions.
--tx-max-frames or -T
The maximum number of TX packets to delay an TX interrupt after they are sent under high packet rate conditions.
--tx-usecs or -t
The number of microseconds to delay a TX interrupt after a packet is sent under high packet rate conditions.
--vmnic or -n
Name of the vmnic for which parameters should be set. (required)
--help
Show the help message.
network nic coalesce low get Get information about the behavior of a NIC when it sends or receives packets at low packet rate. --vmnic or -n
The name of the pnic for which information should be retrieved. (required)
--help
Show the help message.
network nic coalesce low set Set parameters to control the behavior of a NIC when it sends or receives packets at low packet rate. --pkt-rate or -p
The low packet rate measured in number of packets per second. When packet rate is below this parameter, the RX/TX coalescing parameters configured by this command are used.
--rx-max-frames or -R
The maximum number of RX packets to delay an RX interrupt after they arrive under low packet rate conditions.
--rx-usecs or -r
The number of microseconds to delay an RX interrupt after a packet arrives under low packet rate conditions.
--tx-max-frames or -T
The maximum number of TX packets to delay an TX interrupt after they are sent under low packet rate conditions.
--tx-usecs or -t
The number of microseconds to delay a TX interrupt after a packet is sent under low packet rate conditions.
--vmnic or -n
Name of the vmnic for which parameters should be set. (required)
--help
Show the help message.
network nic cso get Get checksum offload settings --vmnic or -n
The name of pnic to get CSO settings
--help
Show the help message.
network nic cso set Set checksum offload settings on a nic --enable or -e
RX/TX checksum offload (required)
--vmnic or -n
Name of vmnic to set offload settings. (required)
--help
Show the help message.
network nic dcb status get Get the DCB information for a NIC. --nic-name or -n
The name of the NIC for which you need the info. See “nic list” command. (required)
--help
Show the help message.
network nic eeprom change Change EEPROM on a nic --file or -f
File name of new EEPROM content
--magic or -m
Magic key of EEPROM (required)
--offset or -o
Offset of EEPROM to change
--value or -v
New EEPROM value in double word
--vmnic or -n
Name of vmnic to change EEPROM. (required)
--help
Show the help message.
network nic eeprom dump Dump device EEPROM --length or -l
Bytes of EEPROM to dump
--offset or -o
Offset of EEPROM starting to dump
--vmnic or -n
The name of pnic to dump EEPROM (required)
--help
Show the help message.
network nic negotiate restart Restart N-Way negotiation on a nic --vmnic or -n
Name of vmnic to restart negotiation (required)
--help
Show the help message.
network nic pauseParams list List pause parameters of all NICs --nic-name or -n
The name of the NIC whose pause parameters should be retrieved.
--help
Show the help message.
network nic pauseParams set Set pause parameters for a NIC --auto or -a
Enable/disable auto negotiation.
--nic-name or -n
Name of NIC whose pause parameters should be set. (required)
--rx or -r
Enable/disable pause RX flow control.
--tx or -t
Enable/disable pause TX flow control.
--help
Show the help message.
network nic queue count get Get netqueue count on a nic --vmnic or -n
The name of pnic to get netqueue count
--help
Show the help message.
network nic queue count set Set number of netqueues on a nic --num or -q
Number of queues to set. (required)
--rx or -rRx netqueue to set count.
--tx or -t
Tx netqueue to set count.
--vmnic or -n
Name of vmnic to set netqueue count. (required)
--help
Show the help message.
network nic queue filterclass list List the netqueue supported filterclass of all physical NICs currently installed and loaded on the system. --help
Show the help message.
network nic queue loadbalancer list List the load balancer settings of all the installed and loaded physical NICs. (S:supported, U:unsupported, N:not-applicable, A:allowed, D:disallowed). --help
Show the help message.
network nic queue loadbalancer set Enable/disable netqueue load balancer setting on a NIC. --dynpoollb
Configure Dynamic queue pool at netqueue load balancer.
--geneveoamlb
Configure Geneve OAM at netqueue load balancer.
--lrolb
Configure Large Receive Offload at netqueue load balancer.
--maclearnlb
Configure Mac learn load balancing at netqueue load balancer.
--rsslb
Configure Receive Side Scaling at netqueue load balancer.
--rxdynlb
Configure RX dynamic load balancing at netqueue load balancer.
--rxqlatency
Configure Rx queue latency at netqueue load balancer.
--rxqnofeat
Configure Rx queue no feature at netqueue load balancer.
--rxqpair
Configure Rx queue pair at netqueue load balancer.
--rxqpreempt
Configure pre-emptible queue at netqueue load balancer.
--vmnic or -n
Name of vmnic to update netqueue load balancer setting. (required)
--help
Show the help message.
network nic queue loadbalancer plugin list Details of netqueue balancer plugins on all physical NICs currently installed and loaded on the system --vmnic or -n
The name of pnic to get netqueue plugin details
--help
Show the help message.
network nic queue loadbalancer plugin set Enable/disable netqueue balancer plugin on a NIC --enable or -e
Netqueue balancer plugin state (required)
--module or -m
Name of netqueue balancer module (required)
--plugin or -p
Name of netqueue balancer plugin (required)
--vmnic or -n
Name of vmnic to change netqueue balancer plugin state (required)
--help
Show the help message.
network nic queue loadbalancer state list Netqueue balancer state of all physical NICs currently installed and loaded on the system --vmnic or -n
The name of pnic to get netqueue balancer state
--help
Show the help message.
network nic queue loadbalancer state set Enable/disable netqueue balancer on a NIC --enable or -e
Netqueue balancer state (required)
--vmnic or -n
Name of vmnic to change netqueue balancer state (required)
--help
Show the help message.
network nic register dump Dump device registers --vmnic or -n
The name of pnic to dump registers (required)
--help
Show the help message.
network nic ring current get Get current RX/TX ring buffer parameters of a NIC --nic-name or -n
The name of the NIC whose current RX/TX ring buffer parameters should be retrieved. (required)
--help
Show the help message.
network nic ring current set Set current RX/TX ring buffer parameters of a NIC --nic-name or -n
The name of the NIC whose current RX/TX ring buffer parameters should be set. (required)
--rx or -r
Number of ring entries for the RX ring.
--rx-jumbo or -j
Number of ring entries for the RX jumbo ring.
--rx-mini or -m
Number of ring entries for the RX mini ring.
--tx or -t
Number of ring entries for the TX ring.
--help
Show the help message.
network nic ring preset get Get preset maximums for RX/TX ring buffer parameters of a NIC. --nic-name or -n
The name of the NIC whose preset maximums for RX/TX ring buffer parameters should be retrieved. (required)
--help
Show the help message.
network nic selftest run Run self test --online or -o
Performing limited set of tests do not inetrrupt normal adapter operation, default is offline
--vmnic or -n
The name of pnic to dump EEPROM (required)
--help
Show the help message.
network nic sg get Get scatter-gather settings --vmnic or -n
The name of pnic to get scatter-gather settings
--help
Show the help message.
network nic sg set Set scatter-gatter settings on a nic --enable or -e
Enable/disable sacatter-gather (required)
--vmnic or -n
Name of vmnic to configure scatter-gather settings. (required)
--help
Show the help message.
network nic software list List software simulation settings of physical NICs currently installed and loaded on the system. --vmnic or -n
Limit the output to only the physical NICS with the specified names.
--help
Show the help message.
network nic software set Enable and disable software simulation settings on a NIC. --geneveoffload
Configure Geneve encapsulation offload software simulation.
--highdma
Configure high DMA software simulation.
--ipv4csoConfigure IPv4 checksum offload software simulation.
--ipv4tso
Configure IPv4 TCP segmentation offload software simulation.
--ipv6cso
Configure IPv6 checksum offload software simulation.
--ipv6csoext
Configure IPv6 extend header checksum offload software simulation.
--ipv6tso
Configure IPv6 TCP segmentation offload software simulation.
--ipv6tsoext
Configure IPv6 extend header TCP segmentation offload software simulation.
--obo
Configure offset based encapsulation offload software simulation.
--sg
Configure scatter gather software simulation.
--sgsp
Configure scatter gather span multiple pages software simulation.
--tagging
Configure TX VLAN tagging software simulation.
--untagging
Configure RX VLAN untagging software simulation.
--vmnic or -n
Name of the vmnic whose software similation settings should be updated. (required)
--vxlanencap
Configure VXLAN encapsulation offload software simulation.
--help
Show the help message.
network nic stats get Get NIC statistics for a given interface. --nic-name or -n
Name of the NIC to get statistics from. (required)
--help
Show the help message.
network nic tso get Get TCP segmentation offload settings --vmnic or -n
The name of pnic to get TSO settings
--help
Show the help message.
network nic tso set Set TCP segmentation offload settings on a nic --enable or -e
TCP segmentation offload (required)
--vmnic or -n
Name of vmnic to set TSO settings. (required)
--help
Show the help message.
network nic vlan stats get List VLAN statistics for active VLAN’s on the NIC. --nic-name or -n
Name of the NIC to get statistics from. (required)
--help
Show the help message.
network nic vlan stats set Enable/disable VLAN statistics collection on the NIC. --enabled or -e
Whether to enable or disable VLAN statistics (required)
--nic-name or -n
Name of the NIC to get statistics from. (required)
--help
Show the help message.
network port filter stats get Filter statistics for a given port. --portid or -p
Port ID for the port to get filter statistics. (required)
--help
Show the help message.
network port stats get Packet statistics for a given port. --portid or -p
Port ID for the port to get statistics. (required)
--help
Show the help message.
network sriovnic list This command will list the SRIOV Enabled NICs (PFs) currently installed and loaded on the system. --help
Show the help message.
network sriovnic vf list Get the generic configuration of VFs for SRIOV NIC. --nic-name or -n
The name of the SRIOV NIC to configured. This must be one of the cards listed in the sriovNic list command. (required)
--help
Show the help message.
network sriovnic vf stats Get statistics for given VF of a SRIOV NIC. --nic-name or -n
The name of the SRIOV NIC. This must be one of the cards listed in the sriovNic list command. (required)
--vf-id or -v
The VF ID of the virtual function whose stats are to be collected. This must be one of the VF IDs listed in the sriovnic vf list command. (required)
--help
Show the help message.
network vm list List networking information for the VM’s that have active ports. --help
Show the help message.
network vm port list List of active ports for a given VM. --world-id or -w
World ID of the VM for listing ports. (required)
--help
Show the help message.
network vswitch dvs vmware list List the VMware vSphere Distributed Switch currently configured on the ESXi host. --vds-name or -v
Limit the output of this command to only vDS with the given name.
--help
Show the help message.
network vswitch dvs vmware lacp config get Get LACP configuration on DVS --dvs or -s
The name of DVS to get configuration on
--help
Show the help message.
network vswitch dvs vmware lacp stats get Get LACP stats on DVS uplinks --dvs or -s
The name of DVS to get configuration on
--help
Show the help message.
network vswitch dvs vmware lacp status get Get LACP status on DVS --dvs or -s
The name of DVS to get configuration on
--help
Show the help message.
network vswitch dvs vmware lacp timeout set Set long/short timeout for vmnics in one LACP LAG --lag-id or -l
The ID of LAG to be configured. (required)
--nic-name or -n
The nic name. If it is set, then only this vmnic in the lag will be configured.
--timeout or -t
Set long or short timeout: 1 for short timeout and 0 for long timeout. (required)
--vds or -s
The name of VDS. (required)
--help
Show the help message.
network vswitch standard add Add a new virtual switch to the ESXi networking system. --ports or -P
The number of ports to to give this newly created virtual switch. Maximum ports per virtual switch is 4096. If no value is given the default value(128) is used. The number of ports is limited by the number of already allocated ports on the host. The system wide port count cannot be greater than 4608.
--vswitch-name or -v
The name of the virtual switch to create. (required)
--help
Show the help message.
network vswitch standard list List the virtual switches current on the ESXi host. --vswitch-name or -v
Limit the output of this command to only virtual switches with the given name.
--help
Show the help message.
network vswitch standard remove Remove a virtual switch from the ESXi networking system. --vswitch-name or -v
The name of the virtual switch to remove. (required)
--help
Show the help message.
network vswitch standard set This command sets the MTU size and CDP status of a given virtual switch. --cdp-status or -c
The CDP status of the given virtual switch. It can be ‘down’, ‘listen’, ‘advertise’ or ‘both’
--mtu or -m
The MTU size of the given virtual switch.
--vswitch-name or -v
The name of virtual switch to apply the configurations. (required)
--help
Show the help message.
network vswitch standard policy failover get Get the failover policy settings governing the given virtual switch --vswitch-name or -v
The name of the virtual switch to use when fetching the switch failover policy. (required)
--help
Show the help message.
network vswitch standard policy failover set Configure the Failover policy for a virtual switch. --active-uplinks or -a
Configure the list of active adapters and their failover order. This list must be a comma seperated list of values with the uplink name and no spaces. Example: –active-uplinks=vmnic0,vmnic3,vmnic7,vmnic1
--failback or -b
Configure whether a NIC will be used immediately when it comes back in service after a failover
--failure-detection or -f
Set the method of determining how a network outage is detected. beacon: Detect failures based on active beaconing to the vswitch link: Detect failures based on the NIC link state
--load-balancing or -l
Set the load balancing policy for this policy. This can be one of the following options: explicit: Always use the highest order uplink from the list of active adapters which pass failover criteria. iphash: Route based on hashing the src and destination IP addresses mac: Route based on the MAC address of the packet source. portid: Route based on the originating virtual port ID.
--notify-switches or -n
Indicate whether to send a notification to physical switches on failover
--standby-uplinks or -s
Configure the list of standby adapters and their failover order. This list must be a comma seperated list of values with the uplink name and no spaces. Example: –standby-uplinks=vmnic2,vmnic4,vmnic8,vmnic6,vmnic11
--vswitch-name or -v
The name of the virtual switch to use when configuring the switch failover policy. (required)
--help
Show the help message.
network vswitch standard policy security get Get the Security Policy governing the given virtual switch. --vswitch-name or -v
The name of the virtual switch to use when fetching the network security policy. (required)
--help
Show the help message.
network vswitch standard policy security set Set the security policy for a given virtual switch --allow-forged-transmits or -f
Allow ports on the virtual switch to send packets with forged source information.
--allow-mac-change or -m
Allow ports on the virtual switch to change their MAC address.
--allow-promiscuous or -p
Allow ports on the virtual switch to enter promiscuous mode.
--vswitch-name or -v
The name of the virtual switch to use when setting the switch security policy. (required)
--help
Show the help message.
network vswitch standard policy shaping get Get the shaping policy settings for the given virtual switch --vswitch-name or -v
The name of the virtual switch to use when fetching the switch shaping policy. (required)
--help
Show the help message.
network vswitch standard policy shaping set Set the shaping policy settings for the given virtual switch --avg-bandwidth or -b
The averge bandwidth allowed for this shaping policy. This value is in Kbps (1 Kbps = 1000 bits/s)
--burst-size or -t
The largest burst size allowed for this shaping policy. This value is in Kib (1 Kib = 1024 bits)
--enabled or -e
Indicate whether to enable traffic shaping on this policy. If this is true then the –avg-bandwidth, –peak-bandwidth and –burst-size options are required.
--peak-bandwidth or -k
The peak bandwidth allowed for this shaping policy. This value is in Kbps (1 Kbps = 1000 bits/s)
--vswitch-name or -v
The name of the virtual switch to use when setting the switch shaping policy. (required)
--help
Show the help message.
network vswitch standard portgroup add Allows the addition of a standard port group to a virtual switch. --portgroup-name or -p
The name of the port group to add (required)
--vswitch-name or -v
The virtual switch to add the port group to. (required)
--help
Show the help message.
network vswitch standard portgroup list List all of the port groups currently on the system. --help
Show the help message.
network vswitch standard portgroup remove Remove a port group from the given virtual switch --portgroup-name or -p
(required)
--vswitch-name or -v
(required)
--help
Show the help message.
network vswitch standard portgroup set Set the vlan id for the given port group --portgroup-name or -p
The name of the port group to set vlan id for. (required)
--vlan-id or -v
The vlan id for this port group. This value is in the range (0 - 4095)
--help
Show the help message.
network vswitch standard portgroup policy failover get Get the network failover policy settings governing the given port group --portgroup-name or -p
The name of the port group to use when fetching the port group failover policy. (required)
--help
Show the help message.
network vswitch standard portgroup policy failover set Configure the Failover policy for a port group. These setting may potentially override virtual switch settings. --active-uplinks or -a
Configure the list of active adapters and their failover order. This list must be a comma seperated list of values with the uplink name and no spaces. Example: –active-uplinks=vmnic0,vmnic3,vmnic7,vmnic1
--failback or -b
Configure whether a NIC will be used immediately when it comes back in service after a failover
--failure-detection or -f
Set the method of determining how a network outage is detected. beacon: Detect failures based on active beaconing to the vswitch link: Detect failures based on the NIC link state
--load-balancing or -l
Set the load balancing policy for this policy. This can be one of the following options: explicit: Always use the highest order uplink from the list of active adapters which pass failover criteria. iphash: Route based on hashing the src and destination IP addresses mac: Route based on the MAC address of the packet source. portid: Route based on the originating virtual port ID.
--notify-switches or -n
Indicate whether to send a notification to physical switches on failover
--portgroup-name or -p
The name of the port group to set failover policy for. (required)
--standby-uplinks or -s
Configure the list of standby adapters and their failover order. This list must be a comma seperated list of values with the uplink name and no spaces. Example: –standby-uplinks=vmnic2,vmnic4,vmnic8,vmnic6,vmnic11
--use-vswitch or -u
Reset all values for this policy to use parent virtual switch’s settings instead of overriding the settings for the port group. Using this in conjunction with other settings will first reset all of the fields to use the virtual switch setting and then apply the other options after the reset.
--help
Show the help message.
network vswitch standard portgroup policy security get Get the Security Policy governing the given port group. --portgroup-name or -p
The name of the port group to use when fetching the network security policy. (required)
--help
Show the help message.
network vswitch standard portgroup policy security set Set the security policy for a given port group --allow-forged-transmits or -f
Allow ports on the virtual switch to send packets with forged source information.
--allow-mac-change or -m
Allow ports on the virtual switch to change their MAC address.
--allow-promiscuous or -o
Allow ports on the virtual switch to enter promiscuous mode.
--portgroup-name or -p
The name of the port group to set security policy for. (required)
--use-vswitch or -u
Reset all values for this policy to use parent virtual switch’s settings instead of overriding the settings for the port group. Using this in conjunction with other settings will first reset all of the fields to use the virtual switch setting and then apply the other options after the reset.
--help
Show the help message.
network vswitch standard portgroup policy shaping get Get the network shaping policy settings governing the given port group --portgroup-name or -p
The name of the port group to use when fetching the port group shaping policy. (required)
--help
Show the help message.
network vswitch standard portgroup policy shaping set Set the shaping policy settings for the given port group --avg-bandwidth or -b
The averge bandwidth allowed for this shaping policy. This value is in Kbps (1 Kbps = 1000 bits/s)
--burst-size or -t
The largest burst size allowed for this shaping policy. This value is in Kib (1 Kib = 1024 bits)
--enabled or -e
Indicate whether to enable traffic shaping on this policy. If this is true then the –avg-bandwidth, –peak-bandwidth and –burst-size options are required.
--peak-bandwidth or -k
The peak bandwidth allowed for this shaping policy. This value is in Kbps (1 Kbps = 1000 bits/s)
--portgroup-name or -p
The name of the port group to set shaping policy for. (required)
--use-vswitch or -u
Reset all values for this policy to use parent virtual switch’s settings instead of overriding the settings for the port group. Using this in conjunction with other settings will first reset all of the fields to use the virtual switch setting and then apply the other options after the reset.
--help
Show the help message.
network vswitch standard uplink add Add 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 --uplink-name or -u
The name of the uplink to add to the virtual switch. (required)
--vswitch-name or -v
The name of the virtual switch to add an uplink to. (required)
--help
Show the help message.
network vswitch standard uplink remove Remove 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 --uplink-name or -u
The name of the uplink to remove from the virtual switch. (required)
--vswitch-name or -v
The name of the virtual switch to remove an uplink from. (required)
--help
Show the help message.

esxcli nvme Commands

COMMAND DESCRIPTION OPTIONS HELP
nvme adapter list List all NVMe adapters. --help
Show the help message.
nvme controller identify Get NVMe Identify Controller data. --controller or -c
Controller to operate on. (required)
--format or -f
Output format. Valid values are: detailed: Show bit level value and description. hex: Dump the data in hex format.
--help
Show the help message.
nvme controller list List all NVMe controllers. --help
Show the help message.
nvme device get Get NVMe device information --adapter or -A
Adapter to operate on (required)
--help
Show the help message.
nvme device list List NVMe devices registered to VMware NVMe driver --help
Show the help message.
nvme device controller list List all controllers on the device if namespace is not specified, otherwise list all controllers the namespace attached --adapter or -A
Adapter to operate on (required)
--namespace or -n
Namespace ID attached. ID starts from 1
--help
Show the help message.
nvme device feature cap Get NVMe device feature supported capabilities information --adapter or -A
Adapter to operate on (required)
--help
Show the help message.
nvme device feature aec get Get NVMe device feature async event configuration information --adapter or -A
Adapter to operate on (required)
--select or -S
specify which value of the attributes to return, “current”, “default”, “saved”
--help
Show the help message.
nvme device feature aec set Set NVMe device feature async event configuration information --adapter or -A
Adapter to operate on (required)
--fwnotices or -w
an asynchronous event notification is sent to the host for a Firmware Activation Starting event, 0 for false, 1 for true, 0 will be passed as default value, if not set
--nsnotices or -m
an asynchronous event notification is sent to the host for a Namespace Attribute change, 0 for false, 1 for true, 0 will be passed as default value, if not set
--save or -S
save the attribute
--value or -v
SMART health critical warnings bitmap to be set, refer to Figure 79, NVMe 1.2 SPEC (required)
--help
Show the help message.
nvme device feature apst get Get NVMe device feature autonomous power state transition information --adapter or -A
Adapter to operate on (required)
--select or -S
specify which value of the attributes to return, “current”, “default”, “saved”
--help
Show the help message.
nvme device feature ar get Get NVMe device feature arbitration information --adapter or -A
Adapter to operate on (required)
--select or -S
specify which value of the attributes to return, “current”, “default”, “saved”
--help
Show the help message.
nvme device feature ar set Set NVMe device feature arbitration information --adapter or -A
Adapter to operate on (required)
--save or -S
save the attribute
--value or -v
Arbitration Burst value to be set (required)
--value2 or -x
Low Priority Weight value to be set (required)
--value3 or -y
Medium Priority Weight value to be set (required)
--value4 or -z
High Priority Weight value to be set (required)
--help
Show the help message.
nvme device feature er get Get NVMe device feature error recovery information --adapter or -A
Adapter to operate on (required)
--namespace or -n
Namespace to operate on
--select or -S
specify which value of the attributes to return, “current”, “default”, “saved”
--help
Show the help message.
nvme device feature er set Set NVMe device feature error recovery information --adapter or -A
Adapter to operate on (required)
--enable or -e
deallocated or unwritten logical block error enable value to be set, 0 for false (disable), 1 for true (enable), 0 will be passed as default value, if not set
--namespace or -n
Namespace to operate on, 0 will be passed as default value, if not set
--save or -Ssave the attribute
--value or -v
Time limited error recovery value to be set (required)
--help
Show the help message.
nvme device feature hi get Get NVMe device feature host identifier information --adapter or -A
Adapter to operate on (required)
--select or -S
specify which value of the attributes to return, “current”, “default”, “saved”
--help
Show the help message.
nvme device feature hmb get Get NVMe device feature host memory buffer information --adapter or -A
Adapter to operate on (required)
--select or -S
specify which value of the attributes to return, “current”, “default”, “saved”
--help
Show the help message.
nvme device feature ic get Get NVMe device feature interrupt coalescing information --adapter or -A
Adapter to operate on (required)
--select or -S
specify which value of the attributes to return, “current”, “default”, “saved”
--help
Show the help message.
nvme device feature ic set Set NVMe device feature interrupt coalescing information --adapter or -A
Adapter to operate on (required)
--save or -S
save the attribute
--value or -v
Aggregation threshold value to be set (required)
--value2 or -x
Aggregation time value to be set (required)
--help
Show the help message.
nvme device feature ivc get Get NVMe device feature interrupt vector configuration information --adapter or -A
Adapter to operate on (required)
--select or -S
specify which value of the attributes to return, “current”, “default”, “saved”
--help
Show the help message.
nvme device feature ivc set Set NVMe device feature interrupt vector configuration information --adapter or -A
Adapter to operate on (required)
--save or -S
save the attribute
--value or -v
Interrupt vector value to be set (required)
--value2 or -x
Coalescing disable value to be set, 0 for false (enable), 1 for true (disable) (required)
--help
Show the help message.
nvme device feature kat get Get NVMe device feature keep alive timer information --adapter or -A
Adapter to operate on (required)
--select or -S
specify which value of the attributes to return, “current”, “default”, “saved”
--help
Show the help message.
nvme device feature kat set Set NVMe device feature keep alive timer information --adapter or -A
Adapter to operate on (required)
--save or -S
save the attribute
--timeout or -t
timeout value for the keep alive feature to be set (required)
--help
Show the help message.
nvme device feature lba get Get NVMe device feature LBA range type information --adapter or -A
Adapter to operate on (required)
--namespace or -n
Namespace to operate on (required)
--select or -S
specify which value of the attributes to return, “current”, “default”, “saved”
--help
Show the help message.
nvme device feature nq get Get NVMe device feature number of queue information --adapter or -A
Adapter to operate on (required)
--select or -S
specify which value of the attributes to return, “current”, “default”, “saved”
--help
Show the help message.
nvme device feature pm get Get NVMe device feature power management information --adapter or -A
Adapter to operate on (required)
--select or -S
specify which value of the attributes to return, “current”, “default”, “saved”
--help
Show the help message.
nvme device feature pm set Set NVMe device feature power management information --adapter or -A
Adapter to operate on (required)
--save or -S
save the attribute
--value or -v
Power state value to be set (required)
--workload or -w
Workload Hint to be set, 0 will be passed as default value, if not set
--help
Show the help message.
nvme device feature spm get Get NVMe device feature software progress marker information --adapter or -A
Adapter to operate on (required)
--select or -S
specify which value of the attributes to return, “current”, “default”, “saved”
--help
Show the help message.
nvme device feature spm set Set software progress marker feature information, will clear Pre-boot Software Load Count (PBSLC) to 0 --adapter or -A
Adapter to operate on (required)
--save or -S
save the attribute
--help
Show the help message.
nvme device feature tt get Get NVMe device feature temperature threshold information --adapter or -A
Adapter to operate on (required)
--select or -S
specify which value of the attributes to return, “current”, “default”, “saved”
--help
Show the help message.
nvme device feature tt set Set NVMe device feature temperature threshold information --adapter or -A
Adapter to operate on (required)
--save or -S
save the attribute
--sensor or -s
Threshold temperature select value to be set, 0 will be passed as default value, if not set
--under or -u
Set under temperature threshold
--value or -v
Temperature threshold value to be set (required)
--help
Show the help message.
nvme device feature vwc get Get NVMe device feature volatile write cache information --adapter or -A
Adapter to operate on (required)
--select or -S
specify which value of the attributes to return, “current”, “default”, “saved”
--help
Show the help message.
nvme device feature vwc set Set NVMe device feature volatile write cache information --adapter or -A
Adapter to operate on (required)
--save or -S
save the attribute
--value or -v
Volitale write cache enable value to be set, 0 for false (disable), 1 for true (enable) (required)
--help
Show the help message.
nvme device feature wa get Get NVMe device feature write atomicity information --adapter or -A
Adapter to operate on (required)
--select or -S
specify which value of the attributes to return, “current”, “default”, “saved”
--help
Show the help message.
nvme device feature wa set Set NVMe device feature write atomicity information --adapter or -A
Adapter to operate on (required)
--save or -S
save the attribute
--value or -v
Disable Normal value to be set, 0 for false (enable), 1 for true (disable) (required)
--help
Show the help message.
nvme device firmware activate Commit downloaded firmware image to a specific slot --action or -a
Activate action 0: Downloaded image replaces the image indicated by the firmware slot field. This image is not activated. 1: Downloaded image replaces the image indicated by the firmware slot field. This image is activated at the next reset. 2: The image specified by the firmware slot field is activated at the next reset. 3: The image specified by the firmware slot field is requested to be activated immediately without reset. (required)
--adapter or -A
Adapter to operate on (required)
--slot or -s
Slot number. If the value specified is 0, then the controller shall choose the firmware slot. (required)
--help
Show the help message.
nvme device firmware download Download firmware image to the device --adapter or -A
Adapter to operate on (required)
--firmware or -f
Firmware image path (required)
--help
Show the help message.
nvme device log error get Get NVMe device error log information --adapter or -A
Adapter to operate on (required)
--elpe or -e
Error log page entries. This value indicates the number of log entries you wish to get. The maximum number of entries supported is device-specific. (required)
--help
Show the help message.
nvme device log fwslot get Get NVMe device firmware slot log information --adapter or -A
Adapter to operate on (required)
--help
Show the help message.
nvme device log smart get Get NVMe device SMART log information --adapter or -A
Adapter to operate on (required)
--namespace or -n
Namespace ID. If log page is supported on a per namespace basis this value indicates the ID of namespace you wish to get log from. This parameter can be omitted to request global log page.
--help
Show the help message.
nvme device namespace attach Attach namespace on NVMe device --adapter or -A
Adapter to operate on (required)
--controller or -c
Controller ID to attach. ID starts from 0 (required)
--namespace or -n
Namespace ID to attach. ID starts from 1 (required)
--help
Show the help message.
nvme device namespace create Create namespace on NVMe device --adapter or -A
Adapter to operate on (required)
--capacity or -c
Namespace Capacity (required)
--dps or -p
End-to-End Data Protection Type Settings (required)
--flbas or -f
Formatted LBA Size (required)
--nmic or -m
Namespace Multi-path IO and Namespace Sharing Capabilities (required)
--size or -s
Namespace Size (required)
--help
Show the help message.
nvme device namespace delete Delete namespace on NVMe device --adapter or -A
Adapter to operate on (required)
--namespace or -n
ID of namespace to delete, starts from 1 (required)
--help
Show the help message.
nvme device namespace detach Detach namespace on NVMe device --adapter or -A
Adapter to operate on (required)
--controller or -c
Controller ID to detach. ID starts from 0 (required)
--namespace or -n
ID of namespace to detach. ID starts from 1 (required)
--help
Show the help message.
nvme device namespace format Change namespace format --adapter or -A
Adapter to operate on (required)
--format or -f
LBA Format(LBAF) (required)
--ms or -m
Metadata Settings(MS). 0: Metadata is transferred as part of a separate buffer. 1: Metadata is transferred as part of an extended data LBA. (required)
--namespace or -n
Namespace ID (required)
--pi or -p
Protection Information(PI). 0: Protection information is not enabled. 1: Protection information is enabled, Type 1. 2: Protection information is enabled, Type 2. 3: Protection information is enabled, Type 3. (required)
--pil or -l
Protection Information Location(PIL). 0: PI is transferred as the last eight bytes of metadata, if PI is enabled. 1: PI is transferred as the first eight bytes of metadata, if PI is enabled. (required)
--ses or -s
Secure Erase Settings(SES). 0: No secure erase operation requested. 1: User Data Erase. 2: Cryptographic Erase. (required)
--help
Show the help message.
nvme device namespace get Get nvme namespace information --adapter or -A
Adapter to operate on (required)
--namespace or -n
ID of namespace to get information from. ID starts from 1 (required)
--help
Show the help message.
nvme device namespace list List namespace on NVMe device --adapter or -A
Adapter to operate on (required)
--help
Show the help message.
nvme device register get Dump NVMe device registers --adapter or -A
Adapter to operate on (required)
--help
Show the help message.
nvme device timeout get Get timeout value of IO timeout checker --adapter or -A
Adapter to operate on (required)
--help
Show the help message.
nvme device timeout set Set timeout value for IO timeout checker --adapter or -A
Adapter to operate on (required)
--timeout or -t
IO timeout seconds for internal checker. Maximum timeout value is 40. 0: disable timeout checker. (required)
--help
Show the help message.
nvme driver loglevel set Set NVMe driver log level and debug level --debuglevel or -d
Debug level(hex int format). When log level is 5, this value is used to manupulate NVMe driver parameter: nvme_dbg. This parameter can be omitted to indicate value 0. BIT_0: Print ctrlr level log BIT_1: Print namespace level log BIT_2: Print queue level log BIT_3: Print IO command level log BIT_4: Print admin command level log BIT_5: Print management level log BIT_6: Print exception handler log BIT_7: Print split command log BIT_13: Print timeout handler log BIT_14: Print init/cleanup log BIT_15: Print temp log BIT_16: Dump SG array BIT_17: Dump PRP BIT_18: Dump cdb BIT_19: Dump NVM command BIT_20: Dump completion queue entry BIT_21: Dump user passthru data BIT_22: Dump namespace info BIT_23: Dump timeout info BIT_24: Dump smart log info
--loglevel or -l
Log level. This value is used to manupulate NVMe driver parameter: nvme_log_level. 1: error 2: warning 3: info 4: verbose 5: debug (required)
--help
Show the help message.
nvme fabrics connect Connect to an NVMe controller on a specified target through an adapter. --adapter or -a
Adapter through which the controller will be connected. (required)
--admin-queue-size or -q
Size of the admin queue (default: 32).
--controller-id or -c
ID of the controller to be connected. (default: 0xFFFF)
--ip-address or -i
IP(v4/v6) address of the RDMA target port. (required for NVMe/RDMA)
--keep-alive-timeout or -t
Keep alive timeout value in seconds. (range: 5~180, default: 60)
--port-number or -p
Port number of the RDMA target port. (default: 4420)
--subsystem-nqn or -s
NVMe Qualified Name of the NVM subsystem. (required)
--world-wide-node-name or -W
World Wide Node Name of the fibre channel target port. (required for NVMe/FC)
--world-wide-port-name or -w
World Wide Port Name of the fibre Channel target port. (required for NVMe/FC)
--help
Show the help message.
nvme fabrics disable Disable NVMe over Fabrics for a transport protocol. --device or -d
Device on which to disable NVMe. (required)
--protocol or -p
Transport protocol to be disabled. Options are: RDMA: RDMA Protocol (required)
--help
Show the help message.
nvme fabrics disconnect Disconnect a specified NVMe controller on the specified NVMe adapter. --adapter or -a
Adapter to use for target disconnection. (required)
--controller-number or -n
Controller number to disconnect.
--subsystem-nqn or -s
NVMe Qualified Name of the NVM subsystem.
--help
Show the help message.
nvme fabrics discover Discover NVMe controllers on the specified target port through the specified NVMe adapter and list all of them. --adapter or -a
Adapter to use for target discovery. (required)
--connect-all or -c
Connect to all the discovered NVM Subsystems.
--ip-address or -i
IP(v4/v6) address of the RDMA target port. (required for NVMe/RDMA)
--port-number or -p
Port number of the RDMA target port. (default: 4420)
--world-wide-node-name or -W
World Wide Node Name of the fibre channel target port. (required for NVMe/FC)
--world-wide-port-name or -w
World Wide Port Name of the fibre Channel target port. (required for NVMe/FC)
--help
Show the help message.
nvme fabrics enable Enable NVMe over Fabrics for a transport protocol. --device or -d
Device on which to enable NVMe. (required)
--protocol or -p
Transport protocol to be enabled. Available options are: RDMA: RDMA Protocol (required)
--help
Show the help message.
nvme fabrics connection delete Delete persistent NVMe over Fabrics connection entries. Reboot required for settings to take effect. --aqn or -a
Adapter’s AQN(Adapter Qualified Name) of the NVMe over Fabrics connection to be deleted. (required)
--ip-address or -i
IP(v4/v6) address of the RDMA target port. (required for NVMe/RDMA)
--port-number or -p
Port number of the RDMA target port. (default: 4420)
--subsystem-nqn or -s
NVMe Qualified Name of the NVM subsystem.
--world-wide-node-name or -W
World Wide Node Name of the fibre channel target port. (required for NVMe/FC)
--world-wide-port-name or -w
World Wide Port Name of the fibre Channel target port. (required for NVMe/FC)
--help
Show the help message.
nvme fabrics connection list List all persistent NVMe over Fabrics connection entries. --help
Show the help message.
nvme info get Get NVMe host information. --help
Show the help message.
nvme namespace identify Get NVMe Identify Namespace data. --format or -f
Output format. Valid values are: detailed: Show bit level value and description. hex: Dump the data in hex format.
--namespace or -n
Namespace to operate on. (required)
--help
Show the help message.
nvme namespace list List all NVMe namespaces. --help
Show the help message.

esxcli rdma Commands

COMMAND DESCRIPTION OPTIONS HELP
rdma device list List the logical RDMA devices currently registered on the system. --help
Show the help message.
rdma device protocol list List the enabled RDMA protocols. --help
Show the help message.
rdma device stats get Get statistics for a given RDMA device. --device or -d
Name of the RDMA device. (required)
--help
Show the help message.
rdma device vmknic list List the vmknics associated with RDMA devices. --device or -d
Name of the RDMA device whose vmknics to display.
--help
Show the help message.
rdma iser add Add an iser device to enable iser module driver. --help
Show the help message.
rdma iser delete Delete an iser logical device. --help
Show the help message.

esxcli sched Commands

COMMAND DESCRIPTION OPTIONS HELP
sched reliablemem get Check if the system is currently aware of reliable memory. --help
Show the help message.
sched swap system get Get current state of the options of the system-wide shared swap space. --help
Show the help message.
sched swap system set Change the configuration of system-wide shared swap space. --datastore-enabled or -d
If the datastore option should be enabled or not.
--datastore-name or -n
The name of the datastore used by the datastore option.
--datastore-order or -D
The order of the datastore option in the preference of the options
--hostcache-enabled or -c
If the host cache option should be enabled or not.
--hostcache-order or -C
The order of the host cache option in the preference of the options.
--hostlocalswap-enabled or -l
If the host local swap option should be enabled or not.
--hostlocalswap-order or -L
The order of the host local swap option in the preference of the options.
--help
Show the help message.

esxcli software Commands

COMMAND DESCRIPTION OPTIONS HELP
software apply Applies a complete image with a software spec that specifies base image, addon and components to install on the host. --depot or -d
Specifies full remote URLs of the depot index.xml or a local offline bundle .zip file on the server. (required)
--dry-run
Performs a dry-run. Report the VIB-level operations that would be performed, but do not change anything in the system.
--no-hardware-warning
Allows the transaction to ignore hardware precheck warnings. A hardware precheck error will continue to be shown with this option. Use of this option may result in device not functioning normally.
--no-live-install
Forces an install to /altbootbank even if the VIBs are eligible for live installation or removal. Will cause installation to be skipped on PXE-booted hosts.
--no-sig-check
Bypasses acceptance level and signing verifications. Use of this option poses a large security risk and will result in a SECURITY ALERT warning being displayed in vSphere Web Client.
--proxy
Specifies a proxy server for HTTP, FTP, and HTTPS connections, in the format of proxy-url:port.
--software-spec or -s
Specifies the JSON software spec to apply on the host. A local file path or a remote URL can be supplied. (required)
--help
Show the help message.
software acceptance get Gets the host acceptance level. This controls what VIBs will be allowed on a host. --help
Show the help message.
software acceptance set Sets the host acceptance level. This controls what VIBs will be allowed on a host. --level
Specifies the acceptance level to set. Should be one of VMwareCertified / VMwareAccepted / PartnerSupported / CommunitySupported. (required)
--help
Show the help message.
software addon get Display the installed Addon on the host. --rebooting-image
Displays information for the ESXi image which becomes active after a reboot, or nothing if the pending-reboot image has not been created yet. If not specified, information from the current ESXi image in memory will be returned.
--help
Show the help message.
software baseimage get Display the installed baseimage on the host. --rebooting-image
Displays information for the ESXi image which becomes active after a reboot, or nothing if the pending-reboot image has not been created yet. If not specified, information from the current ESXi image in memory will be returned.
--help
Show the help message.
software component apply Installs Component packages from a depot. Components may be installed, upgraded. WARNING: If your installation requires a reboot, you need to disable HA first. --component or -n
Specifies Components from a depot, using one of the following forms: name, name:version.
--depot or -d
Specifies the full remote URL to the depot’s index.xml, or a local file path to an offline bundle .zip file. (required)
--dry-run
Performs a dry-run only. Report the Component-level operations that would be performed, but do not change anything in the system.
--no-sig-check
Bypasses acceptance level verification, including signing. Use of this option poses a large security risk and will result in a SECURITY ALERT warning being displayed in vSphere Web Client.
--proxy
Specifies a proxy server to use for HTTP, FTP, and HTTPS connections. The format is proxy-url:port.
--help
Show the help message.
software component get Displays detailed information about one or more installed Components --component or -n
Specifies one or more installed Components to display more information about. If this option is not specified, then all of the installed Components will be displayed. Must be one of the following forms: name, name:version.
--rebooting-image
Displays information for the ESXi image which becomes active after a reboot, or nothing if the pending-reboot image has not been created yet. If not specified, information from the current ESXi image in memory will be returned.
--help
Show the help message.
software component list Lists the installed Component packages --rebooting-image
Displays information for the ESXi image which becomes active after a reboot, or nothing if the pending-reboot image has not been created yet. If not specified, information from the current ESXi image in memory will be returned.
--help
Show the help message.
software component remove Removes components from the host. WARNING: If your installation requires a reboot, you need to disable HA first. --component or -n
Specifies one or more Components on the host to remove. Must be one of the following forms: name, name:version. (required)
--dry-run
Performs a dry-run only. Report the Components-level operations that would be performed, but do not change anything in the system.
--help
Show the help message.
software component signature verify Verifies the signatures of installed Components and displays the name, version, vendor, acceptance level and the result of signature verification for each of them. --rebooting-image
Displays information for the ESXi image which becomes active after a reboot. If not specified, information from the current ESXi image in memory will be returned.
--help
Show the help message.
software component vib list List VIBs in an installed Component. --component or -n
Specifies an installed Components to display more information about. Must be one of the following forms: name, name:version. (required)
--rebooting-image
Displays information for the ESXi image which becomes active after a reboot, or nothing if the pending-reboot image has not been created yet. If not specified, information from the current ESXi image in memory will be returned.
--help
Show the help message.
software profile get Display the installed image profile. --rebooting-image
Displays information for the ESXi image which becomes active after a reboot, or nothing if the pending-reboot image has not been created yet. If not specified, information from the current ESXi image in memory will be returned.
--help
Show the help message.
software profile install Installs 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. --depot or -d
Specifies full remote URLs of the depot index.xml or server file path pointing to an offline bundle .zip file. (required)
--dry-run
Performs a dry-run only. Report the VIB-level operations that would be performed, but do not change anything in the system.
--force or -f
Bypasses checks for package dependencies, conflicts, obsolescence, and acceptance levels. Really not recommended unless you know what you are doing. Use of this option will result in a warning being displayed in vSphere Web Client. Use this option only when instructed to do so by VMware Technical Support.
--maintenance-mode
Pretends that maintenance mode is in effect. Otherwise, installation will stop for live installs that require maintenance mode. This flag has no effect for reboot required remediations.
--no-hardware-warning
Allows the transaction to proceed when hardware precheck returns a warning. A hardware error will continue to be shown with this option. Use of this option may result in device not functioning normally.
--no-live-install
Forces an install to /altbootbank even if the VIBs are eligible for live installation or removal. Will cause installation to be skipped on PXE-booted hosts.
--no-sig-check
Bypasses acceptance level verification, including signing. Use of this option poses a large security risk and will result in a SECURITY ALERT warning being displayed in vSphere Web Client.
--ok-to-remove
Allows the removal of installed VIBs as part of applying the image profile. If not specified, esxcli will error out if applying the image profile results in the removal of installed VIBs.
--profile or -p
Specifies the name of the image profile to install. (required)
--proxy
Specifies a proxy server to use for HTTP, FTP, and HTTPS connections. The format is proxy-url:port.
--help
Show the help message.
software profile update Updates 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. --allow-downgrades
If this option is specified, then the VIBs from the image profile which update, downgrade, or are new to the host will be installed. If the option is not specified, then the VIBs which update or are new to the host will be installed.
--depot or -d
Specifies full remote URLs of the depot index.xml or server file path pointing to an offline bundle .zip file. (required)
--dry-run
Performs a dry-run only. Report the VIB-level operations that would be performed, but do not change anything in the system.
--force or -f
Bypasses checks for package dependencies, conflicts, obsolescence, and acceptance levels. Really not recommended unless you know what you are doing. Use of this option will result in a warning being displayed in vSphere Web Client. Use this option only when instructed to do so by VMware Technical Support.
--maintenance-mode
Pretends that maintenance mode is in effect. Otherwise, installation will stop for live installs that require maintenance mode. This flag has no effect for reboot required remediations.
--no-hardware-warning
Allows the transaction to proceed when hardware precheck returns a warning. A hardware error will continue to be shown with this option. Use of this option may result in device not functioning normally.
--no-live-install
Forces an install to /altbootbank even if the VIBs are eligible for live installation or removal. Will cause installation to be skipped on PXE-booted hosts.
--no-sig-check
Bypasses acceptance level verification, including signing. Use of this option poses a large security risk and will result in a SECURITY ALERT warning being displayed in vSphere Web Client.
--profile or -p
Specifies the name of the image profile to update the host with. (required)
--proxy
Specifies a proxy server to use for HTTP, FTP, and HTTPS connections. The format is proxy-url:port.
--help
Show the help message.
software profile validate Validates the current image profile on the host against an image profile in a depot. --depot or -d
Specifies full remote URLs of the depot index.xml or server file path pointing to an offline bundle .zip file. (required)
--profile or -p
Specifies the name of the image profile to validate the host with. (required)
--proxy
Specifies a proxy server to use for HTTP, FTP, and HTTPS connections. The format is proxy-url:port.
--help
Show the help message.
software sources addon get Display details about Addons in the depots. --addon or -a
Specify the Addon to display, in one of the follwing formats: name, name:version. (required)
--depot or -d
Specifies full remote URLs of the depot index.xml or server file path pointing to an offline bundle .zip file. (required)
--proxy
Specifies a proxy server to use for HTTP, FTP, and HTTPS connections. The format is proxy-url:port.
--help
Show the help message.
software sources addon list List all Addons in the depots. --depot or -d
Specifies full remote URLs of the depot index.xml or server file path pointing to an offline bundle .zip file. (required)
--proxy
Specifies a proxy server to use for HTTP, FTP, and HTTPS connections. The format is proxy-url:port.
--help
Show the help message.
software sources baseimage get Display details about a Base Image from the depot. --baseimageversion or -b
Specifies the name of the Base Image to display. (required)
--depot or -d
Specifies full remote URL of the depot index.xml or server file path pointing to an offline bundle .zip file. (required)
--proxy
Specifies a proxy server to use for HTTP, FTP, and HTTPS connections. The format is proxy-url:port.
--help
Show the help message.
software sources baseimage list List all the Base Images in a depot. --depot or -dSpecifies full remote URLs of the depot index.xml or server file path pointing to an offline bundle .zip file. (required)--proxySpecifies a proxy server to use for HTTP, FTP, and HTTPS connections. The format is proxy-url:port.--helpShow the help message.
software sources component get Displays detailed information about one or more Components in the depot --component or -n
Specifies one or more Components in the depot to display more information about. If this option is not specified, then all of the Component packages from the depot will be displayed. Must be one of the following forms: name, name:version.
--depot or -d
Specifies the full remote URL to the depot’s index.xml, or a local file path to an offline bundle .zip file. (required)
--proxy
Specifies a proxy server to use for HTTP, FTP, and HTTPS connections. The format is proxy-url:port.
--help
Show the help message.
software sources component list List all the Components from depots. --depot or -d
Specifies full remote URLs of the depot index.xml or server file path pointing to an offline bundle .zip file. (required)
--proxy
Specifies a proxy server to use for HTTP, FTP, and HTTPS connections. The format is proxy-url:port.
--help
Show the help message.
software sources component vib list List VIB packages in the specified Component in a depot. --component or -n
Specifies a Component to display information about. Must be one of the following forms: name, name:version. (required)
--depot or -d
Specifies full remote URLs of the depot index.xml or server file path pointing to an offline bundle .zip file. (required)
--proxy
Specifies a proxy server to use for HTTP, FTP, and HTTPS connections. The format is proxy-url:port.
--help
Show the help message.
software sources profile get Display details about an image profile from the depot. --depot or -d
Specifies full remote URLs of the depot index.xml or server file path pointing to an offline bundle .zip file. (required)
--profile or -p
Specifies the name of the image profile to display. (required)
--proxy
Specifies a proxy server to use for HTTP, FTP, and HTTPS connections. The format is proxy-url:port.
--help
Show the help message.
software sources profile list List all the image profiles in a depot. --depot or -d
Specifies full remote URLs of the depot index.xml or server file path pointing to an offline bundle .zip file. (required)
--proxy
Specifies a proxy server to use for HTTP, FTP, and HTTPS connections. The format is proxy-url:port.
--help
Show the help message.
software sources vib get Displays detailed information about one or more VIB packages in the depot --depot or -d
Specifies full remote URLs of the depot index.xml or server file path pointing to an offline bundle .zip file.
--proxy
Specifies a proxy server to use for HTTP, FTP, and HTTPS connections. The format is proxy-url:port.
--vibname or -n
Specifies one or more VIBs in the depot to display more information about. If this option is not specified, then all of the VIB packages from the depot will be displayed. Must be one of the following forms: name, name:version, vendor:name, or vendor:name:version.
--viburl or -v
Specifies one or more URLs to VIB packages to display information about. http:, https:, ftp:, and file: are all supported.
--help
Show the help message.
software sources vib list List all the VIBs from depots. --depot or -d
Specifies full remote URLs of the depot index.xml or server file path pointing to an offline bundle .zip file. (required)
--proxy
Specifies a proxy server to use for HTTP, FTP, and HTTPS connections. The format is proxy-url:port.
--help
Show the help message.
software vib get Displays detailed information about one or more installed VIBs --rebooting-image
Displays information for the ESXi image which becomes active after a reboot, or nothing if the pending-reboot image has not been created yet. If not specified, information from the current ESXi image in memory will be returned.
--vibname or -n
Specifies one or more installed VIBs to display more information about. If this option is not specified, then all of the installed VIBs will be displayed. Must be one of the following forms: name, name:version, vendor:name, or vendor:name:version.
--help
Show the help message.
software vib install Installs 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. --depot or -d
Specifies full remote URLs of the depot index.xml or server file path pointing to an offline bundle .zip file.
--dry-run
Performs a dry-run only. Report the VIB-level operations that would be performed, but do not change anything in the system.
--force or -f
Bypasses checks for package dependencies, conflicts, obsolescence, and acceptance levels. Really not recommended unless you know what you are doing. Use of this option will result in a warning being displayed in vSphere Web Client. Use this option only when instructed to do so by VMware Technical Support.
--maintenance-mode
Pretends that maintenance mode is in effect. Otherwise, installation will stop for live installs that require maintenance mode. This flag has no effect for reboot required remediations.
--no-live-install
Forces an install to /altbootbank even if the VIBs are eligible for live installation or removal. Will cause installation to be skipped on PXE-booted hosts.
--no-sig-check
Bypasses acceptance level verification, including signing. Use of this option poses a large security risk and will result in a SECURITY ALERT warning being displayed in vSphere Web Client.
--proxy
Specifies a proxy server to use for HTTP, FTP, and HTTPS connections. The format is proxy-url:port.
--vibname or -n
Specifies VIBs from a depot, using one of the following forms: name, name:version, vendor:name, or vendor:name:version.
--viburl or -v
Specifies one or more URLs to VIB packages to install. http:, https:, ftp:, and file: are all supported.
--help
Show the help message.
software vib list Lists the installed VIB packages --rebooting-image
Displays information for the ESXi image which becomes active after a reboot, or nothing if the pending-reboot image has not been created yet. If not specified, information from the current ESXi image in memory will be returned.
--helpShow the help message.
software vib remove Removes VIB packages from the host. WARNING: If your installation requires a reboot, you need to disable HA first. --dry-run
Performs a dry-run only. Report the VIB-level operations that would be performed, but do not change anything in the system.
--force or -f
Bypasses checks for package dependencies, conflicts, obsolescence, and acceptance levels. Really not recommended unless you know what you are doing. Use of this option will result in a warning being displayed in vSphere Web Client. Use this option only when instructed to do so by VMware Technical Support.
--maintenance-mode
Pretends that maintenance mode is in effect. Otherwise, remove will stop for live removes that require maintenance mode. This flag has no effect for reboot required remediations.
--no-live-install
Forces an remove to /altbootbank even if the VIBs are eligible for live removal. Will cause installation to be skipped on PXE-booted hosts.
--vibname or -n
Specifies one or more VIBs on the host to remove. Must be one of the following forms: name, name:version, vendor:name, vendor:name:version. (required)
--help
Show the help message.
software vib update Update 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. --depot or -d
Specifies full remote URLs of the depot index.xml or server file path pointing to an offline bundle .zip file.
--dry-run
Performs a dry-run only. Report the VIB-level operations that would be performed, but do not change anything in the system.
--force or -f
Bypasses checks for package dependencies, conflicts, obsolescence, and acceptance levels. Really not recommended unless you know what you are doing. Use of this option will result in a warning being displayed in vSphere Web Client. Use this option only when instructed to do so by VMware Technical Support.
--maintenance-mode
Pretends that maintenance mode is in effect. Otherwise, installation will stop for live installs that require maintenance mode. This flag has no effect for reboot required remediations.
--no-live-install
Forces an install to /altbootbank even if the VIBs are eligible for live installation or removal. Will cause installation to be skipped on PXE-booted hosts.
--no-sig-check
Bypasses acceptance level verification, including signing. Use of this option poses a large security risk and will result in a SECURITY ALERT warning being displayed in vSphere Web Client.
--proxy
Specifies a proxy server to use for HTTP, FTP, and HTTPS connections. The format is proxy-url:port.
--vibname or -n
Specifies VIBs from a depot, using one of the following forms: name, name:version, vendor:name, or vendor:name:version. VIB packages which are not updates will be skipped.
--viburl or -v
Specifies one or more URLs to VIB packages to update to. http:, https:, ftp:, and file: are all supported. VIB packages which are not updates will be skipped.
--help
Show the help message.
software vib signature verify Verifies the signatures of installed VIB packages and displays the name, version, vendor, acceptance level and the result of signature verification for each of them --rebooting-image
Displays information for the ESXi image which becomes active after a reboot. If not specified, information from the current ESXi image in memory will be returned.
--help
Show the help message.

esxcli storage Commands

COMMAND DESCRIPTION OPTIONS HELP
storage core adapter list List all the SCSI Host Bus Adapters on the system. --help
Show the help message.
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. --adapter or -A
Select the adapter to use when rescanning SCSI adapters. This must be a SCSI HBA name as shown in the adapter list command. This cannot be used with the –all option
--all or -aI
ndicate the rescan should rescan all adapters instead of a specific one.
--skip-claim or -S
By default after an add operation a claiming session is run to find new devices and have them be claimed by the appropriate Multipath Plugin. Passing this flag will skip that claiming session.
--skip-fs-scan or -F
This option is deprecated as no filesystem scan is performed by default
--type or -t
Specify the type of rescan to perform. Available types are add: Perform rescan and only add new devices if any. all: Perform rescan and do all opertaions (this is the default action.) delete: Perform rescan and only delete DEAD devices. update: Rescan existing paths only and update path states.
--help
Show the help message.
storage core adapter capabilities list List the capabilities of the SCSI HBAs in the system. --adapter or -a
Limit the capabilities output to one adapter
--help
Show the help message.
storage core adapter device list List the devices associated with HBAs. --adapter or -A
Limit the output to one or more adapter(s).
--help
Show the help message.
storage core adapter stats get List the SCSI stats for the SCSI Host Bus Adapters in the system. --adapter or -a
Limit the stats output to one adapter
--help
Show the help message.
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. --claimrule-class or -c
Indicate the claim rule class to use in this operation [MP, Filter, VAAI, all]. NVMe devices will not be claimed by Filter/VAAI plugins.
--enabled
Set the autoclaiming enabled state for a givenPSA plugin type in the VMkernel. Default is to have this process enabled. This should not be changed by users unless specifically instructed to do so. (required)
--wait or -w
If the –wait flag is provided then the autoclaim enable will wait for paths to ‘settle’ before running the claim operation. This means that the system is reasonably sure that all paths on the system have appeared before enabling autoclaim.
--help
Show the help message.
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. --device or -d
Reclaim requires the name of a device on which all paths will be unclaimed and then reclaimed. (required)
--help
Show the help message.
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. --adapter or -A
If the –type paramter is ‘location’ this value indicates the name of the host bus adapter for the paths you wish to unclaim. This parameter can be omitted to indicate unclaiming should be run on paths from all adapters.
--channel or -C
If the –type parameter is ‘location’ this value indicates the value of the SCSI channel number for the paths you wish to unclaim. This parameter can be omitted to indicate unclaiming should be run on paths with any channel number.
--claimrule-class or -c
Indicate the claim rule class to use in this operation [MP, Filter]. NVMe devices will not be claimed by Filter/VAAI plugins.
--device or -d
If the –type parameter is ‘device’ attempt to unclaim all paths to a specific device (for multipathing plugins) or unclaim the device itself (for filter plugins). NOTE. For paths, if there are any active I/O operations on this device, at least 1 path will fail to unclaim.
--driver or -D
If the –type parameter is ‘driver’ attempt to unclaim all paths provided by a specific HBA driver.
--lun or -L
If the –type parameter is ‘location’ this value indicates the value of the SCSI Logical Unit Number (LUN) for the paths you wish to unclaim. This parameter can be omitted to indicate unclaiming should be run on paths with any Logical Unit Number. If passed, this value must not be higher than the value of the advanced config option /Disk/MaxLUN
--model or -m
If the –type parameter is ‘vendor’ attempt to unclaim all paths to devices with specific model info (for multipathing plugins) or unclaim the device itself (for filter plugins). NOTE. For paths, if there are any active I/O operations on this device, at least 1 path will fail to unclaim.
--path or -p
If the –type parameter is ‘path’ attempt to unclaim a specific path given its path UID or runtime name.
--plugin or -P
If the –type parameter is ‘plugin’ attempt to unclaim all paths on for a given multipath plugin OR all devices attached to a filter plugin.
--target or -T
If the –type paramter is ‘location’ this value indicates the value of the SCSI target number for the paths you wish to unclaim. This parameter can be omitted to indicate unclaiming should be run on paths with any target number.
--type or -t
Indicate the type of unclaim you wish to perform. Valid values for this paramter are [location, path, driver, device, plugin, vendor] (required)
--vendor or -v
If the –type parameter is ‘vendor’ attempt to unclaim all paths to devices with specific vendor info (for multipathing plugins) or unclaim the device itself (for filter plugins). NOTE. For paths, if there are any active I/O operations on this device, at least 1 path will fail to unclaim.
--help
Show the help message.
storage core claimrule add Add a claimrule to the set of claimrules on the system. --adapter or -A
Indicate the adapter of the paths to use in this operation.
--autoassign or -u
The system will auto assign a rule id.
--channel or -C
Indicate the channel of the paths to use in this operation.
--claimrule-class or -c
Indicate the claim rule class to use in this operation [MP, Filter, VAAI]. NVMe devices will not be claimed by Filter/VAAI plugins.
--config-string or -g
Input parameter string for multi path plugins that can include one or more comma separated key-value pairs without spaces in between. e.g. key1=value1,key2=value2. If plugin is HPP, the path selection scheme can be configured with same options available through ‘esxcli storage hpp device set’ without ‘–’ prefix. Device can be marked local, remote, SSD using options ‘mark-device-local=true’, ‘mark-device-remote=true’, ‘mark-device-ssd=true’.
--device or -d
Indicate the Device Uid to use for this operation.
--driver or -D
Indicate the driver of the paths to use in this operation.
--force or -f
Force claim rules to ignore validity checks and install the rule anyway.
--force-reserved
Override protection of reserved rule id ranges.
--if-unset
Execute this command if this advanced user variable is not set to 1
--iqn or -i
Indicate the iSCSI Qualified Name for the target to use in this operation.
--lun or -L
Indicate the LUN of the paths to use in this operation. It must not be higher than the value of the advanced config option /Disk/MaxLUN
--model or -M
Indicate the model of the paths to use in this operation.
--nvme-controller-model
NVMe controller model for the device. This option is specific to NVMe devices. Value can be partial string as prefix ending with wildcard ‘‘ e.g. abcd. If this option is specified then –vendor/–model and –pci-vendor-id/–pci-sub-vendor-id should not be specified. This option is applicable for claimrule class ‘MP’.
--pci-sub-vendor-id
PCI sub vendor identifier for the device. The value should be hexadecimal number. For example, if PCI sub vendor ID is ‘0x8086’ then ‘8086’ should be provided as input. This option should be specified in combination with –pci-vendor-id and applicable in case of claimrule class ‘MP’.
--pci-vendor-id
PCI vendor identifier for the device. The value should be hexadecimal number. For example, if PCI vendor ID is ‘0x8086’ then ‘8086’ should be provided as input. –pci-sub-vendor-id can be specified along with this option. –vendor, –model or –nvme-controller-model options should not be specified with this option. This option is applicable for claimrule class ‘MP’.
--plugin or -P
Indicate which PSA plugin to use for this operation. (required)--rule or -r
Indicate the rule ID to use for this operation.
--target or -T
Indicate the target of the paths to use in this operation.
--transport or -R
Indicate the transport of the paths to use in this operation. Valid Values are: [block, fc, iscsi, iscsivendor, ide, sas, sata, usb, parallel, fcoe, pcie, rdma, unknown]
--type or -t
Indicate which type of matching used for claim/unclaim or claimrule. Valid values are: [vendor, location, driver, transport, device, target] (required)
--vendor or -V
Indicate the vendor of the paths to use in this operation. If this option is specified then –nvme-controller-model and –pci-vendor-id/–pci-sub-vendor-id should not be specified.
--wwnn
Indicate the World-Wide Node Number for the target to use in this operation.
--wwpn
Indicate the World-Wide Port Number for the target to use in this operation.
--xcopy-max-transfer-size or -m
Maximum transfer size in MB to use for XCOPY commands if admin wants to use a transfer size different than array reported. This option only takes effect when –xcopy-use-array-values is specified. This option is deprecated. Use –xcopy-max-transfer-size-kib instead
--xcopy-max-transfer-size-kib or -k
Maximum transfer size in KiB to use for XCOPY commands if admin wants to use a transfer size different than array reported. This option only takes effect when –xcopy-use-array-values is specified. This option takes precedence over –xcopy-max-transfer-size option
--xcopy-use-array-values or -a
Use array reported values for XCOPY commands.
--xcopy-use-multi-segs or -s
Use multiple segments for XCOPY commandsThis option only takes effect when –xcopy-use-array-values is specified.
--help
Show the help message.
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. --commit or -C
Force LUN mask config changes to be saved. If this parameter is omitted, config file changes will not be saved.
--help
Show the help message.
storage core claimrule list List all the claimrules on the system. --claimrule-class or -c
Indicate the claim rule class to use in this operation [MP, Filter, VAAI, all]. NVMe devices will not be claimed by Filter/VAAI plugins.
--help
Show the help message.
storage core claimrule load Load path claiming rules from config file into the VMkernel. --claimrule-class or -c
Indicate the claim rule class to use in this operation [MP, Filter, VAAI, all]. NVMe devices will not be claimed by Filter/VAAI plugins.
--help
Show the help message.
storage core claimrule move Move a claimrule from one rule id to another --claimrule-class or -c
Indicate the claim rule class to use in this operation [MP, Filter, VAAI]. NVMe devices will not be claimed by Filter/VAAI plugins.
--force-reserved
Override protection of reserved rule id ranges.
--new-rule or -n
Indicate the new rule id you wish to apply to the rule given by the –rule parameter. (required)
--rule or -r
Indicate the rule ID to use for this operation. (required)
--help
Show the help message.
storage core claimrule remove Delete a claimrule to the set of claimrules on the system. --claimrule-class or -c
Indicate the claim rule class to use in this operation [MP, Filter, VAAI]. NVMe devices will not be claimed by Filter/VAAI plugins.
--plugin or -P
Indicate the plugin to use for this operation.
--rule or -r
Indicate the rule ID to use for this operation.
--help
Show the help message.
storage core claimrule run Execute path claiming rules. --adapter or -A
If the –type parameter is ‘location’ this value indicates the name of the host bus adapter for the paths you wish to run claim rules on. This parameter can be omitted to indicate claim rules should be run on paths from all adapters.
--channel or -C
If the –type parameter is ‘location’ this value indicates the value of the SCSI channel number for the paths you wish to run claim rules on. This parameter can be omitted to indicate claim rules should be run on paths with any channel number.
--claimrule-class or -c
Indicate the claim rule class to use in this operation [MP, Filter]. NVMe devices will not be claimed by Filter/VAAI plugins.
--device or -d
Indicate the Device Uid to use for this operation.
--lun or -L
If the –type paramter is ‘location’ this value indicates the value of the SCSI Logical Unit Number (LUN) for the paths you wish to run claim rules on. This parameter can be omitted to indicate claim rules should be run on paths with any Logical Unit Number.
--path or -p
If the –type paramter is ‘path’ this value indicates the unique path identifier (UID) or the runtime name of a path which you wish to run claim rules on.
--target or -T
If the –type parameter is ‘location’ this value indicates the value of the SCSI target number for the paths you wish to run claim rules on. This parameter can be omitted to indicate claim rules should be run on paths with any target number.
--type or -t
Indicate the type of claim run you wish to perform. By default the value of ‘all’ will be used indicating you wish to run claim rules without restricting the run to specific paths or SCSI addresses. Valid values for this parameter are [location, path, device, all]
--wait or -w
If the –wait flag is provided then the claim command will wait until device registration has completed to return. This option is only valid when used with the –all option.
--help
Show the help message.
storage core device list List the devices currently registered with the PSA. --device or -d
Filter the output of this command to only show a single device.
--exclude-offline or -o
If set this flag will exclude the offline devices
--pe-only or -p
If set this flag will list the mount points of pe type.
--skip-slow-fields
Do not show the value of some fields that need more time to fetch. The output will show the value skipped for such fields.
--help
Show the help message.
storage core device purge Removes storage devices which have not been seen in some time interval. --force or -f
Purge the LUNs that are not in active state.
--interval or -i
Timeout interval (in days) for storage device removal. If a storage device has not been seen for the specified number of days, it will be removed. If not specified, the advanced setting ‘/Scsi/LunCleanupInterval’ will be used (see esxcli system settings advanced list and esxcli system settings advanced set).
--help
Show the help message.
storage core device set Provide control to allow a user to modify a SCSI device’s state. --data-integrity-enabled or -I
Enable / Disable device data integrity 0 -> Protection disabled 1 -> Protection enabled.Please refer to ESX release notes for more Information
--default-name or -D
Set the default display name for the device. If there is an existing user defined name it will be changed.
--device or -d
The device upon which to operate. This can be any of the UIDs that a device reports. (required)
--force or -f
Force the device state to be set.
--led-duration or -L
Set the duration of LED in seconds. If not specified, use maximum duration that hardware can support.--led-state or -lSet the disk LED state. Valid values are: error: Turn on error LED. locator: Turn on locator LED. off: Turn off LED.
--max-queue-depth or -m
Set device’s max queue depth.
--name or -n
The new name to assign the given device.
--no-persist or -N
Set device state non-persistently; state is lost after reboot.
--queue-full-sample-size or -s
Set device’s queue full sample size. IO samples to monitor for detecting non-transient queue full condition. Should be non zero to enable queue depth throttling.
--queue-full-threshold or -q
Set device’s queue full threshold. BUSY or QFULL threshold,upon which LUN queue depth will be throttled. Should be <= queue-full-sample-size if throttling is enabled.
--sched-num-req-outstanding or -O
Set number of outstanding IOs with competing worlds.
--state
Set the SCSI device state for the specific device given. Valid values are : off: Set the device’s state to OFF. on: Set the device’s state to ON.
--write-cache-enabled or -w
Set device’s write cache state.
--help
Show the help message.
storage core device setconfig Set device configuration --detached
Mark device as detached.
--device or -d
The device upon which to operate. This can be any of the UIDs that a device reports. (required)
--perennially-reserved
Mark device as perennially reserved.
--shared-clusterwide
Mark device as not shared clusterwide.
--help
Show the help message.
storage core device capacity list List capacity information for the known storage devices. --device or -d
Limit the output to a specific device.
--help
Show the help message.
storage core device detached list Lists all devices that were detached manually by changing their state on the system. --device or -d
Filter the output of the command to limit the output to a specific device.
--help
Show the help message.
storage core device detached remove Provide control to allow a user to remove Detached devices from the persistent detached device list. --all or -a
If set, all devices will be removed from the Detached Device List.--device or -d
Select the detached device to remove from the Detached Device List.
--help
Show the help message.
storage core device inquirycache list List inquiry cache information for the known storage devices. --device or -d
Limit the output to a specific device.
--help
Show the help message.
storage core device inquirycache set Manipulate inquiry cache settings of storage devices. --apply-all
Operate on all existing devices.
--device or -d
NAA ID of the device upon which to operate.
--ignore
Ignore device inquiry cache. (required)
--help
Show the help message.
storage core device latencythreshold list List latency sensitive threshold for the known storage devices. --device or -d
Limit the output to a specific device.
--help
Show the help message.
storage core device latencythreshold set Set latency sensitive threshold for devices. This option is applicable only for devices claimed by HPP. 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. --device or -d
Select the device by its device name.
--latency-sensitive-threshold or -t
Set device’s latency sensitive threshold (in milliseconds). If IO latency exceeds the threshold, new IOs will use the default IO scheduler. (required)
--model or -m
Select the devices based on model in addition to its vendor. Select by model prefix if the value ends with ‘‘. Only valid with option –vendor.
--nvme-controller-model or -c
Select the NVMe devices based on NVMe controller model. Select by NVMe controller model prefix if the value ends with ‘
‘. Controller model for a NVMe device can be found in ‘Model’ field under ‘storage core device list’ output.
--pci-sub-vendor-id or -s
Select the devices based on PCI sub vendor ID in addition to its PCI vendor ID. This is a hexadecimal number without leading ‘0x’.
--pci-vendor-id or -p
Select the devices based on PCI vendor ID. This is a hexadecimal number without leading ‘0x’. –pci-sub-vendor-id can be specified with this option
--vendor or -v
Select the devices based on vendor. Select by vendor prefix if the value ends with ‘*’. –model can be specified along with this option.
--help
Show the help message.
storage core device partition list For a given device list all of the partitions --device or -d
Filter the output to a specific device.
--help
Show the help message.
storage core device partition showguid For a given device list the GUID for GPT partitions --device or -d
Filter the output to a specific device.
--help
Show the help message.
storage core device physical get Get information about a physical storage device. --device or -d
Specify a device name. (required)
--help
Show the help message.
storage core device raid list List the physical devices that compose a given logical device. --device or -d
Specify a device name. (required)
--help
Show the help message.
storage core device smart get List Smart device parameters. --device-name or -d
The Smart device name (required)
--help
Show the help message.
storage core device smart daemon start Enable smartd. --help
Show the help message.
storage core device smart daemon stop Disable smartd. --help
Show the help message.
storage core device smart daemon status get Get status of smartd. --help
Show the help message.
storage core device smart status get Get status of SMART stats on a device. --device-name or -d
The SMART device name. (required)
--help
Show the help message.
storage core device smart status set Enable or disable SMART stats gathering on a device. --device-name or -d
The SMART device name. (required)
--enabled or -e
Enable or disable SMART stats gathering. (required)
--help
Show the help message.
storage core device stats get List the SCSI stats for SCSI Devices in the system. --device or -d
Limit the stats output to one specific device. This device name can be any of the UIDs the device reports
--help
Show the help message.
storage core device uidmap list Get a mapping between a device’s primary UID and the alternative UIDs for that device on the system. --device or -d
Filter the output of the command to limit the output to a specific device. This device name can be any of the UIDs registered for a device.
--help
Show the help message.
storage core device vaai ats list List the ATS VAAI attributes (as per SCSI standard) for the devices. --device or -d
Filter the output of this command to only show a single device.
--help
Show the help message.
storage core device vaai clone list List the Clone VAAI attributes (as per SCSI standard) for the devices. --device or -d
Filter the output of this command to only show a single device.
--helpShow the help message.
storage core device vaai delete list List the Delete VAAI attributes (as per SCSI standard) for the devices. --device or -d
Filter the output of this command to only show a single device.
--helpShow the help message.
storage core device vaai status get List VAAI properties for devices currently registered with the PSA. --device or -d
Filter the output of this command to only show a single device.
--help
Show the help message.
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.) --ats or -A
Enable or Disable ATS operation (1/0)
--clone or -C
Enable or Disable CLONE operation (1/0)
--delete or -D
Enable or Disable DELETE operation (1/0)
--device or -d
The device upon which to operate (NAA ID). (required)
--zero or -Z
Enable or Disable ZERO operation (1/0)
--help
Show the help message.
storage core device vaai zero list List the Zero VAAI attributes (as per SCSI standard) for the devices. --device or -d
Filter the output of this command to only show a single device.
--help
Show the help message.
storage core device world list Get a list of the worlds that are currently using devices on the ESX host. --device or -d
Filter the output of the command to limit the output to a specific device. This device name can be any of the UIDs registered for a device.
--help
Show the help message.
storage core path list List all the SCSI paths on the system. --device or -d
Limit the output to paths to a specific device. This name can be any of the UIDs for a specific device.
--path or -p
Limit the output to a specific path. This name can be either the UID or the runtime name of the path.
--help
Show the help message.
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 SCSI 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. --path or -p
Select the path to set path state on. This can be a Runtime Name or Path UID (required)
--state
Set the SCSI path state for the specific path given. Valid values are : active: Set the path’s state to active. This may be immediately changed by the system to another state if the active state is not appropriate. off: Administratively disable this path. (required)
--help
Show the help message.
storage core path stats get List the SCSI stats for the SCSI Paths in the system. --path or -p
Limit the stats output to one specific path. This path name can be the runtime name or the path UID.
--help
Show the help message.
storage core plugin list List loaded PSA plugins on the system. --plugin-class or -N
Indicate the class of plugin to limit the list to. Allowed values are : Filter: Filter plugins MP: MultiPathing plugins VAAI: VAAI plugins all: All PSA Plugins (default)
--help
Show the help message.
storage core plugin registration add Register a plugin module with PSA. --dependencies or -d
Add the [optional] dependencies for this module to loaded
--full-path or -I
Add the [optional] full path to this module
--module-name or -m
Select the module name to be registered (required)
--plugin-class or -N
Indicate the class of plugin to register. Allowed values are MP, VAAI or MPP defined subplugins like PSP, SATP. (required)
--plugin-name or -P
Select the plugin name to be registered (required)
--help
Show the help message.
storage core plugin registration list List modules currently registered with PSA. --module-name or -m
Filter the output of this command to only show a single module.--plugin-class or -N
Indicate the class of plugin to list. Allowed values are MP, VAAI or MPP defined subplugins like PSP, SATP.
--help
Show the help message.
storage core plugin registration remove UnRegister a plugin module with PSA. --module-name or -m
Select the module name to be unregistered (required)
--help
Show the help message.
storage filesystem automount Request mounting of known datastores not explicitly unmounted. --help
Show the help message.
storage filesystem list List the volumes available to the host. This includes VMFS, NAS, VFAT and UFS partitions. --ignore-errors or -i
Ignore errors encountered (if any) while retrieving information for each file system.
--uuid or -u
Only show information for the filesystem with the specified UUID.
--help
Show the help message.
storage filesystem mount Connect to and mount an unmounted volume on the ESX host. --no-persist or -n
Mount the volume non-persistently; the volume will not be mounted after a restart.
--volume-label or -lThe label of the volume to mount. This volume must be unmounted for this operation to succeed.
--volume-uuid or -u
The UUID of the VMFS filesystem to mount. This volume must be unmounted for this operation to succeed.
--help
Show the help message.
storage filesystem rescan Scan storage devices for new mountable filesystems. --help
Show the help message.
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. --no-persist or -n
Unmount the volume non-persistently; the volume will be automounted after a restart.
--unmount-all-vmfs or -a
Unmount all vmfs volumes.
--volume-label or -l<br>The label of the volume to unmount.
--volume-path or -p
The path of the volume to unmount.
--volume-uuid or -u
The uuid of the volume to unmount.
--help
Show the help message.
storage hpp device list List the devices currently controlled by the VMware High Performance Plugin. --device or -d
Filter the output of this command to only show a single device.
--help
Show the help message.
storage hpp device set Configure settings for an HPP device. --bytes or -B
Maximum bytes on the path after which the path will be switched.
--cfg-file
Update the config file and runtime with the new setting. In case device is claimed by another PSS, ignore any errors when applying to runtime configuration.
--device or -d
The HPP device upon which to operate. This can be any of the UIDs that a device reports. (required)
--iops or -I
Maximum IOPS on the path after which the path will be switched.
--latency-eval-time or -T
Interval at which the latency of paths is evaluated (in ms).
--mark-device-ssd or -M
Set whether or not HPP should treat the device as an SSD.
--path or -p
The path you wish to set as the preferred path for the given device.--pss or -P
The path selection scheme you wish to assign to the given device. One of the following options can be specified as input. Default values will be chosen for unspecified options. FIXED: Fixed path is chosen for the I/Os. Preferred path can be specified using –path option. LB-BYTES: Load Balance - Bytes scheme selects optimal path having least outstanding bytes. –bytes option can be specified as input. LB-IOPS: Load Balance - IOPS scheme selects optimal path having least outstanding I/Os. –iops option can be specified as input. LB-Latency: Load Balance - Latency scheme selects optimal path having least latency. –latency-eval-time and/or –sampling-ios-per-path options can be specified as input. LB-RR: [Default] Load Balance - Round Robin scheme chooses path in round robin manner based on IOPS and bytes count. –iops and/or –bytes options can be specified as input. This is the default path selection scheme for the device. default: Default scheme[LB-RR] for the device.
--sampling-ios-per-path or -S
Number of I/Os to be issued on each path to calculate the latency on the path
--help
Show the help message.
storage hpp device usermarkedssd list List the devices that were marked as SSD by user. --device or -d
Filter the output of the command to limit the output to a specific device.
--help
Show the help message.
storage hpp path list List the paths currently claimed by the VMware High Performance Plugin --device or -d
Filter the output of this command to only show info for a single device.
--path or -p
Filter the output of this command to only show a single path.
--help
Show the help message.
storage iofilter enable Enable an iofilter. --filter or -f
Name of the iofilter. (required)
--help
Show the help message.
storage iofilter list List the iofilters installed on this host. --filter or -f
Filter the output of this command to only show a single iofilter.
--help
Show the help message.
storage nfs add Add a new NAS volume to the ESX Host and mount it with the given volume name. --host or -H
The hostname or IP address of the NAS volume to add and mount on the system. (required)
--ispe or -p
If set this flag will set the mount point to be PE.
--readonly or -r
If set this flag will set the mount point to be read-only.
--share or -s
The share name on the remote system to use for this NAS mount point. (required)
--volume-name or -v
The volume name to use for the NAS mount. This must be a unique volume name and cannot conflict with existing NAS, VMFS or other volume names. (required)
--help
Show the help message.
storage nfs list List the NAS volumes currently known to the ESX host. --pe-only or -p
Filter the output to only show VVol PE volumes
--help
Show the help message.
storage nfs remove Remove an existing NAS volume from the ESX host. --volume-name or -v
The volume name of the NAS volume to remove from the ESX host. (required)
--help
Show the help message.
storage nfs param get Get the volume parameters of the NAS volumes. --volume-name or -v
NAS volume name(“all” to list all). (required)
--help
Show the help message.
storage nfs param set Set the volume parameters of the NAS volumes. --maxqueuedepth or -q
The maximum queue depth for the NAS volume.
--volume-name or -v
The NAS volume name. (required)
--help
Show the help message.
storage nfs41 add Add a new NFS v4.1 volume to the ESX Host and mount it with the given volume name. --hosts or -H
The hostname(s) or IP address(es) (comma-separated) of the server for the NFS v4.1 volume to add and mount on the system. (required)
--ispe or -p
If set, this flag will set the mount point to be PE.
--readonly or -r
If set, this flag will make the mount point be read-only.
--sec or -a
Security flavors. Acceptable values are: [AUTH_SYS, SEC_KRB5, SEC_KRB5I].
--share or -s
The share name on the remote system to use for this NFS v4.1 mount point. (required)
--volume-name or -v
The volume name to use for the NFS v4.1 mount. This must be a unique volume name and cannot conflict with existing NAS, NFS v4.1, VMFS, or other volume names. (required)
--help
Show the help message.
storage nfs41 list List the NFS v4.1 volumes currently known to the ESX host. --pe-only or -p
Filter the output to only show VVol PE Volumes
--help
Show the help message.
storage nfs41 remove Remove an existing NFS v4.1 volume from the ESX host. --volume-name or -v
The volume name of the NFS v4.1 volume to remove from the ESX host. (required)
--help
Show the help message.
storage nfs41 param get Get the volume parameters of the NFS v4.1 volumes. --volume-name or -v
NFS v4.1 volume name(“all” to list all). (required)
--help
Show the help message.
storage nfs41 param set Set the volume parameters of the NFS v4.1 volumes. --maxqueuedepth or -q
The maximum queue depth for the NFS v4.1 volume.
--volume-name or -v
The NFS v4.1 volume name. (required)
--help
Show the help message.
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. --device or -d
Filter the output of this command to only show a single device.
--help
Show the help message.
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. --default or -E
The Path selection policy is set back to the default for the assigned SATP for this device.
--device or -d
The device you wish to set the Path Selection Policy for. (required)
--psp or -P
The Path selection policy you wish to assign to the given device.
--help
Show the help message.
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. --device or -d
Filter the output of this command to only show paths to a single device.
--path or -p
Filter the output of this command to only show a single path.
--help
Show the help message.
storage nmp psp list List the Path Selection Plugins (PSP) that are currently loaded into the NMP system and display information about those PSPs --help
Show the help message.
storage nmp psp fixed deviceconfig get Allow retrieving of Fixed Path Selection Policy settings for a given device. --device or -d
The device you wish to get the Preferred path for. (required)
--help
Show the help message.
storage nmp psp fixed deviceconfig set Allow setting of the perferred path on a given device controlled by the Fixed Path Selection Policy. --cfgfile or -g
Update the config file and runtime with the new setting. In case device is claimed by another PSP, ignore any errors when applying to runtime configuration.
--default or -E
Clear the preferred path selection for the given device.
--device or -d
The device you wish to set the preferred path for. This device must be controlled by the Fixed Path Selection Policy(except when -g is specified) (required)
--path or -p
The path you wish to set as the preferred path for the given device.
--help
Show the help message.
storage nmp psp generic deviceconfig get Allow retrieving of per device PSP configuration parameters. --device or -d
The device you wish to get PSP configuration for. (required)
--help
Show the help message.
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. --cfgfile or -g
Update the config file and runtime with the new setting. In case device is claimed by another PSP, ignore any errors when applying to runtime configuration.
--config or -c
The configuration string you wish to set. (required)
--device or -d
The device you wish to set PSP configuration for. (required)
--help
Show the help message.
storage nmp psp generic pathconfig get Allow retrieving of per path PSP configuration parameters. --path or -p
The path you wish to get PSP configuration for. (required)
--help
Show the help message.
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. --cfgfile or -g
Update the config file and runtime with the new setting. In case device is claimed by another PSP, ignore any errors when applying to runtime configuration.
--config or -c
The configuration string you wish to set. (required)
--path or -p
The path you wish to set PSP configuration for. (required)
--help
Show the help message.
storage nmp psp roundrobin deviceconfig get Allow retrieving of Round Robin Path Selection Policy settings for a given device. --device or -d
The device you wish to get the Round Robin properties for. (required)
--help
Show the help message.
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. --bytes or -B
When the –type option is set to ‘bytes’ this is the value that will be assigned to the byte limit value for this device.
--cfgfile or -g
Update the config file and runtime with the new setting. In case device is claimed by another PSP, ignore any errors when applying to runtime configuration.
--device or -d
The device you wish to set the Round Robin settings for. This device must be controlled by the Round Robin Path Selection Policy(except when -g is specified) (required)
--iops or -I
When the –type option is set to ‘iops’ this is the value that will be assigned to the I/O operation limit value for this device.
--latency-eval-time or -T
When the –type option is set to ‘latency’ this value can control at what interval (in ms) the latency of paths should be evaluated.
--num-sampling-cycles or -S
When the –type option is set to ‘latency’ this value will control how many sample IOs should be issued on each path to calculate latency of the path.
--type or -t
Set the type of the Round Robin path switching that should be enabled for this device. Valid values for type are: bytes: Set the trigger for path switching based on the number of bytes sent down a path. default: Set the trigger for path switching back to default values. iops: Set the trigger for path switching based on the number of I/O operations on a path. latency: Set the trigger for path switching based on latency and pending IOs on path.
--useano or -U
Set useano to true,to also include non-optimizedpaths in the set of active paths used to issue I/Os on this device,otherwise set it to false
--help
Show the help message.
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 --help
Show the help message.
storage nmp satp set Set the default Path Selection Policy for a given Storage Array Type Plugin (SATP). --boot or -b
This is a system default rule added at boot time. Do not modify esx.conf or add to host profile.
--default-psp or -P
The default path selection policy to set for a given –satp (required)
--satp or -s
The SATP name for the Storage Array Type Plugin on which this command will operate. (required)
--help
Show the help message.
storage nmp satp generic deviceconfig get Allow retrieving of per device SATP configuration parameters. --device or -d
The device you wish to get SATP configuration for. (required)
--exclude-tpg-info or -e
Exclude TPG info from the device’s SATP configuration.
--help
Show the help message.
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. --config or -c
The configuration string you wish to set. (required)
--device or -d
The device you wish to set SATP configuration for.
--help
Show the help message.
storage nmp satp generic pathconfig get Allow retrieving of per path SATP configuration parameters. --path or -p
The path you wish to get SATP configuration for. (required)
--help
Show the help message.
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. --config or -c
The configuration string you wish to set. (required)
--path or -p
The path you wish to set SATP configuration for. (required)
--help
Show the help message.
storage nmp satp rule add Add a rule to the list of claim rules for the given SATP. --boot or -b
This is a system default rule added at boot time. Do not modify esx.conf or add to host profile.
--claim-option or -c
Set the claim option string when adding a SATP claim rule.
--description or -e
Set the claim rule description when adding a SATP claim rule.
--device or -d
Set the device when adding SATP claim rules. Device rules are mutually exclusive with vendor/model and driver rules.
--driver or -D
Set the driver string when adding a SATP claim rule. Driver rules are mutually exclusive with vendor/model rules.
--force or -f
Force claim rules to ignore validity checks and install the rule anyway.
--model or -M
Set the model string when adding SATP a claim rule. Vendor/Model rules are mutually exclusive with driver rules.
--option or -o
Set the option string when adding a SATP claim rule.
--psp or -P
Set the default PSP for the SATP claim rule.
--psp-option or -O
Set the PSP options for the SATP claim rule.
--satp or -s
The SATP for which a new rule will be added. (required)
--transport or -R
Set the claim transport type string when adding a SATP claim rule.
--type or -t
Set the claim type when adding a SATP claim rule.
--vendor or -V
Set the vendor string when adding SATP claim rules. Vendor/Model rules are mutually exclusive with driver rules.
--help
Show the help message.
storage nmp satp rule list List the claiming rules for Storage Array Type Plugins (SATP) --satp or -s
Filter the SATP rules to a specific SATP
--help
Show the help message.
storage nmp satp rule remove Delete a rule from the list of claim rules for the given SATP. --boot or -b
This is a system default rule added at boot time. Do not modify esx.conf or add to host profile.
--claim-option or -c
The claim option string for the SATP claim rule to delete.
--description or -e
The desription string for the SATP claim rule to delete.
--device or -d
The device for the SATP claim rule to delete
--driver or -D
The driver string for the SATP claim rule to delete.
--force or -f
Ignore validity checks and remove the rule anyway.
--model or -M
The model string for the SATP claim rule to delete.
--option or -o
The option string for the SATP claim rule to delete.
--psp or -P
The default PSP for the SATP claim rule to delete.
--psp-option or -O
The PSP options for the SATP claim rule to delete.
--satp or -s
The SATP for which a rule will be deleted. (required)
--transport or -R
The transport type for the SATP claim rule to delete.
--type or -t
Set the claim type when adding a SATP claim rule.
--vendor or -V
The vendor string for the SATP claim rule to delete
--help
Show the help message.
storage san fc list List attributes of all FC adapters on the system. --adapter or -A
FC adapter name (vmhbaX), or none, to list all.
--help
Show the help message.
storage san fc reset Perform LIP (Loop Initiation Primitive) Reset to a given FC adapter on the system. --adapter or -A
Issue LIP Reset command to given Fibre Channel HBA. (required)
--help
Show the help message.
storage san fc events clear Clear events for a given FC adapter on the system. --adapter or -A
Issue Clear Event command to specified Fibre Channel HBA. (required)
--help
Show the help message.
storage san fc events get Get Events for FC Devices --adapter or -A
FC adapter name (vmhbaX), or none, to retrieve all.
--help
Show the help message.
storage san fc stats get Get statistics for a given FC adapter, or all FC adapters on the system. --adapter or -A
FC adapter name (vmhbaX), or none, to list all.
--help
Show the help message.
storage san fcoe list List attributes of all FCoE adapters on the system. --adapter or -A
FCoE adapter name (vmhbaX), or none, to list all.
--help
Show the help message.
storage san fcoe reset Perform LIP (Loop Initiation Primitive) Reset to a given FCoE adapter on the system. --adapter or -A
Issue LIP Reset command to given hba. (required)
--help
Show the help message.
storage san fcoe stats get Get statistics for a given FCoE adapter, or all FCoE adapters on the system. --adapter or -A
FCoE adapter name (vmhbaX), or none, to list all.
--help
Show the help message.
storage san iscsi list List attributes of all Software iSCSI adapters on the system. --adapter or -A
iSCSI adapter name (vmhbaX), or none, to list all.
--help
Show the help message.
storage san iscsi stats get Get statistics for Software iSCSI adapter. --adapter or -A
iSCSI device name (vmhbaX), or none, to list all.
--help
Show the help message.
storage san sas list List all SAS IO Device Management devices. --adapter or -A
SAS adapter name (vmhbaX), or none, to list all.
--help
Show the help message.
storage san sas reset Perform SAS Reset --adapter or -A
Issue Reset command to given hba. (required)
--help
Show the help message.
storage san sas stats get List Stats for given device, or all devices. --adapter or -A
SAS adapter name (vmhbaX), or none, to list all.
--fail-on-error or -F
Do not ignore errors when fetching stats for all devices.
--help
Show the help message.
storage vflash device list List vflash SSD devices. --eligible or -e
List the eligible / ineligible SSD devices for vflash.
--used or -u
List the used / unused SSD devices for vflash.
--help
Show the help message.
storage vflash module get Get vflash module info. --module-name or -m

The vflash module name
--help
Show the help message.
storage vflash module list List vflash modules. --help
Show the help message.
storage vflash module stats get Get vflash module statistics --module-name or -m
The vflash module name
--help
Show the help message.
storage vmfs unmap Reclaim the space by unmapping free blocks from VMFS Volume --reclaim-unit or -n
Number of VMFS blocks that should be unmapped per iteration.
--volume-label or -l
The label of the VMFS volume to unmap the free blocks.
--volume-uuid or -u
The uuid of the VMFS volume to unmap the free blocks.
--help
Show the help message.
storage vmfs upgrade Upgrade a VMFS3 volume to VMFS5. --volume-label or -l
The label of the VMFS volume to upgrade.
--volume-uuid or -u
The uuid of the VMFS volume to upgrade.
--help
Show the help message.
storage vmfs extent list List the VMFS extents available on the host. --ignore-errors or -i
Ignore errors encountered (if any) while retrieving information for each file system.
--help
Show the help message.
storage vmfs host list List hosts accessing a particular VMFS Volume. --liveness or -v
The type of liveness check to perform on the VMFS volume. Valid values are [none, quick] (default is none).
--volume-label or -l
The label of the target VMFS volume.
--volume-uuid or -u
The uuid of the target VMFS volume.
--help
Show the help message.
storage vmfs lockmode list List the on-disk critical section locking mode for VMFS volumes available on this host. --ignore-errors or -i
Ignore errors encountered (if any) while retrieving information for each file system.
--volume-label or -l
The label of the target VMFS volume.
--volume-uuid or -u
The uuid of the target VMFS volume.
--help
Show the help message.
storage vmfs lockmode set Update the on-disk critical section locking mode for a particular VMFS Volume. --ats or -a
Enable ATS-only locking.
--scsi or -s
Enable SCSI locking.
--volume-label or -l
The label of the target VMFS volume.
--volume-uuid or -u
The uuid of the target VMFS volume.
--help
Show the help message.
storage vmfs pbcache get Get VMFS Pointer Block cache statistics. --help
Show the help message.
storage vmfs pbcache reset Reset the VMFS Pointer Block cache statistics. --help
Show the help message.
storage vmfs reclaim config get Get space reclamation configuration parameters --volume-label or -l
The label of the target VMFS volume.
--volume-uuid or -u
The uuid of the target VMFS volume.
--help
Show the help message.
storage vmfs reclaim config set Set space reclamation configuration parameters --reclaim-bandwidth or -b
Space reclamation fixed bandwidth (MB/s)
--reclaim-granularity or -g
Minimum granularity of automatic space reclamation in bytes
--reclaim-method or -m
Method of automatic space reclamation. Supported options are [priority, fixed].
--reclaim-priority or -p
Priority of automatic space reclamation. Supported options are [none, low, medium, high].
--volume-label or -l
The label of the target VMFS volume.
--volume-uuid or -u
The uuid of the target VMFS volume.
--help
Show the help message.
storage vmfs snapshot list List unresolved snapshots/replicas of VMFS volume. --volume-label or -l
The VMFS volume label of the snapshot to list.
--volume-uuid or -u
The VMFS volume uuid of the snapshot to list.
--help
Show the help message.
storage vmfs snapshot mount Mount a snapshot/replica of a VMFS volume. --no-persist or -n
Mount the volume non-persistently; the volume will not be automounted after a restart.
--volume-label or -l
The VMFS volume label of the snapshot to mount.
--volume-uuid or -u
The VMFS volume uuid of the snapshot to mount.
--help
Show the help message.
storage vmfs snapshot resignature Resignature a snapshot/replica of a VMFS volume. --volume-label or -l
The VMFS volume label of the snapshot to resignature.
--volume-uuid or -u
The VMFS volume uuid of the snapshot to resignature.
--help
Show the help message.
storage vmfs snapshot extent list List extents of unresolved snapshots/replicas of VMFS volume. --volume-label or -l
The VMFS volume label of the target snapshot to enumerate.
--volume-uuid or -u
The VMFS volume uuid of the target snapshot to enumerate.
--help
Show the help message.
storage vvol daemon unbindall Unbind all Virtual Volumes from all VASA Providers known to this host. --help
Show the help message.
storage vvol protocolendpoint list List the VVol Protocol EndPoints currently known to this host. --pe or -p
Show Protocol Endpoint (PE) information associated with the given VASA PE ID.
--pe-type or -t
PE type to display. Acceptable values are: [SCSI, NFS, NFS4x].
--help
Show the help message.
storage vvol storagecontainer list List VVol storage containers known to this host. --help
Show the help message.
storage vvol storagecontainer abandonedvvol scan Scans the specified storage container for abandoned VVols. --path or -p
Path to VVol Storage Container to scan. (required)
--help
Show the help message.
storage vvol vasacontext get Get the VVol VASA Context (vCenter UUID). --help
Show the help message.
storage vvol vasaprovider list List the VASA Providers registered on this host. --help
Show the help message.

esxcli system Commands

COMMAND DESCRIPTION OPTIONS HELP
system account add Create a new local user account. --description or -d
User description, e.g. full name.
--id or -i
User ID, e.g. “administrator”. (required)
--password or -p
User password. (secret)
--password-confirmation or -c
Password confirmation. Required if password is specified. (secret)
--help
Show the help message.
system account list List local user accounts. --help
Show the help message.
system account remove Remove an existing local user account. --id or -i
ID of user to be removed. (required)
--help
Show the help message.
system account set Modify an existing local user account. --description or -d
User description, e.g. full name.
--id or -i
User ID, e.g. “administrator”. (required)
--password or -p
User password. (secret)
--password-confirmation or -c
Password confirmation. Required if password is specified. (secret)
--help
Show the help message.
system auditrecords get Information about audit record recording. --help
Show the help message.
system auditrecords local disable Disable audit record recording. --help
Show the help message.
system auditrecords local enable Enable audit record recording. --directory
The audit log directory.
--help
Show the help message.
system auditrecords local set Configure audit record recording. --directory
The audit log directory.
--size
The size of the audit log (in KiB). (required)
--help
Show the help message.
system auditrecords remote disable Disable audit record handling for remote hosts. --help
Show the help message.
system auditrecords remote enable Enable audit record handling for remote hosts. --directory
The audit log directory.
--help
Show the help message.
system boot device get Get the systems boot device. --help
Show the help message.
system clock get Display the current system clock parameters. --help
Show the help message.
system clock set Set system clock parameters. --max-neg-phase or -n
max negative phase correction
--max-phase-corrections or -m
max number of phase corrections
--max-pos-phase or -p
max positive phase correction
--help
Show the help message.
system coredump file add Create a VMkernel Dump VMFS file for this system. --auto or -a
Automatically create a file if none found and autoCreateDumpFile kernel option is set.--datastore or -d
Manually specify the datastore the Dump File is created in. If not provided, a datastore of sufficient size will be automatically chosen.
--enable or -e
Enable diagnostic file after creation.
--file or -f
Manually specify the file name of the created Dump File. If not provided, a unique name will be chosen.
--size or -s
Manually set the size in MB of the created Dump File. If not provided, a default size for the current machine will be calculated.
--help
Show the help message.
system coredump file get Get the dump file path. This command will print the path to the active and/or configured VMFS Dump File. --help
Show the help message.
system coredump file list List the active and configured VMFS Diagnostic Files. --help
Show the help message.
system coredump file remove Remove a VMkernel Dump VMFS file from this system. --file or -f
Specify the file name of the Dump File to be removed. If not given, the configured dump file will be removed.
--force or -F
Deactivate and unconfigure the dump file being removed. This option is required if the file is active.--help
Show the help message.
system coredump file set Set the active and configured VMkernel Dump VMFS file for this system. --enable or -e
Enable or disable the VMkernel dump file. This option cannot be specified when unconfiguring the dump file.
--path or -p
The path of the VMFS Dump File to use. This must be a pre-allocated file.
--smart or -s
This flag can be used only with –enable=true. It will cause the file to be selected using the smart selection algorithm.
--unconfigure or -u
Unconfigure the current VMFS Dump file.
--help
Show the help message.
system coredump network check Check the status of the configured network dump server --help
Show the help message.
system coredump network get Get the currently configured parameters for network coredump, if enabled. --help
Show the help message.
system coredump network set Set the parameters used for network core dump --enable or -e
Enable network dump. This option cannot be specified when setting the dump parameters below.
--interface-name or -v
An active interface to be used for the network core dump. Required option when setting dump parameters.
--server-ip or -j
IP address of the core dump server (IPv4 or IPv6). Required when setting dump parameters.
--server-ipv4 or -i
IPv4 address of the core dump server.(deprecated, use -j|–server-ip instead)
--server-port or -o
Port on which the core dump server is listening. (Optional)
--help
Show the help message.
system coredump partition get Get 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. --help
Show the help message.
system coredump partition list List 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. --help
Show the help message.
system coredump partition set Set 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. --enable or -e
Enable or disable the VMkernel dump partition. This option cannot be specified when setting or unconfiguring the dump partition.
--partition or -p
The name of the partition to use. This should be a device name with a partition number at the end. Example: naa.xxxxx:1
--smart or -s
This flag can be used only with –enable=true. It will cause the best available partition to be selected using the smart selection algorithm.
--unconfigure or -u
Set the dump partition into an unconfigured state. This will remove the current configured dump partition for the next boot. This will result in the smart activate algorithm being used at the next boot.
--helpShow the help message.
system hostname get Get the host, domain or fully qualified name of the ESX host. --help
Show the help message.
system hostname set This command allows the user to set the hostname, domain name or fully qualified domain name of the ESX host. --domain or -d
The domain name to set for the ESX host. This option is mutually exclusive with the –fqdn option.
--fqdn or -f
Set the fully qualified domain name of the ESX host.
--host or -H
The host name to set for the ESX host. This name should not contain the DNS domain name of the host and can only contain letters, numbers and ‘-‘. NOTE this is not the fully qualified name, that can be set with the –fqdn option. This option is mutually exclusive with the –fqdn option.
--help
Show the help message.
system maintenanceMode get Get the maintenance mode state of the system. --help
Show the help message.
system maintenanceMode set Enable or disable the maintenance mode of the system. --enable or -e
Maintenance mode state. (required)
--timeout or -t
Timeout in seconds to wait for entering the new state. Zero (default) means no timeout. The host will enter maintenance mode when there are no running virtual machines on the host. The user is required to power off or evacuate them. Exiting maintenance mode is done when there are no running mainenance operations.
--vsanmode or -m
Action the VSAN service must take before the host can enter maintenance mode (default ensureObjectAccessibility). Allowed values are: ensureObjectAccessibility: Evacuate data from the disk to ensure object accessibility in the vSAN cluster, before entering maintenance mode. evacuateAllData: Evacuate all data from the disk before entering maintenance mode. noAction: Do not move vSAN data out of the disk before entering maintenance mode.
--help
Show the help message.
system module get Show information for a VMkernel module. --module or -m
The name of the VMkernel module. (required)
--help
Show the help message.
system module list List the VMkernel modules that the system knows about. --enabled or -e
List the enabled / disabled VMkernel modules and device drivers.
--loaded or -l
List the loaded / not loaded VMkernel modules and device drivers.
--help
Show the help message.
system module load Load 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. --force or -f
Ignore the enabled/disabled state of this module and force it to load.
--module or -m
The name of the VMkernel module to load. (required)
--help
Show the help message.
system module set Allow enabling and disabling of a VMkernel module. --enabled or -e
Set to true to enable the module, set to false to disable the module. (required)
--force or -f
Skip VMkernel module validity checks and set options for a module (or alias) with the given name.
--module or -m
The name of the VMkernel module to set options for. (required)
--help
Show the help message.
system module parameters clear Clear the load time parameters for a given VMkernel module. --module or -m
The name of the VMkernel module to clear parameters for. (required)
--help
Show the help message.
system module parameters copy Copy the load time parameters from one VMkernel module to another. --force or -f
Skip VMkernel module validity checks for the source VMkernel module.
--parameter-keys or -p
Parameter key that should get copied. (required)
--source or -s
The name of the source VMkernel module. (required)
--target or -t
The name of the target VMkernel module. (required)--help
Show the help message.
system module parameters list List the parameters, a descriptions of each parameter supported for a given module name and the user defined value for each parameter. --module or -m
The name of the VMkernel module to get the option string for. (required)
--help
Show the help message.
system module parameters set Set the load time parameters for the given VMkernel module. --append or -a
Append the specified parameter string to the currently configured parameter string for the VMkernel module. If –append is not specified, the parameter string currently configured for the VMkernel module will be replaced by the specified parameter string.
--force or -f
Skip VMkernel module validity checks and set parameters for a module (or alias) with the given name.
--module or -m
The name of the VMkernel module to set parameters for. (required)
--parameter-string or -p
The string containing the parameters for this module. (required)
--help
Show the help message.
system ntp get Display Network Time Protocol configuration --help
Show the help message.
system ntp set Configures the ESX Network Time Protocol agent. --enabled or -e
Start or stop ntpd. Values: [yes|no, true|false, 0|1]
--loglevel or -l
Syslog logging level: debug: Most detailed logging level. error: Least detailed logging, Reports only errors. info: Reports normal actions in addition to warnings, events. warning: Reports only warnings or errors.
--reset or -r
Restore the NTP configuration to factory defaults.
--server or -s
Provide one or more NTP servers as a fully qualified domain name or IP address.
--help
Show the help message.
system ntp config get Display Network Time Protocol configuration. --help
Show the help message.
system permission list List permissions defined on the host. --help
Show the help message.
system permission set Set permission for a user or group. --group or -g
Specifies that the supplied ID refers to a group. ESXi local groups are not supported.
--id or -i
ID of user or group. Domain users or groups should be specified as “DOMAIN\user_name” or “DOMAIN\group_name”. (required)
--role or -r
Name of role that specifies user access rights. Admin: Full access rights NoAccess: Used for restricting granted access. E.g. to deny access for some user whose group already has access. ReadOnly: See details of objects, but not make changes (required)
--help
Show the help message.
system permission unset Remove permission for a user or group. --group or -g
Specifies that the supplied ID refers to a group.
--id or -i
ID of user or group. (required)
--help
Show the help message.
system process list List the VMkernel UserWorld processes currently on the host. --help
Show the help message.
system process stats load get System load average over the last 1, 5 and 15 minutes. --help
Show the help message.
system process stats running get Number of currently running processes. --help
Show the help message.
system ptp get Display Precision Time Protocol configuration --help
Show the help message.
system ptp set Configures the ESX Precision Time Protocol agent. --enabled or -e
Start or stop ptpd. Values: [yes|no, true|false, 0|1]
--loglevel or -l
Syslog logging level: [debug, info, warning, error]
--reset or -r
Restore the PTP configuration to factory defaults
--help
Show the help message.
system ptp stats get Report operational state of Precision Time Protocol Daemon --help
Show the help message.
system secpolicy domain list List the enforcement level for each domain. --help
Show the help message.
system secpolicy domain set Set 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. --all-domains or -a
All domains.
--level or -l
The enforcement level. (required)
--name or -n
The domain name.
--help
Show the help message.
system security certificatestore add Add a new CA certificate to the CA certificate store. --filename or -f
Absolute path to certificate file in PEM format, located on the ESXi host. (required)
--help
Show the help message.
system security certificatestore list List all certificates in the CA certificate store. --help
Show the help message.
system security certificatestore remove Remove a certificate from the CA certificate store. --filename or -f
Absolute path to the file in PEM format, located on the ESXi host, describing the certificate to be removed.
--issuer or -i
Issuer name of the certificate to be removed. Also requires –serial.
--serial or -s<br>
Serial number of the certificate to be removed. Also requires –issuer.
--help
Show the help message.
system security fips140 rhttpproxy get Get FIPS140 mode of rhttpproxy. --help
Show the help message.
system security fips140 rhttpproxy set Set FIPS140 mode of rhttpproxy. --enable or -e
Enable/disable FIPS140 mode for rhttpproxy. (required)
--help
Show the help message.
system security fips140 ssh get Get FIPS140 mode of ssh. --help
Show the help message.
system security fips140 ssh set Set FIPS140 mode of ssh. --enable or -e
Enable/disable FIPS140 mode for ssh. (required)
--help
Show the help message.
system settings advanced add Add a user defined advanced option to the /UserVars/ advanced option tree. --description or -d
Description of the new option. (required)
--hidden or -H
Whether the option is hidden.
--int-default or -i
The default value of the new option (integer option only, required).
--max or -M
The maximum allowed value (integer option only, required).
--min or -m
The minimum allowed value (integer option only, required).
--option or -o
The name of the new option. Valid characters: letters, digits and underscore. (required)--string-default or -s
The default value of the new option (string option only). An empty string is assumed if not specified.
--type or -t
The type of the new option. Supported values: integer: Advanced option with integer value. string: Advanced option with string value. (required)
--help
Show the help message.
system settings advanced list List the advanced options available from the VMkernel. --delta or -d
Only display options whose values differ from their default.
--option or -o
Only get the information for a single VMkernel advanced option.
--tree or -t
Limit the list of advanced option to a specific sub tree.
--help
Show the help message.
system settings advanced remove Remove a user defined advanced option from the /UserVars/ advanced option tree. --option or -o
The name of the option to remove (without the /UserVars/ prefix as it is implied). (required)
--help
Show the help message.
system settings advanced set Set the value of an advanced option. --default or -d
Reset the option to its default value.
--int-value or -i
If the option is an integer value use this option.
--option or -o
The name of the option to set the value of. Example: “/Misc/HostName” (required)
--string-value or -s
If the option is a string use this option.
--help

Show the help message.
system settings kernel list List VMkernel kernel settings. --delta or -d
Only display options whose values differ from their default.
--option or -o
The name of the VMkernel kernel setting to get.
--help
Show the help message.
system settings kernel set Set a VMKernel setting. --setting or -s
The name of the VMKernel setting to set. (required)
--value or -v
The value to set the setting to. (required)
--help
Show the help message.
system settings keyboard layout get Get the keyboard layout --help
Show the help message.
system settings keyboard layout list List the keyboard layout --help
Show the help message.
system settings keyboard layout set Set the keyboard layout --layout or -l
The name of the layout to set
--no-persist
Only apply this layout for the current boot
--help
Show the help message.
system shutdown poweroff Power off the system. The host must be in maintenance mode. --delay or -d
Delay interval in seconds
--reason or -r
Reason for performing the operation (required)
--help
Show the help message.
system shutdown reboot Reboot the system. The host must be in maintenance mode. --delay or -d
Delay interval in seconds
--reason or -r
Reason for performing the operation (required)
--help
Show the help message.
system slp search Perform SLP search for neighboring services --node or -n
Optional, host FQDN or IP address to connect to. Use -P to control protocol used.
--port or -p
Optional, override the default port value 427.
--protocol or -P
Optional, override unicast protocol: [tcp, udp], default tcp, requires -n.
--service or -s
Optional, the service name to search for. Defaults to ‘service-agent’.
--help
Show the help message.
system slp stats get Report operational state of Service Location Protocol Daemon --help
Show the help message.
system snmp get Get SNMP Agent configuration --help
Show the help message.
system snmp hash Generate localized hash values based on this agents snmp engine id. --auth-hash or -A
Secret to use when generating authentication hash. This should be a filename unless –raw-secret is specified. The authentication hash is used in the –users option of ‘esxcli system snmp set’ (required secret)
--priv-hash or -X
Secret to use when generating privacy hash. This should be a filename unless –raw-secret is specified. The privacy hash is used in the –users option of ‘esxcli system snmp set’. (secret)
--raw-secret or -r
Make –auth-hash and –priv-hash options read raw secret from command line instead of file.
--help
Show the help message.
system snmp set This command allows the user to set up ESX SNMP agent. --authentication or -a
Set default authentication protocol. Values: none, SHA1
--communities or -c
Set up to ten communities each no more than 64 characters. Format is: community1[,community2,…] (this overwrites previous settings)
--enable or -e
Start or stop SNMP service. Values: [yes|no, true|false, 0|1]
--engineid or -E
Set SNMPv3 engine id. Must be at least 10 to 32 hexadecimal characters. 0x or 0X is stripped if found as well as colons (:)
--hwsrc or -y
Where to source hardware events from IPMI sensors or CIM Indications. One of: indications|sensors
--largestorage or -s
Support large storage for hrStorageAllocationUnits * hrStorageSize. Values: [yes|no, true|false, 0|1]. Control how the agent reports hrStorageAllocationUnits, hrStorageSize and hrStorageUsed in hrStorageTable. Setting this directive to 1 to support large storage with small allocation units, the agent re-calculates these values so they all fit Integer32 and hrStorageAllocationUnits * hrStorageSize gives real size of the storage ( Note: hrStorageAllocationUnits will not be real allocation units if real hrStorageSize won’t fit into Integer32 ). Setting this directive to 0 turns off this calculation and the agent reports real hrStorageAllocationUnits, but it might report wrong hrStorageSize for large storage because the value won’t fit into Integer32.
--loglevel or -l
System Agent syslog logging level: debug|info|warning|error
--notraps or -n
Comma separated list of trap oids for traps not to be sent by agent. Use value ‘reset’ to clear setting
--port or -p
Set UDP port to poll snmp agent on. The default is udp/161. May not use ports 32768 to 40959
--privacy or -x
Set default privacy protocol. Values: none, AES128
--remote-users or -R
Set up to five inform user ids. Format is: user/auth-proto/-|auth-hash/priv-proto/-|priv-hash/engine-id[,…] Where user is 32 chars max. auth-proto is none|SHA1, priv-proto is none|AES. ‘-‘ indicates no hash. engine-id is hex string ‘0x0-9a-f’ up to 32 chars max.
--reset or -r
Return agent configuration to factory defaults
--syscontact or -C
System contact string as presented in sysContact.0. Up to 255 characters
--syslocation or -L
System location string as presented in sysLocation.0. Up to 255 characters.
--targets or -t
Set up to three targets to send SNMPv1 traps to. Format is: ip-or-hostname[@port]/community[,…] The default port is udp/162. (this overwrites previous settings)
--users or -u
Set up to five local users. Format is: user/-|auth-hash/-|priv-hash/model[,…] Where user is 32 chars max. ‘-‘ indicates no hash. Model is one of (none|auth|priv).
--v3targets or -i
Set up to three SNMPv3 notification targets. Format is: ip-or-hostname[@port]/remote-user/security-level/trap|inform[,…].
--help
Show the help message.
system snmp test Verify ESX SNMP notifications can be delivered to target destinations. --auth-hash or -A
Optionally test authentication secret generates matching hash for user
--priv-hash or -X
Optionally test privacy secret generates matching hash for user
--raw-secret or -r
Make -A and -X flags read raw secret from command line instead of file.
--user or -u
Validate a given SNMPv3 user name exists
--help
Show the help message.
system stats installtime get Display the date and time when this system was first installed. Value will not change on subsequent updates. --help
Show the help message.
system stats uptime get Display the number of microseconds the system has been running. --help
Show the help message.
system syslog mark Issue a message to all outputs. --message or -s
The message to issue. (required)
--help
Show the help message.
system syslog reload Reload the log daemon to apply any new configuration options. --help
Show the help message.
system syslog config get Show the current global configuration values. --helpShow the help message.
system syslog config set Set global log configuration options. --check-ssl-certs
Verify remote SSL certificates against the local CA Store.
--crl-check
Check revocation status of all the certificates in SSL certificate chain.
--default-rotate
Default number of rotated local logs to keep.
--default-size
Default size of local logs before rotation, in KiB.
--default-timeout
Default network retry timeout in seconds if a remote server fails to respond.--drop-log-rotateNumber of rotated dropped log files to keep.
--drop-log-size
Size of dropped log file before rotation, in KiB.
--logdir
The directory to output local logs to.
--logdir-unique
Place logs in a unique subdirectory of logdir, based on hostname.
--loghost
The remote host(s) to send logs to.
--queue-drop-mark
Message queue capacity after which messages are dropped.
--reset
Reset values to default.
--x509-strict
Strict X.509 compliance when checking SSL certificates.
--help
Show the help message.
system syslog config logger list Show the currently configured sub-loggers. --help
Show the help message.
system syslog config logger set Set configuration options for a specific sub-logger. --id
The id of the logger to configure. (required)
--reset
Reset values to default.
--rotate
Number of rotated logs to keep for a specific logger (requires –id).
--size
Set size of logs before rotation for a specific logger, in KiB (requires –id).
--help
Show the help message.
system time get Disply the current system time. --help
Show the help message.
system time set Set the system clock time. Any missing parameters will default to the current time --day or -d
Day
--hour or -H
Hour
--min or -m
Minute
--month or -M
Month
--sec or -s
Second
--year or -y
Year
--help
Show the help message.
system uuid get Get the system UUID. --help
Show the help message.
system version get Display the product name, version and build information. --alternate or -a
Report version of software image in alternate boot bank if any.
--help
Show the help message.
system visorfs get Obtain status information on the memory filesystem as a whole. --help
Show the help message.
system visorfs ramdisk add Add a new Visorfs RAM disk to the ESXi Host and mount it. --max-size or -M
Maximum size (max reservation in MiB) (required)
--min-size or -m
Minimum size (min reservation in MiB) (required)
--name or -n
Name for the ramdisk (required)
--permissions or -p
Permissions for the root of the ramdisk (mode) (required)
--target or -t
Mountpoint for the ramdisk (absolute path) (required)
--help
Show the help message.
system visorfs ramdisk list List the RAM disks used by the host. --help
Show the help message.
system visorfs ramdisk remove Remove a Visorfs RAM disk from the ESXi Host. --target or -t
Mountpoint for the ramdisk (absolute path) (required)
--help
Show the help message.
system visorfs tardisk list List the tardisks used by the host. --help
Show the help message.
system wbem get Display WBEM Agent configuration. --help
Show the help message.
system wbem set This command allows the user to set up ESX CIMOM agent. --auth or -a
Specify how to authorize incoming requests. Values are password, certificate, password is by default. Changes take effect when –enable is specified.
--enable or -e
Start or stop the WBEM services (sfcbd, openwsmand). Values: [yes|no, true|false, 0|1].
--enable-https or -H
Enable or disable https connection to sfcbd. Values: [yes|no, true|false, 0|1].
--http-max-content-length or -M
Maximum allowed length in bytes of http requests. Default is 1048576.
--http-procs
Maximum number of simultaneous HTTP client connections before blocking new incoming HTTP requests. Default is 2.
--https-procs
Maximum number of simultaneous HTTPS client connections before blocking new incoming HTTPS requests. Default is 4.
--keepalive-max-request or -k
Specify the maximum number of consecutive requests on one connection. Setting it to 0 will effectively disable HTTP keep-alive. Default is 10.
--keepalive-timeout or -K
Specify the maximum time in seconds an sfcb HTTP process will wait between two requests on one connection before terminating. Setting it to 0 will disable HTTP keep-alive. Default is 1.
--loglevel or -l
Syslog logging level: debug|info|warning|error.
--max-msg-len or -m
Maximum allowed length in bytes of wbem messages. Default is 40000000.
--port or -p
Set the TCP port on which the CIMOM listens for requests. The default is 5989.
--protocols or -P
Enable or disable SSL protocols. To reset to factory defaults specify ‘reset’ which allows only TLS 1.2 unless system defaults have been changed.Values can be one of: [tlsv1, tlsv1.1, reset] and setting protocols here overrules system defaults. Multiple protocols can be provided using format -P protocol1 -P protocol2. Command takes effect immediately.
--provider-sample-interval or -i
The interval in seconds at which the provider manager is checking for idle providers. Default is 30.
--provider-timeout-interval or -I
The interval in seconds before an idle provider gets unloaded by the provider manager. Default is 120.
--prov-procs
Maximum number of simultaneous provider processes. After this point if a new incoming request requires loading a new provider, then one of the existing providers will first be automatically unloaded. Default is 16.
--readonly or -R
Set readonly mode. Default is false.
--reset or -r
Restore the WBEM configuration to factory defaults.
--rp-override or -o
This overrides the configured resource pool size of a provider.
--shutdown-interval or -s
Duration in seconds to wait for provider to exit. Default is 3.
--ssl-cipher-list or -S
The cipher list consists of one or more cipher strings separated by ‘:’. Default is !aNULL:kECDH+AESGCM:ECDH+AESGCM:RSA+AESGCM:kECDH+AES:ECDH+AES:RSA+AES.
--thread-pool-size or -t
Number of threads in the sfcb thread pool. Default is 5.
--thread-stack-size or -T
Minimum stack size allocated to sfcb threads. Default is 1048576.
--ws-man or -W
Enable or disable the WS-Management service (openwsmand). Enabled by default. Changes take effect when –enable is specified.
--help
Show the help message.
system wbem provider list Display WBEM provider configuration. --helpShow the help message.
system wbem provider set This command is used to manage ESX CIMOM providers. --enable or -e
Enable or disable the provider immediately. Values: [yes|no, true|false, 0|1]
--name or -n
Specify provider identifier. (required)
--help
Show the help message.
system welcomemsg get Get the Welcome Message for DCUI. --help
Show the help message.
system welcomemsg set Set the Welcome Message for DCUI. --message or -m
Welcome Message String. (required)
--help
Show the help message.

esxcli vm Commands

COMMAND DESCRIPTION OPTIONS HELP
vm process kill Used to forcibly kill Virtual Machines that are stuck and not responding to normal stop operations. --type or -t
The type of kill operation to attempt. There are three types of VM kills that can be attempted: [soft, hard, force]. Users should always attempt ‘soft’ kills first, which will give the VMX process a chance to shutdown cleanly (like kill or kill -SIGTERM). If that does not work move to ‘hard’ kills which will shutdown the process immediately (like kill -9 or kill -SIGKILL). ‘force’ should be used as a last resort attempt to kill the VM. If all three fail then a reboot is required. (required)
--world-id or -w
The World ID of the Virtual Machine to kill. This can be obtained from the ‘vm process list’ command (required)
--help
Show the help message.
vm process list List the virtual machines on this system. This command currently will only list running VMs on the system. --help
Show the help message.

esxcli vsan Commands

COMMAND DESCRIPTION OPTIONS HELP
vsan cluster get Get information about the vSAN cluster that this host is joined to. --help
Show the help message.
vsan cluster join Join the host to a vSAN cluster. --cluster-uuid or -u
vSAN cluster UUID of the cluster instance which the host will join, or create, in the form “nnnnnnnn-nnnn-nnnn-nnnn-nnnnnnnnnnnn” where n are hexadecimal digits. (required)
--metadata-node or -m
Join the host as a metadata node to the cluster.
--wait or -w
Wait until the host joins the cluster.
--witness-node or -t
Join the host as a witness node to the cluster. It is required to specify “–witness-preferred-fault-domain” when this parameter is set.
--witness-preferred-fault-domain or -p
Specify the fault domain that witness node prefers to respond in case of network partition. It should be either of the two fault domains for existing data sites. This parameter is useful only when “–witness-node” is set.
--help
Show the help message.
vsan cluster leave Leave the vSAN cluster the host is currently joined to. --help
Show the help message.
vsan cluster new Create a vSAN cluster with current host joined. A random sub-cluster UUID will be generated. --help
Show the help message.
vsan cluster restore Restore the persisted vSAN cluster configuration. --help
Show the help message.
vsan cluster preferredfaultdomain get Get the preferred fault domain for a stretched cluster. --help
Show the help message.
vsan cluster preferredfaultdomain set Set the preferred fault domain for a stretched cluster. --preferred-fault-domain-name or -n
Preferred Fault domain name to use for a stretched cluster. (required)
--help
Show the help message.
vsan cluster unicastagent add Add a unicast agent to the vSAN cluster configuration. --addr or -a
IP address of the unicast agent. (required)
--bound-interface-name or -i
Name of the bound outgoing network interface.
--cert-thumbprint or -T
SHA-1 certificate thumbprint.
--cluster-uuid or -c
Cluster UUID of the remote server unicast agent (required for -t remote).
--port or -p
Port the unicast agent is listening on.
--supports-unicast or -U
Whether the software version supports unicast (required for -t node)
--type or -t
Type of the unicast agent (One of [witness, node, metadata], default is witness).
--uuid or -u
UUID of the unicast agent (required for -t node).--helpShow the help message.
vsan cluster unicastagent clear Removes all unicast agents in the vSAN cluster configuration. --help
Show the help message.
vsan cluster unicastagent list List all unicast agents in the vSAN cluster configuration. --help
Show the help message.
vsan cluster unicastagent remove Remove a unicast agent from the vSAN cluster configuration. --addr or -a
IP address of the unicast agent. (required)
--port or -p
Port the unicast agent is listening on.
--uuid or -u
UUID of the unicast agent.
--help
Show the help message.
vsan cmmds timemachine get Get vSAN CMMDS time machine configuration. --help
Show the help message.
vsan cmmds timemachine set Configure vSAN CMMDS time machine. --mb-per-day or -m
Specify MB per day for vSAN CMMDS time machine.
--rotate or -r
Specify log file rotation for cmmdsTimeMachineDump.
--size or -s
Specify log file size in KB for cmmdsTimeMachineDump.
--help
Show the help message.
vsan datastore add Add 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. --name or -n
User friendly name of the datastore to be added. It must be unique among all existing vSAN datastores. (required)
--uuid or -u
UUID of the new datastore to be added, in the form “nnnnnnnn-nnnn-nnnn-nnnn-nnnnnnnnnnnn” where n are hexadecimal digits.. If not specified, a new UUID will be generated.
--help
Show the help message.
vsan datastore clear Remove 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. --help
Show the help message.
vsan datastore list List datastores in the vSAN cluster. --help
Show the help message.
vsan datastore remove Remove 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. --uuid or -u
UUID of the datastore to be removed, in the form “nnnnnnnn-nnnn-nnnn-nnnn-nnnnnnnnnnnn” where n are hexadecimal digits. (required)
--help
Show the help message.
vsan datastore name get Get vSAN datastore name. --uuid or -u
UUID of the datastore, in the form “nnnnnnnn-nnnn-nnnn-nnnn-nnnnnnnnnnnn” where n are hexadecimal digits. If not specified, the default datastore is assumed.
--help
Show the help message.
vsan datastore name set Configure vSAN datastore name. In general, rename should always be done at cluster level. Across a vSAN cluster vSAN datastore name should be in sync. --newname or -n
New name of the datastore. (required)
--uuid or -u
UUID of the datastore, in the form “nnnnnnnn-nnnn-nnnn-nnnn-nnnnnnnnnnnn” where n are hexadecimal digits. If not specified, the default datastore is assumed.
--help
Show the help message.
vsan debug advcfg list List all advanced configuration options with non-default values. --option or -o
List only the specified options, even if their value is default. Usage example: –option=’VSAN.ClomRepairDelay’ –option=’LSOM.ssdWbSize’…
--help
Show the help message.
vsan debug controller list Print detailed information about all vSAN disk controllers (output may change between releases) --used-by-vsan or -v
Filter the controllers used by vSAN or not
--help
Show the help message.
vsan debug disk list Print detailed information about all vSAN disks in the cluster. --guuid or -g
Filter disks by disk group UUID.
--local or -l
Show only local disks.
--uuid or -u
Filter disks by disk UUID.
--help
Show the help message.
vsan debug disk overview Print overview information about all vSAN disks in the cluster. --local or -l
Show only local disks.
--help
Show the help message.
vsan debug disk summary get Print summary information about all vSAN disks in the cluster. --local or -l
Check only local disks.
--help
Show the help message.
vsan debug evacuation precheck Examine 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. --action or -a
Action filter. Only show a specific type of actions from ensureAccess: Ensure Accessibility evacAllData: Evacuate All Data noAction: No Action .
--entity or -e
The name or uuid of the disk or disk group or host node. For name, it accepts ‘localhost’ or a hostname in vSAN cluster, or a device name in a diskgroup such as ‘mpx.vmhba1:C0:T1:L0’. (required)
--verbose or -v
Show full list of inaccessible and non-compliant (redundancy reduced) objects.
--help
Show the help message.
vsan debug limit get Print summary information about vSAN limits (output may change between releases) --help
Show the help message.
vsan debug memory list Print both userworld and kernel memory consumptions of vSAN. --help
Show the help message.
vsan debug mob start Start vSAN Managed Object Browser Service. --help
Show the help message.
vsan debug mob status Query vSAN Managed Object Browser Service is running or not. --help
Show the help message.
vsan debug mob stop Stop vSAN Managed Object Browser Service. --help
Show the help message.
vsan debug object list Print detailed information about vSAN objects in the cluster. This command would only show 100 objects at most by default. --all
If given, query all the objects in the cluster. Please make sure the host has enough resources to run.
--comp-owner
Filter objects by component owner.
--disk-uuid
Filter objects by disk UUID.
--guuid or -g
Filter objects by group UUID.
--health
Filter objects by object health.
--max-number
Specify the maximum number of objects to query. Note: querying large number of objects can be very resource consuming.
--policy
Filter objects by disk policy. Usage example: –policy=’CSN:1’ –policy=’SCSN:1’…
--sort or -a
Sort By. Sort the output by health: Object Health policy: Policy size: Size used: Used
--uuid or -u
Filter objects by object UUID.
--vm-name
Filter objects by VM name.
--help
Show the help message.
vsan debug object overview Print overview information about all vSAN objects in the cluster. This command would only show 100 objects at most by default. --all
If given, query all the objects in the cluster. (Please make sure the host has enough resource to run.)
--max-number
Specify the max number of object query. (Note: Query large number of objects can be very resource consuming.)
--help
Show the help message.
vsan debug object health summary get Print health summary information about all vSAN objects in the cluster (output may change between releases) --help
Show the help message.
vsan debug resync list Print detailed information about vSAN resyncing objects (output may change between releases) --help
Show the help message.
vsan debug resync summary get Print summary information about vSAN resyncing objects (output may change between releases) --help
Show the help message.
vsan debug vmdk list Print summary information about VMDKs on local vSAN datastore (output may change between releases) --help
Show the help message.
vsan encryption cert get Get encryption KMS server certificate contents. --help
Show the help message.
vsan encryption cert path list List encryption certificate file paths. --help
Show the help message.
vsan encryption hostkey get Get host key from keycache used for vSAN encryption. --help
Show the help message.
vsan encryption info get Get vSAN encryption infomation. --help
Show the help message.
vsan encryption kms list List the KMS configurations used for vSAN encryption. --help
Show the help message.
vsan faultdomain get Get the fault domain name for this host. --help
Show the help message.
vsan faultdomain reset Reset Host fault domain to default value --help
Show the help message.
vsan faultdomain set Set the fault domain for this host --fdname or -n
Fault domain name to use for this host. Empty string means reset to default. (required)
--help
Show the help message.
vsan health cluster get Get a specific health check status and its details --test or -t
Test full name prefix or short test id of the health check. The test full names are shown in health UI and can be listed with ‘esxcli vsan health cluster list’ (Note: use the TEST NAME, not GROUP NAME). If the prefix matchs more than one test, all the matched tests will be displayed. The short test ids can be seen with ‘esxcli vsan health cluster list -w’. (required)
--help
Show the help message.
vsan health cluster list List a cluster wide health check across all types of health checks --with-test-id or -w
Specify output list include testId (testId can be used to get the details of a test)
--help
Show the help message.
vsan iscsi defaultconfig get Get default values for vSAN iSCSI Target configurations. --help
Show the help message.
vsan iscsi defaultconfig set Set default values for vSAN iSCSI Target configurations. --authtype or -m
Provide default authentication type. Supported authentication types are [No-Authentication, CHAP, CHAP-Mutual].
--interface or -n
The name of the default network interface through which the target is accessible.
--mutual-secret or -S
The secret an initiator uses to authenticate a target. Required if authentication type is CHAP-Mutual. (secret)
--mutual-userid or -U
The user name an initiator uses to authenticate a target. Required if authentication type is CHAP-Mutual. (secret)
--port or -p
The default network port number through which the target will be accessible.
--secret or -s
The secret a target uses to authenticate an initiator. Required if authentication type is CHAP or CHAP-Mutual. (secret)
--userid or -u
The user name a target uses to authenticate an initiator. Required if authentication type is CHAP or CHAP-Mutual. (secret)
--help
Show the help message.
vsan iscsi homeobject create Create 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. --authtype or -m
Provide default authentication type. Supported authentication types are [No-Authentication, CHAP, CHAP-Mutual].
--interface or -n
The name of the default network interface. (required)
--mutual-secret or -S
The secret an initiator uses to authenticate a target. Required if authentication type is CHAP-Mutual. (secret)
--mutual-userid or -U
The user name an initiator uses to authenticate a target. Required if authentication type is CHAP-Mutual. (secret)
--policy or -P
vSAN storage policy for vSAN iSCSI target home object, in the form of a string. Please check ‘esxcli vsan policy setdefault –help’ for details on policy options.
--port or -p
The port number of the default network port. If not provided, default network port: 3260.
--secret or -s
The secret a target uses to authenticate an initiator. Required if authentication type is CHAP or CHAP-Mutual. (secret)
--userid or -u
The user name a target uses to authenticate an initiator. Required if authentication type is CHAP or CHAP-Mutual. (secret)
--help
Show the help message.
vsan iscsi homeobject delete Delete vSAN iSCSI target home object. This operation will destroy all vSAN iSCSI target configuration --help
Show the help message.
vsan iscsi homeobject get Get status for the vSAN iSCSI target home object --help
Show the help message.
vsan iscsi homeobject set Update configuration for the vSAN iSCSI target home object --policy or -P
New vSAN storage policy for vSAN iSCSI target home object, in the form of a string. Please check ‘esxcli vsan policy setdefault –help’ for details on policy options.
--help
Show the help message.
vsan iscsi initiatorgroup add Add 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. --name or -n
The name of the new initiator group. Group name must be unique within the vSAN cluster. (required)
--help
Show the help message.
vsan iscsi initiatorgroup get Get initiator group properties. --name or -n
Initiator group name. (required)
--help
Show the help message.
vsan iscsi initiatorgroup list Get the list of initiator groups. --help
Show the help message.
vsan iscsi initiatorgroup remove Remove an initiator group. Group should be empty. If you want to remove non-empty group use –force option. --force or -f
Force deletion of the initiator group even if it is not empty.
--name or -n
The name of the initiator group to remove. (required)
--help
Show the help message.
vsan iscsi initiatorgroup initiator add Add new initiator iSCSI names to the vSAN iSCSI initiator group. --group or -g
The name of the initiator group. (required)
--names or -n
Specify initiator iSCSI names to be added to the initiator group. Multiple initiator iSCSI names can be provided using format -n initiator1 -n initiator2. (required)
--help
Show the help message.
vsan iscsi initiatorgroup initiator remove Remove initiator iSCSI names from the vSAN iSCSI initiator group. --group or -g
The name of the initiator group. (required)
--names or -n
Specify initiator iSCSI names to be removed from the initiator group. Multiple initiator iSCSI names can be provided using format -n initiator1 -n initiator2.the initiator group. (required)
--help
Show the help message.
vsan iscsi status get Gets current status (Enabled or Disabled). --help
Show the help message.
vsan iscsi status set Enable or disable iSCSI target support, query status --enabled
Sets status, enabling or disabling vSAN iSCSI target support on the way. The new status survives a reboot (required)
--help
Show the help message.
vsan iscsi target add Add a new vSAN iSCSI target. --alias or -a
The alias of the target. The alias has to be unique. (required)
--authtype or -m
Provide authentication type for target. If not provided, target can be accessed through without authentication. Supported authentication types are [No-Authentication, CHAP, CHAP-Mutual].
--initiator-add or -A
Specify initiator iSCSI names or initiator groups to be added to the list of initiators that can access this target. Multiple initiator iSCSI names and initiator groups can be added using format -A initiator1 -A initiator2.
--interface or -n
The name of the network interface through which the target is accessible. If not provided, the target will be accessible through default network interface.
--iqn or -i
The iSCSI Qualified Name (IQN) of the target. This parameter is optional and should be unique if provided. If not provided, appropriate IQN will be generated by the system.
--mutual-secret or -S
The secret an initiator uses to authenticate a target. Required if authentication type is CHAP-Mutual. (secret)
--mutual-userid or -U
The user name an initiator uses to authenticate a target. Required if authentication type is CHAP-Mutual. (secret)
--policy or -P
vSAN storage policy for target namespace, in the form of a string. Please check ‘esxcli vsan policy setdefault –help’ for details on policy options.
--port or -p
The name of the network port through which the target is accessible. If not provided, the target will be accessible through default network port: 3260.
--secret or -s
The secret a target uses to authenticate an initiator. Required if authentication type is CHAP or CHAP-Mutual. (secret)
--userid or -u
The user name a target uses to authenticate an initiator. Required if authentication type is CHAP or CHAP-Mutual. (secret)
--help
Show the help message.
vsan iscsi target get Get configuration for vSAN iSCSI target --alias or -a
The iSCSI Target alias. (required)
--help
Show the help message.
vsan iscsi target list List vSAN iSCSI targets. --help
Show the help message.
vsan iscsi target remove Remove a vSAN iSCSI target. --alias or -a
The alias of the vSAN iSCSI target to be removed. (required)
--help
Show the help message.
vsan iscsi target set Update configuration of the given iSCSI target. --alias or -a
The alias of the target which needs to be modified. (required)
--authtype or -m
Provides authentication type for the target. Supported authentication types are [No-Authentication, CHAP, CHAP-Mutual]
--initiator-add or -A
Specify initiator iSCSI names or initiator groups to be added to the list of initiators that can access this target. Multiple initiator iSCSI names and initiator groups can be added using format -A initiator1 -A initiator2.
--initiator-remove or -R
Specify initiator iSCSI names or initiator groups to be removed from the list of initiators that can access this target. Multiple initiator iSCSI names and initiator groups can be added using format -R initiator1 -R initiator2.
--interface or -n
The name of the new network interface through which the target is accessible.
--mutual-secret or -S
The secret an initiator uses to authenticate a target. Required if authentication type is CHAP-Mutual. (secret)
--mutual-userid or -U
The user name an initiator uses to authenticate a target. Required if authentication type is CHAP-Mutual. (secret)
--new-alias or -N
The new alias of the target.
--policy or -P
New vSAN storage policy for target namespace, in the form of a string. Please check ‘esxcli vsan policy setdefault –help’ for details on policy options.
--port or -p
The port number of the network port through which the target is accessible
--secret or -s
The secret a target uses to authenticate an initiator. Required if authentication type is CHAP or CHAP-Mutual. (secret)
--userid or -u
The user name a target uses to authenticate an initiator. Required if authentication type is CHAP or CHAP-Mutual. (secret)
--help
Show the help message.
vsan iscsi target lun add Add a new vSAN iSCSI LUN to specified target --alias or -a
An optional alias for LUN. Can be used to indicate additional info about the LUN.
--id or -i
The optional ID of the LUN [0..255]. If not provided, next free identifier will be used. If provided, ID must be unique within target.
--policy or -P
vSAN storage policy for LUN, in the form of a string. Please check ‘esxcli vsan policy setdefault –help’ for more detail on policy options.
--size or -s
Size of the LUN object. Eg: 5GB. Supported units: MB, GB, TB, MiB, GiB, TiB. (required)
--target or -t
Name of the vSAN iSCSI target to which the LUN will be added. (required)
--help
Show the help message.
vsan iscsi target lun get Get configuration for vSAN iSCSI LUN --id or -i
The ID for the LUN. (required)
--target or -t
The iSCSI Target alias. (required)
--help
Show the help message.
vsan iscsi target lun list List vSAN iSCSI LUNs in specified target. --target or -t
The alias of the vSAN iSCSI target whose LUNs should be listed. (required)--helpShow the help message.
vsan iscsi target lun remove Remove a vSAN iSCSI LUN from specified target. --id or -i
Identifier of the LUN to be removed. (required)
--target or -t
Name of the vSAN iSCSI target from which the LUN will be removed. (required)
--help
Show the help message.
vsan iscsi target lun set Update configuration for given vSAN iSCSI target LUN. --alias or -a
The new alias for the LUN. Can be used to indicate additional info about the LUN.
--id or -i
The ID of the LUN. (required)
--new-id or -n
The new ID of the LUN [0..255]. If provided, ID must be unique within this target.
--new-target or -T
New target name that the LUN moved to. LUN ID might be changed after moved to the new target.
--policy or -P
New policy for LUN, in the form of a string. Please check ‘esxcli vsan policy setdefault –help’ for more detail on policy options.
--size or -s
The new size of the LUN object with optional units. If provided, it should be greater than existing size i.e. LUNs are only allowed to grow. Supported unit types are MB, MiB, GB, GiB and TB, TiB (case-insensitive). If not specified, default unit is MiB.
--status or -S
Change the LUN status to [online, offline]. offline: Bring the LUN offline. Offline LUNs are inaccessible. It’s allowed to do backup and some disruptive management operations like changing LUN ID when a LUN is offline. online: Bring the LUN online. Online LUNs are accessible.
--target or -t
Alias of the vSAN iSCSI target for which the LUN needs to be updated. (required)
--help
Show the help message.
vsan maintenancemode cancel Cancel an in-progress vSAN maintenance mode operation. --help
Show the help message.
vsan network clear Clear the vSAN network configuration. --help
Show the help message.
vsan network list List the network configuration currently in use by vSAN. --help
Show the help message.
vsan network remove Remove an interface from the vSAN network configuration. --force or -f
Notify vSAN subsystem of removal, even if not configured.
--interface-name or -i
Interface name. (required)
--help
Show the help message.
vsan network restore Restore the persisted vSAN network configuration. --help
Show the help message.
vsan network ip add Add an IP interface to the vSAN network configuration. --agent-mc-addr or -d
IPv4 multicast address for agent (also called downstream) group.
--agent-mc-port or -p
Multicast address port for agent (also called downstream) group.
--agent-v6-mc-addr or -D
IPv6 multicast address for agent (also called downstream) group.
--host-uc-port or -c
Unicast address port for host unicast channel.
--interface-name or -i
Interface name. (required)
--master-mc-addr or -u
IPv4 multicast address for master (also called upstream) group.
--master-mc-port or -o
Multicast address port for master (also called upstream) group.
--master-v6-mc-addr or -U
IPv6 multicast address for master (also called upstream) group.
--multicast-ttl or -t
Time-to-live for multicast packets.
--traffic-type or -T
Network transmission type of vSAN traffic through a virtual network adapter.Supported values are vsan, witness. Type vsan means general vSAN transmission, which is used for both data and witness transmission, if there is no virtual adapter configured with witness traffic type; Type witness indicates that, vSAN vmknic is used for vSAN witness transmission. Once a virtual adapter is configured with witness traffic type, vSAN witness data transmission will stop using virtual adpater with vsan traffic type, and use first dicovered virtual adapter with witness traffic type. Multiple traffic types can be provided in format -T type1 -T type2. Default value is vsan, if this option is not specified.
--help
Show the help message.
vsan network ip remove Remove an IP interface from the vSAN network configuration. --force or -f
Notify vSAN subsystem of removal, even if not configured.
--interface-name or -i
Interface name. (required)
--help
Show the help message.
vsan network ip set Reconfigure an IP interface in the vSAN network configuration. --agent-mc-addr or -d
IPv4 multicast address for agent (also called downstream) group.
--agent-mc-port or -p
Multicast address port for agent (also called downstream) group.
--agent-v6-mc-addr or -D
IPv6 multicast address for agent (also called downstream) group.
--host-uc-port or -c
Unicast address port for host unicast channel.
--interface-name or -i
Interface name. (required)
--master-mc-addr or -u
IPv4 multicast address for master (also called upstream) group.
--master-mc-port or -o
Multicast address port for master (also called upstream) group.
--master-v6-mc-addr or -U
IPv6 multicast address for master (also called upstream) group.
--multicast-ttl or -t
Time-to-live for multicast packets.
--traffic-type or -T
Network transmission type of vSAN traffic through a virtual network adapter.Supported values are vsan, witness. Type vsan means general vSAN transmission, which is used for both data and witness transmission, if there is no virtual adapter configured with witness traffic type; Type witness indicates that, vSAN vmknic is used for vSAN witness transmission. Once a virtual adapter is configured with witness traffic type, vSAN witness data transmission will stop using virtual adpater with vsan traffic type, and use first dicovered virtual adapter with witness traffic type. Multiple traffic types can be provided in format -T type1 -T type2. Default value is vsan, if this option is not specified.
--help
Show the help message.
vsan network ipv4 add Add an IP interface to the vSAN network configuration. --agent-mc-addr or -d
IPv4 multicast address for agent (also called downstream) group.
--agent-mc-port or -p
Multicast address port for agent (also called downstream) group.
--agent-v6-mc-addr or -D
IPv6 multicast address for agent (also called downstream) group.
--host-uc-port or -c
Unicast address port for host unicast channel.
--interface-name or -i
Interface name. (required)
--master-mc-addr or -u
IPv4 multicast address for master (also called upstream) group.
--master-mc-port or -o
Multicast address port for master (also called upstream) group.
--master-v6-mc-addr or -U
IPv6 multicast address for master (also called upstream) group.
--multicast-ttl or -t
Time-to-live for multicast packets.
--traffic-type or -T
Network transmission type of vSAN traffic through a virtual network adapter.Supported values are vsan, witness. Type vsan means general vSAN transmission, which is used for both data and witness transmission, if there is no virtual adapter configured with witness traffic type; Type witness indicates that, vSAN vmknic is used for vSAN witness transmission. Once a virtual adapter is configured with witness traffic type, vSAN witness data transmission will stop using virtual adpater with vsan traffic type, and use first dicovered virtual adapter with witness traffic type. Multiple traffic types can be provided in format -T type1 -T type2. Default value is vsan, if this option is not specified.
--help
Show the help message.
vsan network ipv4 remove Remove an IP interface from the vSAN network configuration. --force or -f
Notify vSAN subsystem of removal, even if not configured.
--interface-name or -i
Interface name. (required)
--help
Show the help message.
vsan network ipv4 set Reconfigure an IP interface in the vSAN network configuration. --agent-mc-addr or -d
IPv4 multicast address for agent (also called downstream) group.
--agent-mc-port or -p
Multicast address port for agent (also called downstream) group.
--agent-v6-mc-addr or -D
IPv6 multicast address for agent (also called downstream) group.
--host-uc-port or -c
Unicast address port for host unicast channel.
--interface-name or -i
Interface name. (required)
--master-mc-addr or -u
IPv4 multicast address for master (also called upstream) group.
--master-mc-port or -o
Multicast address port for master (also called upstream) group.
--master-v6-mc-addr or -U
IPv6 multicast address for master (also called upstream) group.
--multicast-ttl or -t
Time-to-live for multicast packets.
--traffic-type or -T
Network transmission type of vSAN traffic through a virtual network adapter.Supported values are vsan, witness. Type vsan means general vSAN transmission, which is used for both data and witness transmission, if there is no virtual adapter configured with witness traffic type; Type witness indicates that, vSAN vmknic is used for vSAN witness transmission. Once a virtual adapter is configured with witness traffic type, vSAN witness data transmission will stop using virtual adpater with vsan traffic type, and use first dicovered virtual adapter with witness traffic type. Multiple traffic types can be provided in format -T type1 -T type2. Default value is vsan, if this option is not specified.
--help
Show the help message.
vsan perf get Gets current status (Enabled or Disabled). --help
Show the help message.
vsan perf set Set vSAN performance service configuration. --enabled
Set status, enabling or disabling vSAN performance service.
--interval
Set the collect interval in seconds. This parameter is unsupported and for development use only.
--policy
Specify the policy for enabling. Usage example: –policy=’((“hostFailuresToTolerate”i0))’
--use-ramdisk
Enable and set the size in MB of RAM disk. This parameter is unsupported and for development use only.
--verbose
Set the verbose mode value.
--help
Show the help message.
vsan perf diagnostic get Gets current status about diagnostic mode. --help
Show the help message.
vsan perf diagnostic set Set vSAN diagnostic mode configuration. --enabled
Set status, enabling or disabling diagnostic mode. (required)
--interval
Set the collect interval in seconds for diagnostic mode.
--use-ramdisk
Enable and set the size in MB of RAM disk for diagnostic mode.
--help
Show the help message.
vsan policy cleardefault Clear default vSAN storage policy values. --help
Show the help message.
vsan policy getdefault Get default vSAN storage policy values. --policy-class or -c
vSAN policy class whose default value to get. If not provided, defaults for all classes will be retrieved. Options are: [cluster, vdisk, vmnamespace, vmswap, vmem].
--help
Show the help message.
vsan policy setdefault Set default vSAN storage policy values. --policy or -p
vSAN policy to set as default, in the form of a string. Options are: 1)cacheReservation - Flash capacity reserved as read cache for the storage object. Specified as a percentage of the logical size of the object. To be used only for addressing read performance issues. Reserved flash capacity cannot be used by other objects. Unreserved flash is shared fairly among all objects. It is specified in parts per million. Default value: 0, Maximum value: 1000000. 2)forceProvisioning - If this option is “1” the object will be provisioned even if the policy specified in the storage policy is not satisfiable with the resources currently available in the cluster. vSAN will try to bring the object into compliance if and when resources become available. Default value: 0. 3)hostFailuresToTolerate - Defines the number of host, disk, or network failures a storage object can tolerate. When the fault tolerance method is mirroring: to tolerate “n” failures, “n+1” copies of the object are created and “2n+1” hosts contributing storage are required (if fault domains are configured, “2n+1” fault domains with hosts contributing storage are required). When the fault tolerance method is erasure coding: to tolerate 1 failure, 4 hosts (or fault domains) are required; and to tolerate 2 failures, 6 hosts (or fault domains) are required. Note: A host which is not part of a fault domain is counted as its own single-host fault domain. Default value: 1, Maximum value: 3. 4)stripeWidth - The number of HDDs across which each replica of storage object is striped. A value higher than 1 may result in better performance (for e.g when flash read cache misses need to get serviced from HDD), but also results in higher used of system resources. Default value: 1, Maximum value: 12. 5)proportionalCapacity - Percentage of the logical size of the storage object that will be reserved (thick provisioning) upon VM provisioning. The rest of the storage object is thin provisioned. Default value: 0%, Maximum value: 100%. 6)iopsLimit - Defines upper IOPS limit for a disk. IO rate that has been serviced on a disk will be measured and if the rate exceeds the IOPS limit, IO will be delayed to keep it under the limit. Zero value means no limit. Default value: 0. 7)replicaPreference - Defines the method used to tolerate failures. RAID-1 achieves failure tolerance using mirrors, which provides better performance. RAID-5/6 achieves failure tolerance using parity blocks, which provides better space efficiency. RAID-5/6 is only available on All-flash and when the number of failures to tolerate is set to 1 or 2: a value of 1 implies a RAID-5 configuration, and a value of 2 implies a RAID-6 configuration. Default value: RAID-1. (required)
--policy-class or -c
vSAN policy class whose default value to set. Options are: [cluster, vdisk, vmnamespace, vmswap, vmem]. (required)
--help
Show the help message.
vsan resync bandwidth get Get information about vSAN resync bandwidth in Mbps for the disk group with the heaviest resync workload. --help
Show the help message.
vsan resync throttle get Get information about vSAN resync throttling --help
Show the help message.
vsan resync throttle set Configure vSAN resync throttling --level
Set vSAN resync throttle level in Mbps (integer in the range 0-512, 0 means no throttling) (required)
--help
Show the help message.
vsan storage add Add physical disk for vSAN usage. --disks or -d
Name of disk devices to be added to a vSAN disk-group as vSAN capacity tier devices. Expects an empty device with no partitions as the device will be partitioned and formatted. Otherwise this operation will fail. The command expects the device name for the disk to be provided, e.g.: mpx.vmhba2:C0:T1:L0.Multiple capacity device can be provided using format -d device1 -d device2 -d device3 (required)
--ssd or -s
Specify a caching device to be added to a vSAN disk-group as vSAN caching tier device. Expects an empty cache device with no partitions in which case the device will be partitioned and formatted. Otherwise this operation will fail. If a cache device which is already added for use by vSAN, is provided along with ‘-d/–disks’, then the disk mentioned with ‘-d’ will be added to the existing disk-group created under this cache device and in which case, the cache device won’t be partitioned and formatted. The command expects the device name for the drive to be provided, e.g.: mpx.vmhba2:C0:T1:L0 using format -s device (required)
--help
Show the help message.
vsan storage list List vSAN storage configuration. --device or -d
Filter the output of this command to only show a single device with specified device name.
--uuid or -u
Filter the output of this command to only show a single device with specified uuid.
--help
Show the help message.
vsan storage remove Remove physical disks from vSAN disk groups. --disk or -d
Specify individual hdd to remove from vSAN usage.e.g.: mpx.vmhba2:C0:T1:L0
--evacuation-mode or -m
Action the vSAN service must take before the host can enter maintenance mode (default noAction). Allowed values are: ensureObjectAccessibility: Evacuate data from the disk to ensure object accessibility in the vSAN cluster, before removing the disk. evacuateAllData: Evacuate all data from the disk before removing it. noAction: Do not move vSAN data out of the disk before removing it.
--ssd or -s
Specify a disk group’s fronting ssd to remove the ssd and each backing hdd from vSAN usage.e.g.: mpx.vmhba2:C0:T1:L0
--uuid or -u
Specify UUID of vSAN disk.e.g.: 52afa1de-4240-d5d6-17f9-8af1ec8509e5
--help
Show the help message.
vsan storage automode get Get status of storage auto claim mode. --help
Show the help message.
vsan storage automode set Configure storage auto claim mode --enabled
Changing this value to true will result in enabling auto disk claim mode. Disks will be claimed by the vSAN service in next storage event, e.g.: adapter rescan and disk hot-plug. Set to false to disable storage auto claim mode. (required)
--help
Show the help message.
vsan storage diskgroup mount Mount a vSAN disk or disk group. --disk or -d
Specify the disk to mount for use by vSAN.e.g.: mpx.vmhba0:C0:T1:L0
--ssd or -s
Specify a disk group’s fronting ssd to mount the ssd and each backing hdd for use by vSAN.e.g.: mpx.vmhba2:C0:T1:L0
--uuid or -u
Specify a vSAN UUID of the disk or fronting ssd to mount for use by vSAN.e.g.: 5291022a-ad03-df90-dd0f-b9f980cc005e
--help
Show the help message.
vsan storage diskgroup rebuild Rebuild a disk group. --evacuation-mode or -m
Specify an action to take upon removing the disk group from VSAN (default noAction). Allowed values are: ensureObjectAccessibility: Evacuate data from the disk to ensure object accessibility in the VSAN cluster, before removing the disk evacuateAllData: Evacuate all data from the disk before removing it noAction: Do not move VSAN data out of the disk before removing it
--force
Skip unhealthy disks.
--ssd or -s
Specify a disk group’s fronting SSD to rebuild the SSD and each backing HDD for use by vSAN.E.g.: mpx.vmhba2:C0:T1:L0
--uuid or -u
Specify a vSAN UUID of the fronting SSD to rebuild for use by vSAN.E.g.: 5291022a-ad03-df90-dd0f-b9f980cc005e
--help
Show the help message.
vsan storage diskgroup unmount Unmount vSAN disk or disk group. --disk or -d
Specify the hdd to unmount from vSAN usage.e.g.: mpx.vmhba0:C0:T1:L0
--evacuation-mode or -m
Specify an action to take upon unmounting the disk group from vSAN (default NoAction). EnsureObjectAccessibility: Evacuate data from the disk to ensure object accessibility in the vSAN cluster, before unmount the disk EvacuateAllData: Evacuate all data from the disk before unmounting it NoAction: Do not move vSAN data out of the disk before unmount it Only valid with –ssd specified.
--ssd or -s
Specify a disk group’s fronting ssd to unmount the ssd and each backing hdd from vSAN usage.e.g.: mpx.vmhba2:C0:T1:L0
--uuid or -u
Specify a vSAN UUID of the disk or fronting ssd to unmount for use by vSAN.e.g.: 5291022a-ad03-df90-dd0f-b9f980cc005e
--help
Show the help message.
vsan storage tag add Add a vSAN storage tag. --disk or -d
Name of the disk to which the tag should be added. (required)
--tag or -t
Tag to be added to disk. Supported tags are [capacityFlash]. (required)
--help
Show the help message.
vsan storage tag remove Remove a vSAN storage tag. --disk or -d
Name of the disk from which the tag should be removed. (required)
--tag or -t
Tag to be removed from disk. Supported tags are [capacityFlash]. (required)
--help
Show the help message.
vsan trace get Get the vSAN tracing configuration. --help
Show the help message.
vsan trace set Configure vSAN trace. Please note: This command is not thread safe. --domobjnumfiles or -d
Log file rotation for vSAN trace DOM object files.
--domobjsize
Maximum size of vSAN DOM object trace files in MB.
--logtosyslog or -l
Boolean value to enable or disable logging urgent traces to syslog.
--lsom-num-files
Log file rotation for vSAN trace LSOM files.
--lsom-size
Maximum size of vSAN LSOM trace files in MB.
--lsom-verbose-num-files
Log file rotation for vSAN trace LSOM Verbose files.
--lsom-verbose-size
Maximum size of vSAN LSOM trace verbose files in MB.
--numfiles or -f
Log file rotation for vSAN trace files.
--path or -p
Path to store vSAN trace files.
--reset or -r
When set to true, reset defaults for vSAN trace files.
--size or -s
Maximum size of vSAN trace files in MB.
--urgentnumfiles or -u
Log file rotation for vSAN trace urgent files.
--urgentsize
Maximum size of vSAN urgent trace files in MB.
--help
Show the help message.

文章作者: kclouder
版权声明: 本博客所有文章除特別声明外,均采用 CC BY 4.0 许可协议。转载请注明来源 kclouder !
  目录