ESXi 5.5 - ESXCLI Command Reference

ESXCLI is the most powerful command line tool on an ESXi host. You may need it for troubleshooting, configuration or for ESXi installations by using a kickstart file. I'm having this command line reference on my desktop since a couple of month and I am using it quite often. Maybe someone else is able to make use of it too. It's a collection of help pages from all esxcli commands.

Usage: esxcli device alias get [cmd options]
Description:
get Display hardware location info for a device alias.
Cmd options:
-n|--alias=<str> Alias to lookup (required)
Usage: esxcli device alias list [cmd options]
Description:
list List device aliases.
Cmd options:
Usage: esxcli esxcli command list [cmd options]
Description:
list This command will list all of the esxcli commands with
their namespace, object, command name and description.
Cmd options:
Usage: esxcli fcoe adapter list [cmd options]
Description:
list List FCOE-capable CNA devices.
Cmd options:
Usage: esxcli fcoe nic disable [cmd options]
Description:
disable Disable rediscovery of FCOE storage on behalf of an
FCOE-capable CNA upon next boot.
Cmd options:
-n|--nic-name=<str> The CNA adapter name (vmnicX) (required)
Usage: esxcli fcoe nic discover [cmd options]
Description:
discover Initiate FCOE adapter discovery on behalf of an FCOE-
capable CNA.
Cmd options:
-n|--nic-name=<str> The CNA adapter name (vmnicX) (required)
Usage: esxcli fcoe nic list [cmd options]
Description:
list List FCOE-capable CNA devices.
Cmd options:
Usage: esxcli graphics device list [cmd options]
Description:
list List all of the graphics devices on this host.
Cmd options:
Usage: esxcli graphics vm list [cmd options]
Description:
list List active VMs associated with graphics devices.
Cmd options:
Usage: esxcli hardware bootdevice list [cmd options]
Description:
list List the boot device order, if available, for this
host.
Cmd options:
Usage: esxcli hardware clock get [cmd options]
Description:
get Disply the current hardware clock time.
Cmd options:
Usage: esxcli hardware clock set [cmd options]
Description:
set Set the hardware clock time. Any missing parameters
will default to the current time.
Cmd options:
-d|--day=<long> Day
-H|--hour=<long> Hour
-m|--min=<long> Minute
-M|--month=<long> Month
-s|--sec=<long> Second
-y|--year=<long> Year
Usage: esxcli hardware cpu cpuid get [cmd options]
Description:
get Get CPUID fields for the given CPU.
Cmd options:
-c|--cpu=<long> The ID of the CPU to query for CPUID data (required)
Usage: esxcli hardware cpu global get [cmd options]
Description:
get Get properties that are global to all CPUs.
Cmd options:
Usage: esxcli hardware cpu global set [cmd options]
Description:
set Set properties that are global to all CPUs.
Cmd options:
-t|--hyperthreading Enable or disable hyperthreading (required)
Usage: esxcli hardware cpu list [cmd options]
Description:
list List all of the CPUs on this host.
Cmd options:
Usage: esxcli hardware ipmi fru get [cmd options]
Description:
get Get IPMI Field Replaceable Unit (FRU) device details.
Cmd options:
-i|--ignore-missing Do not fail command if ipmi device is not present
-p|--include-pretty-raw
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
-r|--include-raw Include a hex dump where the value of each byte is
presented as hexidecimal characters joined without
spaces
-n|--node=<str> Specify which IPMI device (0..3) to query, defaults to
'all' for all ipmi nodes
Usage: esxcli hardware ipmi fru list [cmd options]
Description:
list List IPMI Field Replaceable Unit (FRU) inventory.
Cmd options:
-i|--ignore-missing Do not fail command if ipmi device is not present
-p|--include-pretty-raw
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
-r|--include-raw Include a hex dump where the value of each byte is
presented as hexidecimal characters joined without
spaces
-n|--node=<str> Specify which IPMI device (0..3) to query, defaults to
'all' for all ipmi nodes
Usage: esxcli hardware ipmi sdr get [cmd options]
Description:
get Get IPMI Sensor Data Repository (SDR) properties.
Cmd options:
-i|--ignore-missing Do not fail command if ipmi device is not present
-p|--include-pretty-raw
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
-r|--include-raw Include a hex dump where the value of each byte is
presented as hexidecimal characters joined without
spaces
-n|--node=<str> Specify which IPMI device (0..3) to query, defaults to
'all' for all ipmi nodes
Usage: esxcli hardware ipmi sdr list [cmd options]
Description:
list List IPMI Sensor Data Repository.
Cmd options:
-f|--formatter=<str> Override the formatter to use for a given command.
Available formatter: simple ,table
-i|--ignore-missing Do not fail command if ipmi device is not present
-p|--include-pretty-raw
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
-r|--include-raw Include a hex dump where the value of each byte is
presented as hexidecimal characters joined without
spaces
-n|--node=<str> Specify which IPMI device (0..3) to query, defaults to
'all' for all ipmi nodes
Usage: esxcli hardware ipmi sel clear [cmd options]
Description:
clear Clear IPMI System Event Log.
Cmd options:
-i|--ignore-missing Do not fail command if ipmi device is not present
-p|--include-pretty-raw
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
-r|--include-raw Include a hex dump where the value of each byte is
presented as hexidecimal characters joined without
spaces
-n|--node=<str> Specify which IPMI device (0..3) to query, defaults to
'all' for all ipmi nodes
Usage: esxcli hardware ipmi sel get [cmd options]
Description:
get Get IPMI System Event Log (SEL) properties.
Cmd options:
-i|--ignore-missing Do not fail command if ipmi device is not present
-p|--include-pretty-raw
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
-r|--include-raw Include a hex dump where the value of each byte is
presented as hexidecimal characters joined without
spaces
-n|--node=<str> Specify which IPMI device (0..3) to query, defaults to
'all' for all ipmi nodes
Usage: esxcli hardware ipmi sel list [cmd options]
Description:
list List IPMI System Event Log.
Cmd options:
-i|--ignore-missing Do not fail command if ipmi device is not present
-p|--include-pretty-raw
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
-r|--include-raw Include a hex dump where the value of each byte is
presented as hexidecimal characters joined without
spaces
-n|--node=<str> Specify which IPMI device (0..3) to query, defaults to
'all' for all ipmi nodes
Usage: esxcli hardware memory get [cmd options]
Description:
get Get information about memory.
Cmd options:
Usage: esxcli hardware pci list [cmd options]
Description:
list List all of the PCI devices on this host.
Cmd options:
-c|--class=<str> Filter the PCI devices based on their hexadecimal
Class ID
-m|--mask=<str> Mask the filter provided by the class flag
Usage: esxcli hardware platform get [cmd options]
Description:
get Get information about the platform
Cmd options:
Usage: esxcli hardware trustedboot get [cmd options]
Description:
get Information about the status of trusted boot. (TPM,
DRTM status)
Cmd options:
Usage: esxcli iscsi adapter auth chap get [cmd options]
Description:
get Get the iSCSI CHAP authentication for the iSCSI Host
Bus Adapter.
Cmd options:
-A|--adapter=<str> The iSCSI adapter name. (required)
-d|--direction=<str> The iSCSI CHAP authentication direction ( [uni,
mutual])
Usage: esxcli iscsi adapter auth chap set [cmd options]
Description:
set Set the iSCSI CHAP authentication for the iSCSI Host
Bus Adapter.
Cmd options:
-A|--adapter=<str> The iSCSI adapter name. (required)
-N|--authname=<str> The iSCSI CHAP authentication name
-D|--default Resetting iSCSI CHAP authenthication setting to
default.
-d|--direction=<str> The iSCSI CHAP authentication direction ( [uni,
mutual])
-l|--level=<str> The iSCSI CHAP authentication level ( [prohibited,
discouraged, preferred, required])
-S|--secret=<str> The iSCSI CHAP authentication secret
Usage: esxcli iscsi adapter capabilities get [cmd options]
Description:
get List the iSCSI details for the iSCSI Host Bus Adapter.
Cmd options:
-A|--adapter=<str> The iSCSI adapter name. (required)
Usage: esxcli iscsi adapter discovery rediscover [cmd options]
Description:
rediscover Do the iSCSI Discovery for the iSCSI Host Bus Adapter.
Cmd options:
-A|--adapter=<str> The iSCSI adapter name. (required)
Usage: esxcli iscsi adapter discovery sendtarget add [cmd options]
Description:
add Add a sendtarget address
Cmd options:
-A|--adapter=<str> The iSCSI adapter name. (required)
-a|--address=<str> The iSCSI sendtarget address: <ip/dns[:port]>
(required)
Usage: esxcli iscsi adapter discovery sendtarget auth chap get [cmd options]
Description:
get Get iSCSI CHAP authentication on a sendtarget address
Cmd options:
-A|--adapter=<str> The iSCSI adapter name. (required)
-a|--address=<str> The iSCSI sendtarget address: <ip/dns[:port]>
(required)
-d|--direction=<str> The iSCSI authentication direction ( [uni, mutual])
Usage: esxcli iscsi adapter discovery sendtarget auth chap set [cmd options]
Description:
set Set iSCSI CHAP authentication on a sendtarget address
Cmd options:
-A|--adapter=<str> The iSCSI adapter name. (required)
-a|--address=<str> The iSCSI sendtarget address: <ip/dns[:port]>
(required)
-N|--authname=<str> The iSCSI authentication name
-D|--default Resetting iSCSI authentication setting to default.
-d|--direction=<str> The iSCSI authentication direction ( [uni, mutual])
-I|--inherit Inheriting iSCSI authentication setting from parent.
-l|--level=<str> The iSCSI authentication level ( [prohibited,
discouraged, preferred, required])
-S|--secret=<str> The iSCSI authentication secret
Usage: esxcli iscsi adapter discovery sendtarget list [cmd options]
Description:
list List sendtarget addresses
Cmd options:
-A|--adapter=<str> The iSCSI adapter name.
Usage: esxcli iscsi adapter discovery sendtarget param get [cmd options]
Description:
get Get iSCSI parameter on a sendtarget address
Cmd options:
-A|--adapter=<str> The iSCSI adapter name. (required)
-a|--address=<str> The iSCSI sendtarget address: <ip/dns[:port]>
(required)
Usage: esxcli iscsi adapter discovery sendtarget param set [cmd options]
Description:
set Set the iSCSI parameter for the iSCSI Sendtarget.
Cmd options:
-A|--adapter=<str> The iSCSI adapter name. (required)
-a|--address=<str> The iSCSI sendtarget address: <ip/dns[:port]>
(required)
-D|--default Resetting iSCSI parameter setting to default.
-I|--inherit Inheriting iSCSI parameter setting from parent.
-k|--key=<str> The iSCSI parameter key (required)
-v|--value=<str> The iSCSI parameter value
Usage: esxcli iscsi adapter discovery sendtarget remove [cmd options]
Description:
remove Remove a sendtarget address
Cmd options:
-A|--adapter=<str> The iSCSI adapter name. (required)
-a|--address=<str> The iSCSI sendtarget address: <ip/dns[:port]>
(required)
Usage: esxcli iscsi adapter discovery statictarget add [cmd options]
Description:
add Add a static target address
Cmd options:
-A|--adapter=<str> The iSCSI adapter name. (required)
-a|--address=<str> The iSCSI target address: <ip/dns[:port]> (required)
-n|--name=<str> The iSCSI target name. (required)
Usage: esxcli iscsi adapter discovery statictarget list [cmd options]
Description:
list List static target addresses
Cmd options:
-A|--adapter=<str> The iSCSI adapter name.
Usage: esxcli iscsi adapter discovery statictarget remove [cmd options]
Description:
remove Remove a static target
Cmd options:
-A|--adapter=<str> The iSCSI adapter name. (required)
-a|--address=<str> The iSCSI target address: <ip/dns[:port]> (required)
-n|--name=<str> The iSCSI target name. (required)
Usage: esxcli iscsi adapter discovery status get [cmd options]
Description:
get Get the iSCSI adapter discovery status for the iSCSI
Host Bus Adapter.
Cmd options:
-A|--adapter=<str> The iSCSI adapter name. (required)
Usage: esxcli iscsi adapter firmware get [cmd options]
Description:
get Validate the iSCSI firmware for the iSCSI Host Bus
Adapter.
Cmd options:
-A|--adapter=<str> The iSCSI adapter name. (required)
-f|--file=<str> Path to the firmware file to retrieve information
from. (required)
Usage: esxcli iscsi adapter firmware set [cmd options]
Description:
set Upload the iSCSI firmware for the iSCSI Host Bus
Adapter.
Cmd options:
-A|--adapter=<str> The iSCSI adapter name. (required)
-f|--file=<str> Path to the firmware file to download. (required)
Usage: esxcli iscsi adapter get [cmd options]
Description:
get List the iSCSI information for the iSCSI Host Bus
Adapter.
Cmd options:
-A|--adapter=<str> The iSCSI adapter name. (required)
Usage: esxcli iscsi adapter list [cmd options]
Description:
list List all the iSCSI Host Bus Adapters on the system.
Cmd options:
-A|--adapter=<str> The iSCSI adapter name.
Usage: esxcli iscsi adapter param get [cmd options]
Description:
get Get the iSCSI parameters for the iSCSI Host Bus
Adapter.
Cmd options:
-A|--adapter=<str> The iSCSI adapter name. (required)
Usage: esxcli iscsi adapter param set [cmd options]
Description:
set Set the iSCSI parameter for the iSCSI Host Bus
Adapter.
Cmd options:
-A|--adapter=<str> The iSCSI adapter name. (required)
-D|--default Resetting iSCSI parameter setting to default.
-k|--key=<str> The iSCSI initiator parameter key. (required)
-v|--value=<str> The iSCSI initiator parameter value.
Usage: esxcli iscsi adapter set [cmd options]
Description:
set Set the iSCSI name and alias for the iSCSI Host Bus
Adapter.
Cmd options:
-A|--adapter=<str> The iSCSI adapter name. (required)
-a|--alias=<str> The iSCSI initiator alias.
-n|--name=<str> The iSCSI initiator name.
Usage: esxcli iscsi adapter target list [cmd options]
Description:
list List iSCSI targets.
Cmd options:
-A|--adapter=<str> The iSCSI adapter name.
-n|--name=<str> The iSCSI target name.
Usage: esxcli iscsi adapter target portal auth chap get [cmd options]
Description:
get Get iSCSI CHAP authentication on a target
Cmd options:
-A|--adapter=<str> The iSCSI adapter name. (required)
-a|--address=<str> The iSCSI target address: <ip/dns[:port]> (required)
-d|--direction=<str> The iSCSI authentication direction ( [uni, mutual])
-m|--method=<str> The iSCSI authentication method ( [chap])
-n|--name=<str> The iSCSI target name: <iqn/eui> (required)
Usage: esxcli iscsi adapter target portal auth chap set [cmd options]
Description:
set Set the iSCSI CHAP authentication for the iSCSI
Target.
Cmd options:
-A|--adapter=<str> The iSCSI adapter name. (required)
-a|--address=<str> The iSCSI target address: <ip/dns[:port]> (required)
-N|--authname=<str> The iSCSI authentication name
-D|--default Resetting iSCSI authentication setting to default.
-d|--direction=<str> The iSCSI authentication direction ( [uni, mutual])
-I|--inherit Inheriting iSCSI authentication setting from parent.
-l|--level=<str> The iSCSI authentication level ( [prohibited,
discouraged, preferred, required])
-n|--name=<str> The iSCSI target name: <iqn/eui> (required)
-S|--secret=<str> The iSCSI authentication password
Usage: esxcli iscsi adapter target portal list [cmd options]
Description:
list List iSCSI target portals.
Cmd options:
-A|--adapter=<str> The iSCSI adapter name.
-n|--name=<str> The iSCSI target name.
Usage: esxcli iscsi adapter target portal param get [cmd options]
Description:
get Get iSCSI parameter on a target
Cmd options:
-A|--adapter=<str> The iSCSI adapter name. (required)
-a|--address=<str> The iSCSI target address: <ip/dns[:port]> (required)
-n|--name=<str> The iSCSI target name: <iqn/eui> (required)
Usage: esxcli iscsi adapter target portal param set [cmd options]
Description:
set Set the iSCSI parameter for the iSCSI Target.
Cmd options:
-A|--adapter=<str> The iSCSI adapter name. (required)
-a|--address=<str> The iSCSI target address: <ip/dns[:port]> (required)
-D|--default Resetting iSCSI parameter setting to default.
-I|--inherit Inheriting iSCSI parameter setting from parent.
-k|--key=<str> The iSCSI parameter key (required)
-n|--name=<str> The iSCSI target name: <iqn/eui> (required)
-v|--value=<str> The iSCSI parameter value
Usage: esxcli iscsi ibftboot get [cmd options]
Description:
get Get iSCSI IBFT Boot details.
Cmd options:
Usage: esxcli iscsi ibftboot import [cmd options]
Description:
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.
Cmd options:
Usage: esxcli iscsi logicalnetworkportal list [cmd options]
Description:
list List Logical Network Portals for iSCSI Adapter
Cmd options:
-A|--adapter=<str> The iSCSI adapter name.
Usage: esxcli iscsi networkportal add [cmd options]
Description:
add Add a network portal for iSCSI adapter
Cmd options:
-A|--adapter=<str> The iSCSI adapter name. (required)
-f|--force The force flag (force add of iSCSI vmknic even it's
not compatible for iscsi multipathing)
-n|--nic=<str> The iSCSI network portal (bound vmknic) (required)
Usage: esxcli iscsi networkportal ipconfig get [cmd options]
Description:
get Get iSCSI network portal ip configuration
Cmd options:
-A|--adapter=<str> The iSCSI adapter name. (required)
-n|--nic=<str> The iSCSI network portal (vmknic)
Usage: esxcli iscsi networkportal ipconfig set [cmd options]
Description:
set Set iSCSI network portal IP configuration
Cmd options:
-A|--adapter=<str> The iSCSI adapter name. (required)
-x|--dns1=<str> The iSCSI network portal primary DNS address
-y|--dns2=<str> The iSCSI network portal secondary DNS address
-g|--gateway=<str> The iSCSI network portal gateway address
-i|--ip=<str> The iSCSI network portal IP address (required)
-n|--nic=<str> The iSCSI network portal (vmknic)
-s|--subnet=<str> The iSCSI network portal subnet mask (required)
Usage: esxcli iscsi networkportal list [cmd options]
Description:
list List Network Portal for iSCSI Adapter
Cmd options:
-A|--adapter=<str> The iSCSI adapter name.
Usage: esxcli iscsi networkportal remove [cmd options]
Description:
remove Remove a network portal for iSCSI adapter
Cmd options:
-A|--adapter=<str> The iSCSI adapter name. (required)
-f|--force The force flag (force removal of iSCSI vmknic when
sessions are active using it)
-n|--nic=<str> The iSCSI network portal (bound vmknic) (required)
Usage: esxcli iscsi physicalnetworkportal list [cmd options]
Description:
list List Physical Network Portal for iSCSI Adapter
Cmd options:
-A|--adapter=<str> The iSCSI adapter name.
Usage: esxcli iscsi physicalnetworkportal param get [cmd options]
Description:
get Get network parameters on a Physical Network Portal
(vmnic)
Cmd options:
-A|--adapter=<str> The iSCSI adapter name. (required)
-n|--nic=<str> The physical network portal name: <vmnic>
Usage: esxcli iscsi physicalnetworkportal param set [cmd options]
Description:
set Set network parameter on a Physical Network Portal
Cmd options:
-A|--adapter=<str> The iSCSI adapter name. (required)
-n|--nic=<str> The physical network portal name: <vmnic>
-o|--option=<str> The network parameter option (required)
-v|--value=<long> Input value for a Physical Network Portal option (use
0/1 for bool, and number for int) (required)
Usage: esxcli iscsi plugin list [cmd options]
Description:
list List IMA plugins.
Cmd options:
-A|--adapter=<str> The iSCSI adapter name.
-p|--plugin=<str> The IMA plugin file name.
Usage: esxcli iscsi session add [cmd options]
Description:
add Login sessions on current iSCSI configuration.
Cmd options:
-A|--adapter=<str> The iSCSI adapter name. (required)
-s|--isid=<str> The isid of a session to duplicate for login.
-n|--name=<str> The iSCSI target name.
Usage: esxcli iscsi session connection list [cmd options]
Description:
list List iSCSI connections.
Cmd options:
-A|--adapter=<str> The iSCSI adapter name.
-c|--cid=<str> The iSCSI connection identifier(CID).
-s|--isid=<str> The iSCSI session identifier(ISID).
-n|--name=<str> The iSCSI target name.
Usage: esxcli iscsi session list [cmd options]
Description:
list List iSCSI Sessions.
Cmd options:
-A|--adapter=<str> The iSCSI adapter name.
-s|--isid=<str> The iSCSI session identifier.
-n|--name=<str> The iSCSI target name.
Usage: esxcli iscsi session remove [cmd options]
Description:
remove Logout sessions on current iSCSI configuration.
Cmd options:
-A|--adapter=<str> The iSCSI adapter name. (required)
-s|--isid=<str> The isid of a session to duplicate for login.
-n|--name=<str> The name of the target to login to.
Usage: esxcli iscsi software get [cmd options]
Description:
get Software iSCSI information.
Cmd options:
Usage: esxcli iscsi software set [cmd options]
Description:
set Enable or disable software iSCSI.
Cmd options:
-e|--enabled Enable or disable the module. (required)
Usage: esxcli network diag ping [cmd options]
Description:
ping Send ICMP echo requests to network hosts.
Cmd options:
-c|--count=<long> Specify the number of packets to send.
-D|--debug VMKPing debug mode.
-d|--df Set DF bit on IPv4 packets.
-H|--host=<str> Specify the host to send packets to. This parameter is
required when not executing ping in debug mode (-D)
-I|--interface=<str> Specify the outgoing interface.
-i|--interval=<str> Set the interval for sending packets in seconds.
-4|--ipv4 Ping with ICMPv4 echo requests.
-6|--ipv6 Ping with ICMPv6 echo requests.
--netstack=<str> Specify the TCP/IP netstack which the interface
resides on
-N|--nexthop=<str> Override the system's default route selection, in
dotted quad notation. (IPv4 only. Requires interface
option)
-s|--size=<long> Set the payload size of the packets to send.
-t|--ttl=<long> Set IPv4 Time To Live or IPv6 Hop Limit
-W|--wait=<str> Set the timeout to wait if no responses are received
in seconds.
Usage: esxcli network fence list [cmd options]
Description:
list Get all fence switch info on the system.
Cmd options:
Usage: esxcli network fence network bte list [cmd options]
Description:
list Get all fence network bridge table entries information
Cmd options:
-f|--fence-id=<long> The fence id used to retrieve fence info. (required)
-s|--vds-name=<str> The vds name used to retrieve fence info. (required)
Usage: esxcli network fence network list [cmd options]
Description:
list Get all fence network info on the vds.
Cmd options:
-f|--fence-id=<long> The fence id used to retrieve fence info.
-s|--vds-name=<str> The vds name used to retrieve fence info. (required)
Usage: esxcli network fence network port list [cmd options]
Description:
list Get all fence port info on the fence network.
Cmd options:
-f|--fence-id=<long> The fence id used to retrieve fence info. (required)
-s|--vds-name=<str> The vds name used to retrieve fence info. (required)
Usage: esxcli network firewall get [cmd options]
Description:
get Get the firewall status.
Cmd options:
Usage: esxcli network firewall load [cmd options]
Description:
load Load firewall module and rulesets configuration.
Cmd options:
Usage: esxcli network firewall refresh [cmd options]
Description:
refresh Load ruleset configuration for firewall.
Cmd options:
Usage: esxcli network firewall ruleset allowedip add [cmd options]
Description:
add Add allowed ip address/range to the ruleset ruleset.
Cmd options:
-i|--ip-address=<str> Allowed ip address/range for the ruleset. (required)
-r|--ruleset-id=<str> The label of the ruleset. (required)
Usage: esxcli network firewall ruleset allowedip list [cmd options]
Description:
list list allowed ip addresses for rulesets.
Cmd options:
-r|--ruleset-id=<str> The label of the ruleset.
Usage: esxcli network firewall ruleset allowedip remove [cmd options]
Description:
remove Remove allowed ip address/range from the ruleset.
Cmd options:
-i|--ip-address=<str> Allowed ip address/range for the ruleset. (required)
-r|--ruleset-id=<str> The label of the ruleset. (required)
Usage: esxcli network firewall ruleset list [cmd options]
Description:
list List the rulesets in firewall.
Cmd options:
-r|--ruleset-id=<str> List configuration for specfic ruleset
Usage: esxcli network firewall ruleset rule list [cmd options]
Description:
list List the rules of each ruleset in firewall.
Cmd options:
-r|--ruleset-id=<str> List rules for specfic ruleset
Usage: esxcli network firewall ruleset set [cmd options]
Description:
set Set firewall ruleset status (allowedAll flag and
enabled status).
Cmd options:
-a|--allowed-all Set to true to allowed all ip, set to false to use
allowed ip list.
-e|--enabled Set to true to enable ruleset, set to false to disable
it.
-r|--ruleset-id=<str> The label of the ruleset. (required)
Usage: esxcli network firewall set [cmd options]
Description:
set Set firewall enabled status and default action.
Cmd options:
-d|--default-action Set to true to set defaultaction PASS, set to false to
DROP.
-e|--enabled Set to true to enable the firewall, set to false to
disable the firewall.
Usage: esxcli network firewall unload [cmd options]
Description:
unload Allow unload firewall module.
Cmd options:
Usage: esxcli network ip connection list [cmd options]
Description:
list List active TCP/IP connections
Cmd options:
-N|--netstack=<str> The network stack instance; if unspecified, use the
default netstack instance
-t|--type=<str> Connection type : [ip, tcp, udp, all]
Usage: esxcli network ip dns search add [cmd options]
Description:
add Add a search domain to the list of domains to be
searched when trying to resolve an host name on the
ESXi host.
Cmd options:
-d|--domain=<str> The string name of a domain to add to the list of
search domains. (required)
-N|--netstack=<str> The network stack instance; if unspecified, use the
default netstack instance
Usage: esxcli network ip dns search list [cmd options]
Description:
list List the search domains currently configured on the
ESXi host in the order in which they will be used when
searching.
Cmd options:
-N|--netstack=<str> The network stack instance; if unspecified, use the
default netstack instance
Usage: esxcli network ip dns search remove [cmd options]
Description:
remove Remove a search domain from the list of domains to be
searched when trying to resolve an host name on the
ESXi host.
Cmd options:
-d|--domain=<str> The string name of a domain to remove from the list of
search domains. (required)
-N|--netstack=<str> The network stack instance; if unspecified, use the
default netstack instance
Usage: esxcli network ip dns server add [cmd options]
Description:
add Add a new DNS server to the end of the list of DNS
servers to use for this ESXi host.
Cmd options:
-N|--netstack=<str> The network stack instance; if unspecified, use the
default netstack instance
-s|--server=<str> The IP address (v4 or v6) of the DNS server to add to
the DNS server list. (required)
Usage: esxcli network ip dns server list [cmd options]
Description:
list Print a list of the DNS server currently configured on
the system in the order in which they will be used.
Cmd options:
-N|--netstack=<str> The network stack instance; if unspecified, use the
default netstack instance
Usage: esxcli network ip dns server remove [cmd options]
Description:
remove Remove a DNS server from the list of DNS servers to
use for this ESXi host.
Cmd options:
-a|--all
-N|--netstack=<str> The network stack instance; if unspecified, use the
default netstack instance
-s|--server=<str> (required)
Usage: esxcli network ip get [cmd options]
Description:
get Get global IP settings
Cmd options:
Usage: esxcli network ip interface add [cmd options]
Description:
add Add a new VMkernel network interface.
Cmd options:
-P|--dvport-id=<str> DVPort ID of the connection point. This requires
--dvs-name to be given in the same command
-s|--dvs-name=<str> DVSwitch name of the connection point. This requires
--dvport-id to be given in the same command
-i|--interface-name=<str>
The name of the VMkernel network interface to create.
This name must be in the form vmkX, where X is a
number 0-255
-M|--mac-address=<str>
Set the MAC address for the newly created VMkernel
network interface.
-m|--mtu=<long> Set the MTU setting for a given VMkernel network
interface on creation
-N|--netstack=<str> The network stack instance; if unspecified, use the
default netstack instance
-p|--portgroup-name=<str>
The name of the vswitch port group to add this
VMkernel network interface to.
Usage: esxcli network ip interface ipv4 get [cmd options]
Description:
get Get IPv4 settings for VMkernel network interfaces.
Cmd options:
-i|--interface-name=<str>
The name of the VMkernel network interface to limit
the output of this command to.
-N|--netstack=<str> The network stack instance; if unspecified, consider
all netstack instances
Usage: esxcli network ip interface ipv4 set [cmd options]
Description:
set Configure IPv4 setting for a given VMkernel network
interface.
Cmd options:
-i|--interface-name=<str>
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)
-I|--ipv4=<str> The static IPv4 address for this interface.
-N|--netmask=<str> The static IPv4 netmask for this interface.
-P|--peer-dns A boolean value to indicate if the system should use
the DNS settings published via DHCP for this
interface.
-t|--type=<str> 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.
(required)
Usage: esxcli network ip interface ipv6 address add [cmd options]
Description:
add Add a static IPv6 address to a given VMkernel network
interface.
Cmd options:
-i|--interface-name=<str>
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)
-I|--ipv6=<str> The IPv6 address to add to the given VMkernel network
interface. This must be in X:X:X::/X format (required)
Usage: esxcli network ip interface ipv6 address list [cmd options]
Description:
list This command will list all of the IPv6 addresses
currently assigned to the system
Cmd options:
Usage: esxcli network ip interface ipv6 address remove [cmd options]
Description:
remove Remove an IPv6 address from a given VMkernel network
interface.
Cmd options:
-i|--interface-name=<str>
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)
-I|--ipv6=<str> The IPv6 address to remove from the given VMkernel
network interface. This must be in X:X:X::/X format
(required)
Usage: esxcli network ip interface ipv6 get [cmd options]
Description:
get Get IPv6 settings for VMkernel network interfaces.
This does not include the IPv6 addresses which can be
found in the listipv6 command
Cmd options:
-n|--interface-name=<str>
The name of the VMkernel network interface to limit
the output of this command to.
-N|--netstack=<str> The network stack instance; if unspecified, consider
all netstack instances
Usage: esxcli network ip interface ipv6 set [cmd options]
Description:
set Configure IPv6 settings for a given VMkernel network
interface.
Cmd options:
-d|--enable-dhcpv6 Setting this value to true will enable DHCPv6 on this
interface and attempt to aquire an IPv6 address from
the network
-r|--enable-router-adv
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.
-i|--interface-name=<str>
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)
-P|--peer-dns A boolean value to indicate if the system should use
the DNS settings published via DHCPv6 for this
interface.
Usage: esxcli network ip interface list [cmd options]
Description:
list This command will list the VMkernel network interfaces
currently known to the system.
Cmd options:
-N|--netstack=<str> The network stack instance; if unspecified, consider
all netstack instances
Usage: esxcli network ip interface remove [cmd options]
Description:
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.
Cmd options:
-P|--dvport-id=<str> DVPort ID of the connection point. This requires
--dvs-name to be given in the same command
-s|--dvs-name=<str> DVSwitch name of the connection point. This requires
--dvport-id to be given in the same command
-i|--interface-name=<str>
The name of the VMkernel network interface to remove.
This name must be in the form vmkX, where X is a
number 0-255
-N|--netstack=<str> The network stack instance; if unspecified, use the
default netstack instance
-p|--portgroup-name=<str>
The name of the vswitch port group to delete this
VMkernel network interface from.
Usage: esxcli network ip interface set [cmd options]
Description:
set This command sets the enabled status and MTU size of a
given IP interface
Cmd options:
-e|--enabled Set to true to enable the interface, set to false to
disable it.
-i|--interface-name=<str>
The name of the interface to apply the configurations.
(required)
-m|--mtu=<long> The MTU size of the IP interface.
Usage: esxcli network ip interface tag add [cmd options]
Description:
add Adds a tag on a given VMkernel network interface.
Cmd options:
-i|--interface-name=<str>
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)
-t|--tagname=<str> Tag name to assign to the interface (required)
Usage: esxcli network ip interface tag get [cmd options]
Description:
get Gets the tags set on the given VMkernel network
interface.
Cmd options:
-i|--interface-name=<str>
Name of vmknic whose tags are to be read (required)
Usage: esxcli network ip interface tag remove [cmd options]
Description:
remove Removes a tag on a given VMkernel network interface.
Cmd options:
-i|--interface-name=<str>
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)
-t|--tagname=<str> Tag name to assign to the interface (required)
Usage: esxcli network ip ipsec sa add [cmd options]
Description:
add Add a Security Association.
Cmd options:
-e|--encryption-algorithm=<str>
Encryption algorithm for the Security Association.
Should be one in set [null, 3des-cbc, aes128-cbc].
(required)
-k|--encryption-key=<str>
Encryption key(ASCII or hex). Length of hex key is
dependent upon algorithm used. Required when a
encryption algorithm has been specified.
-i|--integrity-algorithm=<str>
Integrity algorithm for the Security Association.
Should be one in set [hmac-sha1, hmac-sha2-256].
(required)
-K|--integrity-key=<str>
Integrity key(ASCII or hex). Length of hex key is
dependent upon algorithm used. (required)
-d|--sa-destination=<str>
Ipv6 address of Security Association destination. Can
be specified as 'any' or a correct IPv6 address.
(required)
-m|--sa-mode=<str> Security Association mode. Should be one in set
[transport, tunnel].
-n|--sa-name=<str> Name for the Security Association to be added.
(required)
-s|--sa-source=<str> Ipv6 address of Security Association source. Can be
specified as 'any' or a correct IPv6 address.
(required)
-p|--sa-spi=<str> SPI value for the Security Association(hex).
(required)
Usage: esxcli network ip ipsec sa list [cmd options]
Description:
list List configured Security Associations
Cmd options:
Usage: esxcli network ip ipsec sa remove [cmd options]
Description:
remove Operation to remove Security Association(s)
Cmd options:
-a|--remove-all Set to remove all Security Associations.
-d|--sa-destination=<str>
Ipv6 address of Security Association destination. This
option needs to be specified when removing an auto SA.
-n|--sa-name=<str> Name for the Security Association to be removed.
Specify 'auto' to remove an auto SA.
-s|--sa-source=<str> Ipv6 address of Security Association source. This
option needs to be specified when removing an auto SA.
-p|--sa-spi=<str> SPI value for the Security Association (hex). This
option needs to be specified when removing an auto SA
Usage: esxcli network ip ipsec set [cmd options]
Description:
set Set IKE config file path.
Cmd options:
-f|--ike-conf=<str> Pass an IKE config path to IKE daemon, this will copy
the config to IKE config and restart IKE daemons
(required)
Usage: esxcli network ip ipsec sp add [cmd options]
Description:
add Add a Security Policy.
Cmd options:
-A|--action=<str> Action for Security Policy. Should be one in set
[none, discard, ipsec].
-P|--destination-port=<long>
Destination Port for Security Policy. '0' stands for
'any' (required)
-w|--flow-direction=<str>
Flow direction for Security Policy. Should be one in
set [in, out].
-a|--sa-name=<str> 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.
-p|--source-port=<long>
Source Port for Security Policy. '0' stands for 'any'
(required)
-d|--sp-destination=<str>
Ipv6 address and prefix length of Security Policy
destination. Can be specified as 'any' or a correct
Ipv6 network address. (required)
-m|--sp-mode=<str> Security Policy mode. Should be one in set
[transport, tunnel].
-n|--sp-name=<str> Name for the Security Policy to be added. (required)
-s|--sp-source=<str> Ipv6 address and prefix length of Security Policy
source. Can be specified as 'any' or a correct IPv6
network address. (required)
-u|--upper-layer-protocol=<str>
Upper layer protocol for Security Policy, Should be
one in set [any, tcp, udp, icmp6].
Usage: esxcli network ip ipsec sp list [cmd options]
Description:
list List configured Security Policys
Cmd options:
Usage: esxcli network ip ipsec sp remove [cmd options]
Description:
remove Operation to remove Security Policy
Cmd options:
-a|--remove-all Set to remove all Security Policys
-n|--sp-name=<str> Name for the Security Policy to be removed.
Usage: esxcli network ip neighbor list [cmd options]
Description:
list List ARP table entries
Cmd options:
-i|--interface-name=<str>
The name of the VMkernel network interface to limit
the output of this command to; if unspecified, list
neighbors on all interfaces.
-N|--netstack=<str> The network stack instance; if unspecified, use the
default netstack instance
-v|--version=<str> IP version : [4, 6, all]
Usage: esxcli network ip neighbor remove [cmd options]
Description:
remove Remove ARP table entries
Cmd options:
-i|--interface-name=<str>
The name of the VMkernel network interface to remove
the neighbor entry from. If not specified, neighbor
will be removed from all interfaces
-a|--neighbor-addr=<str>
The IPv4/IPv6 address of the neighbor. (required)
-N|--netstack=<str> The network stack instance; if unspecified, use the
default netstack instance
-v|--version=<str> IP version : [4, 6] (required)
Usage: esxcli network ip netstack add [cmd options]
Description:
add Add a new Netstack Instance.
Cmd options:
-d|--disabled Create the netstack instance only in config i.e. in
disabled state. Does not create in kernel.
-N|--netstack=<str> The network stack instance (required)
Usage: esxcli network ip netstack get [cmd options]
Description:
get Get runtime/configuration settings for a given
Netstack Instance.
Cmd options:
-N|--netstack=<str> The network stack instance (required)
Usage: esxcli network ip netstack list [cmd options]
Description:
list This command will list the VMkernel Netstack instances
currently known to the system.
Cmd options:
Usage: esxcli network ip netstack remove [cmd options]
Description:
remove Remove a new Netstack Instance.
Cmd options:
-N|--netstack=<str> The network stack instance (required)
Usage: esxcli network ip netstack set [cmd options]
Description:
set Configure settings for a given Netstack Instance.
Cmd options:
-c|--ccalgo=<str> The TCP Congestion Contol Algorithm for this netstack
instance (not applied to existing connections).:
cubic: Set cubic as the algorithm
newreno: Set newreno as the algorithm
-e|--enable Enable the netstack instance (create in kernel)
-i|--ipv6enabled To enable IPv6 for this netstack instance (aplied only
during netstack creation).
-m|--maxconn=<long> The maximum number of connections for this netstack
instance (applied only during netstack creation).
-n|--name=<str> The name for this netstack instance.
-N|--netstack=<str> The network stack instance. This name must be an
interface listed in the netstack list command.
(required)
Usage: esxcli network ip route ipv4 add [cmd options]
Description:
add Add IPv4 route to the VMkernel.
Cmd options:
-g|--gateway=<str> The Ipv4 address of the gateway through which a route
to be added. (required)
-N|--netstack=<str> The network stack instance; if unspecified, use the
default netstack instance
-n|--network=<str> The Ipv4 address and prefix length of the network to
add the route to. Specify 'default' to indicate the
default network. (required)
Usage: esxcli network ip route ipv4 list [cmd options]
Description:
list List configured IPv4 routes
Cmd options:
-N|--netstack=<str> The network stack instance; if unspecified, use the
default netstack instance
Usage: esxcli network ip route ipv4 remove [cmd options]
Description:
remove Remove IPv4 route
Cmd options:
-g|--gateway=<str> The Ipv4 address of the gateway through which a route
to be removed (required)
-N|--netstack=<str> The network stack instance; if unspecified, use the
default netstack instance
-n|--network=<str> The Ipv4 address and prefix length of the network to
remove the route from. Specify 'default' to indicate
the default network. (required)
Usage: esxcli network ip route ipv6 add [cmd options]
Description:
add Add IPv6 route to the VMkernel.
Cmd options:
-g|--gateway=<str> The Ipv6 address of the gateway through which a route
to be added. (required)
-N|--netstack=<str> The network stack instance; if unspecified, use the
default netstack instance
-n|--network=<str> The Ipv6 address and prefix length of the network to
add the route to. Specify 'default' to indicate the
default network. (required)
Usage: esxcli network ip route ipv6 list [cmd options]
Description:
list List configured IPv6 routes
Cmd options:
-N|--netstack=<str> The network stack instance; if unspecified, use the
default netstack instance
Usage: esxcli network ip route ipv6 remove [cmd options]
Description:
remove Remove IPv6 route from the VMkernel
Cmd options:
-g|--gateway=<str> The Ipv6 address of the gateway through which a route
to be removed (required)
-N|--netstack=<str> The network stack instance; if unspecified, use the
default netstack instance
-n|--network=<str> The Ipv6 address and prefix length of the network to
remove the route from. Specify 'default' to indicate
the default network. (required)
Usage: esxcli network ip set [cmd options]
Description:
set Update global IP settings
Cmd options:
-e|--ipv6-enabled Enable or disable IPv6 (Reboot Required)
Usage: esxcli network nic coalesce get [cmd options]
Description:
get Get coalesce parameters
Cmd options:
-n|--vmnic=<str> The name of pnic to get coalesce parameters
Usage: esxcli network nic coalesce set [cmd options]
Description:
set Set coalesce parameters on a nic
Cmd options:
-R|--rx-max-frames=<long>
Maximum number of RX frames driver to process before
interrupting.
-r|--rx-usecs=<long> Number of microseconds driver to wait for RX before
interrupting.
-T|--tx-max-frames=<long>
Maximum number of completed TX frames driver to
process before interrupting.
-t|--tx-usecs=<long> Number of microseconds driver to wait for completed TX
before interrupting.
-n|--vmnic=<str> Name of vmnic to set coalesce parameters. (required)
Usage: esxcli network nic cso get [cmd options]
Description:
get Get checksum offload settings
Cmd options:
-n|--vmnic=<str> The name of pnic to get CSO settings
Usage: esxcli network nic cso set [cmd options]
Description:
set Set checksum offload settings on a nic
Cmd options:
-e|--enable=<long> RX/TX checksum offload (required)
-n|--vmnic=<str> Name of vmnic to set offload settings. (required)
Usage: esxcli network nic down [cmd options]
Description:
down Bring down the specified network device.
Cmd options:
-n|--nic-name=<str> The name of the NIC to configured. This must be one of
the cards listed in the nic list command. (required)
Usage: esxcli network nic eeprom change [cmd options]
Description:
change Change EEPROM on a nic
Cmd options:
-f|--file=<str> File name of new EEPROM content
-m|--magic=<long> Magic key of EEPROM (required)
-o|--offset=<long> Offset of EEPROM to change
-v|--value=<long> New EEPROM value in double word
-n|--vmnic=<str> Name of vmnic to change EEPROM. (required)
Usage: esxcli network nic eeprom dump [cmd options]
Description:
dump Dump device EEPROM
Cmd options:
-l|--length=<long> Bytes of EEPROM to dump
-o|--offset=<long> Offset of EEPROM starting to dump
-n|--vmnic=<str> The name of pnic to dump EEPROM (required)
Usage: esxcli network nic get [cmd options]
Description:
get Get the generic configuration of a network device
Cmd options:
-n|--nic-name=<str> The name of the NIC to configured. This must be one of
the cards listed in the nic list command. (required)
Usage: esxcli network nic list [cmd options]
Description:
list This command will list the Physical NICs currently
installed and loaded on the system.
Cmd options:
Usage: esxcli network nic negotiate restart [cmd options]
Description:
restart Restart N-Way negotiation on a nic
Cmd options:
-n|--vmnic=<str> Name of vmnic to restart negotiation (required)
Usage: esxcli network nic register dump [cmd options]
Description:
dump Dump device registers
Cmd options:
-n|--vmnic=<str> The name of pnic to dump registers (required)
Usage: esxcli network nic selftest run [cmd options]
Description:
run Run self test
Cmd options:
-o|--online=<long> Performing limited set of tests do not inetrrupt
normal adapter operation, default is offline
-n|--vmnic=<str> The name of pnic to dump EEPROM (required)
Usage: esxcli network nic set [cmd options]
Description:
set Set the general options for the specified ethernet
device.
Cmd options:
-a|--auto Set the speed and duplexity settings to autonegotiate.
-D|--duplex=<str> The duplex to set this NIC to. Acceptable values are :
[full, half]
-l|--message-level=<long>
Sets the driver message level. Meaning differ per
driver.
-n|--nic-name=<str> The name of the NIC to configured. This must be one of
the cards listed in the nic list command. (required)
-P|--phy-address=<long>
Set the PHY address of the device
-p|--port=<str> Selects device port. Available device ports are
aui: Select aui as the device port
bnc: Select bnc as the device port
fibre: Select mii as the device port
mii: Select mii as the device port
tp: Select tp as the device port
-S|--speed=<long> The speed to set this NIC to. Acceptable values are :
[10, 100, 1000, 10000]
-t|--transceiver-type=<str>
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
-w|--wake-on-lan=<str>
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)
Usage: esxcli network nic sg get [cmd options]
Description:
get Get scatter-gather settings
Cmd options:
-n|--vmnic=<str> The name of pnic to get scatter-gather settings
Usage: esxcli network nic sg set [cmd options]
Description:
set Set scatter-gatter settings on a nic
Cmd options:
-e|--enable=<long> Enable/disable sacatter-gather (required)
-n|--vmnic=<str> Name of vmnic to configure scatter-gather settings.
(required)
Usage: esxcli network nic stats get [cmd options]
Description:
get Get NIC statistics for a given interface.
Cmd options:
-n|--nic-name=<str> Name of the NIC to get statistics from. (required)
Usage: esxcli network nic tso get [cmd options]
Description:
get Get TCP segmentation offload settings
Cmd options:
-n|--vmnic=<str> The name of pnic to get TSO settings
Usage: esxcli network nic tso set [cmd options]
Description:
set Set TCP segmentation offload settings on a nic
Cmd options:
-e|--enable=<long> TCP segmentation offload (required)
-n|--vmnic=<str> Name of vmnic to set TSO settings. (required)
Usage: esxcli network nic up [cmd options]
Description:
up Bring up the specified network device.
Cmd options:
-n|--nic-name=<str> The name of the NIC to configured. This must be one of
the cards listed in the nic list command. (required)
Usage: esxcli network nic vlan stats get [cmd options]
Description:
get List VLAN statistics for active VLAN's on the NIC.
Cmd options:
-n|--nic-name=<str> Name of the NIC to get statistics from. (required)
Usage: esxcli network nic vlan stats set [cmd options]
Description:
set Enable/disable VLAN statistics collection on the NIC.
Cmd options:
-e|--enabled Whether to enable or disable VLAN statistics
(required)
-n|--nic-name=<str> Name of the NIC to get statistics from. (required)
Usage: esxcli network port filter stats get [cmd options]
Description:
get Filter statistics for a given port.
Cmd options:
-p|--portid=<long> Port ID for the port to get filter statistics.
(required)
Usage: esxcli network port stats get [cmd options]
Description:
get Packet statistics for a given port.
Cmd options:
-p|--portid=<long> Port ID for the port to get statistics. (required)
Usage: esxcli network sriovnic list [cmd options]
Description:
list This command will list the SRIOV Enabled NICs (PFs)
currently installed and loaded on the system.
Cmd options:
Usage: esxcli network sriovnic vf list [cmd options]
Description:
list Get the generic configuration of VFs for SRIOV NIC.
Cmd options:
-n|--nic-name=<str> The name of the SRIOV NIC to configured. This must be
one of the cards listed in the sriovNic list command.
(required)
Usage: esxcli network sriovnic vf stats [cmd options]
Description:
stats Get statistics for given VF of a SRIOV NIC.
Cmd options:
-n|--nic-name=<str> The name of the SRIOV NIC. This must be one of the
cards listed in the sriovNic list command. (required)
-v|--vf-id=<long> 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)
Usage: esxcli network vm list [cmd options]
Description:
list List networking information for the VM's that have
active ports.
Cmd options:
Usage: esxcli network vm port list [cmd options]
Description:
list List of active ports for a given VM.
Cmd options:
-w|--world-id=<long> World ID of the VM for listing ports. (required)
Usage: esxcli network vswitch dvs vmware lacp config get [cmd options]
Description:
get Get LACP configuration on DVS
Cmd options:
-s|--dvs=<str> The name of DVS to get configuration on
Usage: esxcli network vswitch dvs vmware lacp stats get [cmd options]
Description:
get Get LACP stats on DVS uplinks
Cmd options:
-s|--dvs=<str> The name of DVS to get configuration on
Usage: esxcli network vswitch dvs vmware lacp status get [cmd options]
Description:
get Get LACP status on DVS
Cmd options:
-s|--dvs=<str> The name of DVS to get configuration on
Usage: esxcli network vswitch dvs vmware lacp timeout set [cmd options]
Description:
set Set long/short timeout for vmnics in one LACP LAG
Cmd options:
-l|--lag-id=<long> The ID of LAG to be configured. (required)
-n|--nic-name=<str> The nic name. If it is set, then only this vmnic in
the lag will be configured.
-t|--timeout Set long or short timeout: 1 for short timeout and 0
for long timeout. (required)
-s|--vds=<str> The name of VDS. (required)
Usage: esxcli network vswitch dvs vmware list [cmd options]
Description:
list List the VMware vSphere Distributed Switch currently
configured on the ESXi host.
Cmd options:
-v|--vds-name=<str> Limit the output of this command to only vDS with the
given name.
Usage: esxcli network vswitch dvs vmware vxlan config stats get [cmd options]
Description:
get Get VXLAN statistics config.
Cmd options:
Usage: esxcli network vswitch dvs vmware vxlan config stats set [cmd options]
Description:
set Config VXLAN statistics.
Cmd options:
--level=<long> Set to 0 to disable statistics; otherwise enable
statistics. (required)
Usage: esxcli network vswitch dvs vmware vxlan get [cmd options]
Description:
get Get VXLAN global states on the system.
Cmd options:
Usage: esxcli network vswitch dvs vmware vxlan list [cmd options]
Description:
list Get VXLAN switches info on the system.
Cmd options:
--vds-name=<str> The VDS Name used to list VXLAN DVSwitch info
Usage: esxcli network vswitch dvs vmware vxlan network arp list [cmd options]
Description:
list Dump VXLAN network ARP table of specified VDS
Cmd options:
--vds-name=<str> The VDS name used to list VXLAN network ARP table
(required)
--vxlan-id=<long> The VXLAN ID used to list VXLAN network ARP table
(required)
Usage: esxcli network vswitch dvs vmware vxlan network arp reset [cmd options]
Description:
reset Reset VXLAN network ARP table
Cmd options:
--vds-name=<str> The VDS name used to reset VXLAN network ARP table
(required)
--vxlan-id=<long> The VXLAN ID used to reset VXLAN network ARP table
(required)
Usage: esxcli network vswitch dvs vmware vxlan network list [cmd options]
Description:
list Get VXLAN network info with specified VDS.
Cmd options:
--vds-name=<str> The VDS name used to list VXLAN network info
(required)
--vxlan-id=<long> The VXLAN ID used to list VXLAN network info
Usage: esxcli network vswitch dvs vmware vxlan network mac list [cmd options]
Description:
list Dump VXLAN network MAC table of specified VDS
Cmd options:
--vds-name=<str> The VDS name used to list VXLAN network MAC table
(required)
--vxlan-id=<long> The VXLAN ID used to list VXLAN network MAC table
(required)
Usage: esxcli network vswitch dvs vmware vxlan network mac reset [cmd options]
Description:
reset Reset VXLAN network MAC table
Cmd options:
--vds-name=<str> The VDS name used to reset VXLAN network MAC table
(required)
--vxlan-id=<long> The VXLAN ID used to reset VXLAN network MAC table
(required)
Usage: esxcli network vswitch dvs vmware vxlan network mtep list [cmd options]
Description:
list Get VXLAN network MTEP table info with specified VDS.
Cmd options:
--mtep-ip=<str> Display MTEP info for only one MTEP IP
--segment-id=<str> Display MTEP info for only one Segment ID
--vds-name=<str> The VDS name used to list VXLAN network info
(required)
--vxlan-id=<long> The VXLAN ID used to list VXLAN network info
(required)
Usage: esxcli network vswitch dvs vmware vxlan network port list [cmd options]
Description:
list Get VXLAN network info with specified VDS.
Cmd options:
--vds-name=<str> The VDS name used to list VXLAN network info
(required)
--vdsport-id=<str> The VDS Port ID used to list VXLAN network info
--vxlan-id=<long> The VXLAN ID used to list VXLAN network info
(required)
Usage: esxcli network vswitch dvs vmware vxlan network port stats list [cmd options]
Description:
list Get VXLAN port statistics info.
Cmd options:
--vds-name=<str> The VDS name used to get VXLAN port statistics info
(required)
--vdsport-id=<str> The VDS Port ID used to get VXLAN port statistics info
(required)
--vxlan-id=<long> The VXLAN ID used to get VXLAN port statistics info
(required)
Usage: esxcli network vswitch dvs vmware vxlan network port stats reset [cmd options]
Description:
reset Reset VXLAN DVSwitch statistics info.
Cmd options:
--vds-name=<str> The VDS name used to reset VXLAN port statistics info
(required)
--vdsport-id=<str> The VDS Port ID used to reset VXLAN port statistics
info (required)
--vxlan-id=<long> The VXLAN ID used to reset VXLAN port statistics info
(required)
Usage: esxcli network vswitch dvs vmware vxlan network stats list [cmd options]
Description:
list Get VXLAN network statistics info.
Cmd options:
--vds-name=<str> The VDS name used to get VXLAN network statistics info
(required)
--vxlan-id=<long> The VXLAN ID used to get VXLAN network statistics info
(required)
Usage: esxcli network vswitch dvs vmware vxlan network stats reset [cmd options]
Description:
reset Reset VXLAN DVSwitch statistics info.
Cmd options:
--vds-name=<str> The VDS name used to reset VXLAN network statistics
info (required)
--vxlan-id=<long> The VXLAN ID used to reset VXLAN network statistics
info (required)
Usage: esxcli network vswitch dvs vmware vxlan stats list [cmd options]
Description:
list Get VXLAN DVSwitch statistics info.
Cmd options:
--vds-name=<str> The VDS name used to list VXLAN DVSwitch statistics
info (required)
Usage: esxcli network vswitch dvs vmware vxlan stats reset [cmd options]
Description:
reset Reset VXLAN DVSwitch statistics info.
Cmd options:
--vds-name=<str> The VDS name used to reset VXLAN DVSwitch statistics
info (required)
Usage: esxcli network vswitch dvs vmware vxlan vmknic list [cmd options]
Description:
list Get VXLAN network info with specified VDS.
Cmd options:
--endpoint-id=<long> The endpoint ID used to list VXLAN vmknic info
--vds-name=<str> The VDS name used to list VXLAN vmknic info (required)
--vmknic-ip=<str> The vmknic IP used to list VXLAN vmknic info
--vmknic-name=<str> The vmknic name used to list VXLAN vmknic info
Usage: esxcli network vswitch dvs vmware vxlan vmknic multicastgroup list [cmd options]
Description:
list Get VXLAN vmknic multicast group info.
Cmd options:
--vds-name=<str> The VDS name used to get VXLAN vmknic multicast group
info (required)
--vmknic-id=<long> The vmknic ID used to get VXLAN vmknic multicast group
info
--vmknic-ip=<str> The vmknic IP used to get VXLAN vmknic multicast group
info
--vmknic-name=<str> The vmknic name used to get VXLAN vmknic multicast
group info
Usage: esxcli network vswitch dvs vmware vxlan vmknic stats list [cmd options]
Description:
list Get VXLAN vmknic statistics info.
Cmd options:
--endpoint-id=<long> The endpoint ID used to get VXLAN vmknic statistics
info
--vds-name=<str> The VDS name used to get VXLAN vmknic statistics info
(required)
--vmknic-ip=<str> The vmknic IP used to get VXLAN vmknic statistics info
--vmknic-name=<str> The vmknic name used to get VXLAN vmknic statistics
info
Usage: esxcli network vswitch dvs vmware vxlan vmknic stats reset [cmd options]
Description:
reset Reset VXLAN vmknic statistics info.
Cmd options:
--endpoint-id=<long> The endpoint ID used to reset VXLAN vmknic statistics
info
--vds-name=<str> The VDS name used to reset VXLAN vmknic statistics
info (required)
--vmknic-ip=<str> The vmknic IP used to reset VXLAN vmknic statistics
info
--vmknic-name=<str> The vmknic name used to reset VXLAN vmknic statistics
info
Usage: esxcli network vswitch standard add [cmd options]
Description:
add Add a new virtual switch to the ESXi networking
system.
Cmd options:
-P|--ports=<long> 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.
-v|--vswitch-name=<str>
The name of the virtual switch to create. (required)
Usage: esxcli network vswitch standard list [cmd options]
Description:
list List the virtual switches current on the ESXi host.
Cmd options:
-v|--vswitch-name=<str>
Limit the output of this command to only virtual
switches with the given name.
Usage: esxcli network vswitch standard policy failover get [cmd options]
Description:
get Get the failover policy settings governing the given
virtual switch
Cmd options:
-v|--vswitch-name=<str>
The name of the virtual switch to use when fetching
the switch failover policy. (required)
Usage: esxcli network vswitch standard policy failover set [cmd options]
Description:
set Configure the Failover policy for a virtual switch.
Cmd options:
-a|--active-uplinks=<str>
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
-b|--failback Configure whether a NIC will be used immediately when
it comes back in service after a failover
-f|--failure-detection=<str>
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
-l|--load-balancing=<str>
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.
-n|--notify-switches Indicate whether to send a notification to physical
switches on failover
-s|--standby-uplinks=<str>
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
-v|--vswitch-name=<str>
The name of the virtual switch to use when configuring
the switch failover policy. (required)
Usage: esxcli network vswitch standard policy security get [cmd options]
Description:
get Get the Security Policy governing the given virtual
switch.
Cmd options:
-v|--vswitch-name=<str>
The name of the virtual switch to use when fetching
the network security policy. (required)
Usage: esxcli network vswitch standard policy security set [cmd options]
Description:
set Set the security policy for a given virtual switch
Cmd options:
-f|--allow-forged-transmits
Allow ports on the virtual switch to send packets with
forged source information.
-m|--allow-mac-change Allow ports on the virtual switch to change their MAC
address.
-p|--allow-promiscuous
Allow ports on the virtual switch to enter promiscuous
mode.
-v|--vswitch-name=<str>
The name of the virtual switch to use when setting the
switch security policy. (required)
Usage: esxcli network vswitch standard policy shaping get [cmd options]
Description:
get Get the shaping policy settings for the given virtual
switch
Cmd options:
-v|--vswitch-name=<str>
The name of the virtual switch to use when fetching
the switch shaping policy. (required)
Usage: esxcli network vswitch standard policy shaping set [cmd options]
Description:
set Set the shaping policy settings for the given virtual
switch
Cmd options:
-b|--avg-bandwidth=<long>
The averge bandwidth allowed for this shaping policy.
This value is in Kbps (1 Kbps = 1000 bits/s)
-t|--burst-size=<long>
The largest burst size allowed for this shaping
policy. This value is in Kib (1 Kib = 1024 bits)
-e|--enabled 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.
-k|--peak-bandwidth=<long>
The peak bandwidth allowed for this shaping policy.
This value is in Kbps (1 Kbps = 1000 bits/s)
-v|--vswitch-name=<str>
The name of the virtual switch to use when setting the
switch shaping policy. (required)
Usage: esxcli network vswitch standard portgroup add [cmd options]
Description:
add Allows the addition of a standard port group to a
virtual switch.
Cmd options:
-p|--portgroup-name=<str>
The name of the port group to add (required)
-v|--vswitch-name=<str>
The virtual switch to add the port group to.
(required)
Usage: esxcli network vswitch standard portgroup list [cmd options]
Description:
list List all of the port groups currently on the system.
Cmd options:
Usage: esxcli network vswitch standard portgroup policy failover get [cmd options]
Description:
get Get the network failover policy settings governing the
given port group
Cmd options:
-p|--portgroup-name=<str>
The name of the port group to use when fetching the
port group failover policy. (required)
Usage: esxcli network vswitch standard portgroup policy failover set [cmd options]
Description:
set Configure the Failover policy for a port group. These
setting may potentially override virtual switch
settings.
Cmd options:
-a|--active-uplinks=<str>
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
-b|--failback Configure whether a NIC will be used immediately when
it comes back in service after a failover
-f|--failure-detection=<str>
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
-l|--load-balancing=<str>
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.
-n|--notify-switches Indicate whether to send a notification to physical
switches on failover
-p|--portgroup-name=<str>
The name of the port group to set failover policy for.
(required)
-s|--standby-uplinks=<str>
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
-u|--use-vswitch 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.
Usage: esxcli network vswitch standard portgroup policy security get [cmd options]
Description:
get Get the Security Policy governing the given port
group.
Cmd options:
-p|--portgroup-name=<str>
The name of the port group to use when fetching the
network security policy. (required)
Usage: esxcli network vswitch standard portgroup policy security set [cmd options]
Description:
set Set the security policy for a given port group
Cmd options:
-f|--allow-forged-transmits
Allow ports on the virtual switch to send packets with
forged source information.
-m|--allow-mac-change Allow ports on the virtual switch to change their MAC
address.
-o|--allow-promiscuous
Allow ports on the virtual switch to enter promiscuous
mode.
-p|--portgroup-name=<str>
The name of the port group to set security policy for.
(required)
-u|--use-vswitch 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.
Usage: esxcli network vswitch standard portgroup policy shaping get [cmd options]
Description:
get Get the network shaping policy settings governing the
given port group
Cmd options:
-p|--portgroup-name=<str>
The name of the port group to use when fetching the
port group shaping policy. (required)
Usage: esxcli network vswitch standard portgroup policy shaping set [cmd options]
Description:
set Set the shaping policy settings for the given port
group
Cmd options:
-b|--avg-bandwidth=<long>
The averge bandwidth allowed for this shaping policy.
This value is in Kbps (1 Kbps = 1000 bits/s)
-t|--burst-size=<long>
The largest burst size allowed for this shaping
policy. This value is in Kib (1 Kib = 1024 bits)
-e|--enabled 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.
-k|--peak-bandwidth=<long>
The peak bandwidth allowed for this shaping policy.
This value is in Kbps (1 Kbps = 1000 bits/s)
-p|--portgroup-name=<str>
The name of the port group to set shaping policy for.
(required)
-u|--use-vswitch 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.
Usage: esxcli network vswitch standard portgroup remove [cmd options]
Description:
remove Remove a port group from the given virtual switch
Cmd options:
-p|--portgroup-name=<str>
(required)
-v|--vswitch-name=<str>
(required)
Usage: esxcli network vswitch standard portgroup set [cmd options]
Description:
set Set the vlan id for the given port group
Cmd options:
-p|--portgroup-name=<str>
The name of the port group to set vlan id for.
(required)
-v|--vlan-id=<long> The vlan id for this port group. This value is in the
range (0 - 4095)
Usage: esxcli network vswitch standard remove [cmd options]
Description:
remove Remove a virtual switch from the ESXi networking
system.
Cmd options:
-v|--vswitch-name=<str>
The name of the virtual switch to remove. (required)
Usage: esxcli network vswitch standard set [cmd options]
Description:
set This command sets the MTU size and CDP status of a
given virtual switch.
Cmd options:
-c|--cdp-status=<str> The CDP status of the given virtual switch. It can be
'down', 'listen', 'advertise' or 'both'
-m|--mtu=<long> The MTU size of the given virtual switch.
-v|--vswitch-name=<str>
The name of virtual switch to apply the
configurations. (required)
Usage: esxcli network vswitch standard uplink add [cmd options]
Description:
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
Cmd options:
-u|--uplink-name=<str>
The name of the uplink to add to the virtual switch.
(required)
-v|--vswitch-name=<str>
The name of the virtual switch to add an uplink to.
(required)
Usage: esxcli network vswitch standard uplink remove [cmd options]
Description:
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
Cmd options:
-u|--uplink-name=<str>
The name of the uplink to remove from the virtual
switch. (required)
-v|--vswitch-name=<str>
The name of the virtual switch to remove an uplink
from. (required)
Usage: esxcli sched reliablemem get [cmd options]
Description:
get Check if the system is currently aware of reliable
memory.
Cmd options:
Usage: esxcli sched swap system get [cmd options]
Description:
get Get current state of the options of the system-wide
shared swap space.
Cmd options:
Usage: esxcli sched swap system set [cmd options]
Description:
set Change the configuration of system-wide shared swap
space.
Cmd options:
-d|--datastore-enabled
If the datastore option should be enabled or not.
-n|--datastore-name=<str>
The name of the datastore used by the datastore
option.
-D|--datastore-order=<long>
The order of the datastore option in the preference of
the options
-c|--hostcache-enabled
If the host cache option should be enabled or not.
-C|--hostcache-order=<long>
The order of the host cache option in the preference
of the options.
-l|--hostlocalswap-enabled
If the host local swap option should be enabled or
not.
-L|--hostlocalswap-order=<long>
The order of the host local swap option in the
preference of the options.
Usage: esxcli software acceptance get [cmd options]
Description:
get Gets the host acceptance level. This controls what
VIBs will be allowed on a host.
Cmd options:
Usage: esxcli software acceptance set [cmd options]
Description:
set Sets the host acceptance level. This controls what
VIBs will be allowed on a host.
Cmd options:
--level=<str> Specifies the acceptance level to set. Should be one
of VMwareCertified / VMwareAccepted / PartnerSupported
/ CommunitySupported. (required)
Usage: esxcli software profile get [cmd options]
Description:
get Display the installed image profile.
Cmd options:
--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.
Usage: esxcli software profile install [cmd options]
Description:
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.
Cmd options:
-d|--depot=[ <str> ... ]
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.
-f|--force 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 the vSphere Client.
--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 the vSphere 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.
-p|--profile=<str> Specifies the name of the image profile to install.
(required)
--proxy=<str> Specifies a proxy server to use for HTTP, FTP, and
HTTPS connections. The format is proxy-url:port.
Usage: esxcli software profile update [cmd options]
Description:
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.
Cmd options:
--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.
-d|--depot=[ <str> ... ]
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.
-f|--force 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 the vSphere Client.
--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 the vSphere Client.
-p|--profile=<str> Specifies the name of the image profile to update the
host with. (required)
--proxy=<str> Specifies a proxy server to use for HTTP, FTP, and
HTTPS connections. The format is proxy-url:port.
Usage: esxcli software profile validate [cmd options]
Description:
validate Validates the current image profile on the host
against an image profile in a depot.
Cmd options:
-d|--depot=[ <str> ... ]
Specifies full remote URLs of the depot index.xml or
server file path pointing to an offline bundle .zip
file. (required)
-p|--profile=<str> Specifies the name of the image profile to validate
the host with. (required)
--proxy=<str> Specifies a proxy server to use for HTTP, FTP, and
HTTPS connections. The format is proxy-url:port.
Usage: esxcli software sources profile get [cmd options]
Description:
get Display details about an image profile from the depot.
Cmd options:
-d|--depot=[ <str> ... ]
Specifies full remote URLs of the depot index.xml or
server file path pointing to an offline bundle .zip
file. (required)
-p|--profile=<str> Specifies the name of the image profile to display.
(required)
--proxy=<str> Specifies a proxy server to use for HTTP, FTP, and
HTTPS connections. The format is proxy-url:port.
Usage: esxcli software sources profile list [cmd options]
Description:
list List all the image profiles in a depot.
Cmd options:
-d|--depot=[ <str> ... ]
Specifies full remote URLs of the depot index.xml or
server file path pointing to an offline bundle .zip
file. (required)
--proxy=<str> Specifies a proxy server to use for HTTP, FTP, and
HTTPS connections. The format is proxy-url:port.
Usage: esxcli software sources vib get [cmd options]
Description:
get Displays detailed information about one or more VIB
packages in the depot
Cmd options:
-d|--depot=[ <str> ... ]
Specifies full remote URLs of the depot index.xml or
server file path pointing to an offline bundle .zip
file.
--proxy=<str> Specifies a proxy server to use for HTTP, FTP, and
HTTPS connections. The format is proxy-url:port.
-n|--vibname=[ <str> ... ]
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.
-v|--viburl=[ <str> ... ]
Specifies one or more URLs to VIB packages to display
information about. http:, https:, ftp:, and file: are
all supported.
Usage: esxcli software sources vib list [cmd options]
Description:
list List all the VIBs from depots.
Cmd options:
-d|--depot=[ <str> ... ]
Specifies full remote URLs of the depot index.xml or
server file path pointing to an offline bundle .zip
file. (required)
--proxy=<str> Specifies a proxy server to use for HTTP, FTP, and
HTTPS connections. The format is proxy-url:port.
Usage: esxcli software vib get [cmd options]
Description:
get Displays detailed information about one or more
installed VIBs
Cmd options:
--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.
-n|--vibname=[ <str> ... ]
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.
Usage: esxcli software vib install [cmd options]
Description:
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.
Cmd options:
-d|--depot=[ <str> ... ]
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.
-f|--force 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 the vSphere Client.
--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 the vSphere Client.
--proxy=<str> Specifies a proxy server to use for HTTP, FTP, and
HTTPS connections. The format is proxy-url:port.
-n|--vibname=[ <str> ... ]
Specifies VIBs from a depot, using one of the
following forms: name, name:version, vendor:name, or
vendor:name:version.
-v|--viburl=[ <str> ... ]
Specifies one or more URLs to VIB packages to install.
http:, https:, ftp:, and file: are all supported.
Usage: esxcli software vib list [cmd options]
Description:
list Lists the installed VIB packages
Cmd options:
--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.
Usage: esxcli software vib remove [cmd options]
Description:
remove Removes VIB packages from the host. WARNING: If your
installation requires a reboot, you need to disable HA
first.
Cmd options:
--dry-run Performs a dry-run only. Report the VIB-level
operations that would be performed, but do not change
anything in the system.
-f|--force 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 the vSphere Client.
--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.
-n|--vibname=[ <str> ... ]
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)
Usage: esxcli software vib update [cmd options]
Description:
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.
Cmd options:
-d|--depot=[ <str> ... ]
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.
-f|--force 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 the vSphere Client.
--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 the vSphere Client.
--proxy=<str> Specifies a proxy server to use for HTTP, FTP, and
HTTPS connections. The format is proxy-url:port.
-n|--vibname=[ <str> ... ]
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.
-v|--viburl=[ <str> ... ]
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.
Usage: esxcli storage core adapter list [cmd options]
Description:
list List all the SCSI Host Bus Adapters on the system.
Cmd options:
Usage: esxcli storage core adapter rescan [cmd options]
Description:
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.
Cmd options:
-A|--adapter=<str> 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
-a|--all Indicate the rescan should rescan all adapters instead
of a specific one.
-S|--skip-claim 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.
-F|--skip-fs-scan By default after all rescan operations a filesystem
scan is performed to add newly found filesystems and
remove any filesystems that are no longer available.
Passing this flag will skip that filesystem scan.
-t|--type=<str> 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.
Usage: esxcli storage core adapter stats get [cmd options]
Description:
get List the SCSI stats for the SCSI Host Bus Adapters in
the system.
Cmd options:
-a|--adapter=<str> Limit the stats output to one adapter
Usage: esxcli storage core claiming autoclaim [cmd options]
Description:
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.
Cmd options:
-c|--claimrule-class=<str>
Indicate the claim rule class to use in this operation
[MP, Filter, VAAI, all].
--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)
-w|--wait 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.
Usage: esxcli storage core claiming reclaim [cmd options]
Description:
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.
Cmd options:
-d|--device=<str> Reclaim requires the name of a device on which all
paths will be unclaimed and then reclaimed. (required)
Usage: esxcli storage core claiming unclaim [cmd options]
Description:
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.
Cmd options:
-A|--adapter=<str> 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.
-C|--channel=<long> 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.
-c|--claimrule-class=<str>
Indicate the claim rule class to use in this operation
[MP, Filter].
-d|--device=<str> 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.
-D|--driver=<str> If the --type parameter is 'driver' attempt to unclaim
all paths provided by a specific HBA driver.
-L|--lun=<long> If the --type paramter 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.
-m|--model=<str> 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.
-p|--path=<str> If the --type parameter is 'path' attempt to unclaim a
specific path given its path UID or runtime name.
-P|--plugin=<str> 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.
-T|--target=<long> 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.
-t|--type=<str> Indicate the type of unclaim you wish to perform.
Valid values for this paramter are [location, path,
driver, device, plugin, vendor] (required)
-v|--vendor=<str> 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.
Usage: esxcli storage core claimrule add [cmd options]
Description:
add Add a claimrule to the set of claimrules on the
system.
Cmd options:
-A|--adapter=<str> Indicate the adapter of the paths to use in this
operation.
-u|--autoassign The system will auto assign a rule id.
-C|--channel=<long> Indicate the channel of the paths to use in this
operation.
-c|--claimrule-class=<str>
Indicate the claim rule class to use in this operation
[MP, Filter, VAAI].
-d|--device=<str> Indicate the Device Uid to use for this operation.
-D|--driver=<str> Indicate the driver of the paths to use in this
operation.
-f|--force Force claim rules to ignore validity checks and
install the rule anyway.
--if-unset=<str> Execute this command if this advanced user variable is
not set to 1
-i|--iqn=<str> Indicate the iSCSI Qualified Name for the target to
use in this operation.
-L|--lun=<long> Indicate the LUN of the paths to use in this
operation.
-M|--model=<str> Indicate the model of the paths to use in this
operation.
-P|--plugin=<str> Indicate which PSA plugin to use for this operation.
(required)
-r|--rule=<long> Indicate the rule ID to use for this operation.
-T|--target=<long> Indicate the target of the paths to use in this
operation.
-R|--transport=<str> Indicate the transport of the paths to use in this
operation. Valid Values are: [block, fc, iscsi,
iscsivendor, ide, sas, sata, usb, parallel, unknown]
-t|--type=<str> Indicate which type of matching used for claim/unclaim
or claimrule. Valid values are: [vendor, location,
driver, transport, device, target] (required)
-V|--vendor=<str> Indicate the vendor of the paths to user in this
operation.
--wwnn=<str> Indicate the World-Wide Node Number for the target to
use in this operation.
--wwpn=<str> Indicate the World-Wide Port Number for the target to
use in this operation.
Examples:
Add rule #321 for the Filter plugin type that will claim the given device for the VAAI Filter plugin
# esxcli storage core claimrule add -r 321 -t device -P VAAI_FILTER --claimrule-class=Filter --device=mpx.vmhba0
Add rule #321 for the VAAI plugin type that will claim the given device for the VMW_VAAIP_SYMM plugin
# esxcli storage core claimrule add -r 321 -t device -P VMW_VAAIP_SYMM --claimrule-class=VAAI --device=naa.1234
Add rule #321 that will claim the path on adapter vmhba0, channel 0, target 0, LUN 0 for the NMP plugin
# esxcli storage core claimrule add -r 321 -t location -A vmhba0 -C 0 -T 0 -L 0 -P NMP
Add rule #429 for the MP claim rule type that will claim all paths provided by an adapter with the mptscsi driver for the MASK_PATH plugin.
# esxcli storage core claimrule add -r 429 -t driver -D mptscsi -P MASK_PATH --claimrule-class=MP
Add rule #914 to claim all paths with a vendor string matching "VMWARE" and a model string "Virtual" for the NMP plugin
# esxcli storage core claimrule add -r 914 -t vendor -V VMWARE -M Virtual -P NMP
Add rule #1015 to claim all paths provided by Fibre Channel type adapters for the NMP plugin.
# esxcli storage core claimrule add -r 1015 -t transport -R fc -P NMP
Add rule #429 to claim all paths provided by Fibre Channel Target on given WWNN and WWPN.
# esxcli storage core claimrule add -r 429 -P NMP -t target -R fc --wwnn 50:06:01:60:ba:60:11:53 --wwpn 50:06:01:60:3a:60:11:53
Add rule #429 to claim paths to LUN 5 provided by iSCSI Target on given IQN.
# esxcli storage core claimrule add -r 429 -P NMP -t target -R iscsi --iqn iqn.2001-04.com.example:storage.disk2.sys1.xyz --lun 5
Add a rule with a system assigned rule id to claim all paths provided by Fibre Channel type adapters for the NMP plugin.
# esxcli storage core claimrule add --autoassign -t transport -R fc -P NMP
Usage: esxcli storage core claimrule convert [cmd options]
Description:
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.
Cmd options:
-C|--commit Force LUN mask config changes to be saved. If this
parameter is omitted, config file changes will not be
saved.
Usage: esxcli storage core claimrule list [cmd options]
Description:
list List all the claimrules on the system.
Cmd options:
-c|--claimrule-class=<str>
Indicate the claim rule class to use in this operation
[MP, Filter, VAAI, all].
Usage: esxcli storage core claimrule load [cmd options]
Description:
load Load path claiming rules from config file into the
VMkernel.
Cmd options:
-c|--claimrule-class=<str>
Indicate the claim rule class to use in this operation
[MP, Filter, VAAI, all].
Usage: esxcli storage core claimrule move [cmd options]
Description:
move Move a claimrule from one rule id to another
Cmd options:
-c|--claimrule-class=<str>
Indicate the claim rule class to use in this operation
[MP, Filter, VAAI].
-n|--new-rule=<long> Indicate the new rule id you wish to apply to the rule
given by the --rule parameter. (required)
-r|--rule=<long> Indicate the rule ID to use for this operation.
(required)
Usage: esxcli storage core claimrule remove [cmd options]
Description:
remove Delete a claimrule to the set of claimrules on the
system.
Cmd options:
-c|--claimrule-class=<str>
Indicate the claim rule class to use in this operation
[MP, Filter, VAAI].
-P|--plugin=<str> Indicate the plugin to use for this operation.
-r|--rule=<long> Indicate the rule ID to use for this operation.
Usage: esxcli storage core claimrule run [cmd options]
Description:
run Execute path claiming rules.
Cmd options:
-A|--adapter=<str> 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.
-C|--channel=<long> 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.
-c|--claimrule-class=<str>
Indicate the claim rule class to use in this operation
[MP, Filter].
-d|--device=<str> Indicate the Device Uid to use for this operation.
-L|--lun=<long> 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.
-p|--path=<str> 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.
-T|--target=<long> 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.
-t|--type=<str> 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]
-w|--wait 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.
Usage: esxcli storage core device detached list [cmd options]
Description:
list Lists all devices that were detached manually by
changing their state on the system.
Cmd options:
-d|--device=<str> Filter the output of the command to limit the output
to a specific device.
Usage: esxcli storage core device detached remove [cmd options]
Description:
remove Provide control to allow a user to remove Detached
devices from the persistent detached device list.
Cmd options:
-d|--device=<str> Select the detached device to remove from the Detached
Device List. (required)
Usage: esxcli storage core device list [cmd options]
Description:
list For devices currently registered with the PSA, list
the filters attached to them.
Cmd options:
-d|--device=<str> Filter the output of this command to only show a
single device.
Usage: esxcli storage core device partition list [cmd options]
Description:
list For a given device list all of the partitions
Cmd options:
-d|--device=<str> Filter the output to a specific device.
Usage: esxcli storage core device partition showguid [cmd options]
Description:
showguid For a given device list the GUID for GPT partitions
Cmd options:
-d|--device=<str> Filter the output to a specific device.
Usage: esxcli storage core device set [cmd options]
Description:
set Provide control to allow a user to modify a SCSI
device's state.
Cmd options:
-D|--default-name Set the default display name for the device. If there
is an existing user defined name it will be changed.
-d|--device=<str> The device you wish to operate upon. This can be any
of the UIDs that a device reports. (required)
-f|--force Force the device state to be set.
-n|--name=<str> The new name to assign the given device.
-N|--no-persist Set device state non-peristently; state is lost after
reboot.
-s|--queue-full-sample-size=<long>
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.
-q|--queue-full-threshold=<long>
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.
-O|--sched-num-req-outstanding=<long>
Set number of outstanding IOs with competing worlds.
--state=<str> Set the SCSI device state for a the specific device
given. Valid values are :
off: Set the device's state to OFF.
on: Set the device's state to ON.
Usage: esxcli storage core device setconfig [cmd options]
Description:
setconfig Set device configuration
Cmd options:
--detached Mark device as detached.
-d|--device=<str> Apply the command to a single device. (required)
--perennially-reserved
Mark device as perennially reserved.
Examples:
Mark device naa.1234 as persistently detached
# esxcli storage core device setconfig -d naa.1234 --detached=true
Mark device naa.1234 as perennially reserved. This is used in cluster environments to stop retrying IOs to quorum disks which are perennially reserve by another host, thereby speeding up boot times for other ESX hosts that share the disk
# esxcli storage core device setconfig -d naa.1234 --perennially-reserved=true
Usage: esxcli storage core device smart get [cmd options]
Description:
get List Smart device parameters.
Cmd options:
-d|--device-name=<str>
The Smart device name (required)
Usage: esxcli storage core device stats get [cmd options]
Description:
get List the SCSI stats for SCSI Devices in the system.
Cmd options:
-d|--device=<str> Limit the stats output to one specific device. This
device name can be any of the UIDs the device reports
Usage: esxcli storage core device vaai status get [cmd options]
Description:
get List VAAI properties for devices currently registered
with the PSA.
Cmd options:
-d|--device=<str> Filter the output of this command to only show a
single device.
Usage: esxcli storage core device world list [cmd options]
Description:
list Get a list of the worlds that are currently using
devices on the ESX host.
Cmd options:
-d|--device=<str> 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.
Usage: esxcli storage core path list [cmd options]
Description:
list List all the SCSI paths on the system.
Cmd options:
-d|--device=<str> Limit the output to paths to a specific device. This
name can be any of the UIDs for a specific device.
-p|--path=<str> Limit the output to a specific path. This name can be
either the UID or the runtime name of the path.
Usage: esxcli storage core path set [cmd options]
Description:
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.
Cmd options:
-p|--path=<str> Select the path to set path state on. This can be a
Runtime Name or Path UID (required)
--state=<str> Set the SCSI path state for a 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)
Usage: esxcli storage core path stats get [cmd options]
Description:
get List the SCSI stats for the SCSI Paths in the system.
Cmd options:
-p|--path=<str> Limit the stats output to one specific path. This path
name can be the runtime name or the path UID.
Usage: esxcli storage core plugin list [cmd options]
Description:
list List loaded PSA plugins on the system.
Cmd options:
-N|--plugin-class=<str>
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)
Usage: esxcli storage core plugin registration add [cmd options]
Description:
add Register a plugin module with PSA.
Cmd options:
-d|--dependencies=<str>
Add the [optional] dependencies for this module to
loaded
-I|--full-path=<str> Add the [optional] full path to this module
-m|--module-name=<str>
Select the module name to be registered (required)
-N|--plugin-class=<str>
Indicate the class of plugin to register. Allowed
values are MP, VAAI or MPP defined subplugins like
PSP, SATP. (required)
-P|--plugin-name=<str>
Select the plugin name to be registered (required)
Usage: esxcli storage core plugin registration list [cmd options]
Description:
list List modules currently registered with PSA.
Cmd options:
-m|--module-name=<str>
Filter the output of this command to only show a
single module.
-N|--plugin-class=<str>
Indicate the class of plugin to list. Allowed values
are MP, VAAI or MPP defined subplugins like PSP, SATP.
Usage: esxcli storage core plugin registration remove [cmd options]
Description:
remove UnRegister a plugin module with PSA.
Cmd options:
-m|--module-name=<str>
Select the module name to be unregistered (required)
Usage: esxcli storage filesystem automount [cmd options]
Description:
automount Request mounting of known datastores not explicitly
unmounted.
Cmd options:
Usage: esxcli storage filesystem list [cmd options]
Description:
list List the volumes available to the host. This includes
VMFS, NAS, VFAT and UFS partitions.
Cmd options:
Usage: esxcli storage filesystem mount [cmd options]
Description:
mount Connect to and mount an unmounted volume on the ESX
host.
Cmd options:
-n|--no-persist Mount the volume non-peristently; the volume will not
be mounted after a restart.
-l|--volume-label=<str>
The label of the volume to mount. This volume must be
unmounted for this operation to succeed.
-u|--volume-uuid=<str>
The UUID of the VMFS filesystem to mount. This volume
must be unmounted for this operation to succeed.
Usage: esxcli storage filesystem rescan [cmd options]
Description:
rescan Issue a rescan operation to the VMkernel to have is
scan storage devices for new mountable filesystems.
Cmd options:
Usage: esxcli storage filesystem unmount [cmd options]
Description:
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.
Cmd options:
-n|--no-persist Unmount the volume non-peristently; the volume will be
automounted after a restart.
-l|--volume-label=<str>
The label of the volume to unmount.
-p|--volume-path=<str>
The path of the volume to unmount.
-u|--volume-uuid=<str>
The uuid of the volume to unmount.
Usage: esxcli storage nfs add [cmd options]
Description:
add Add a new NAS volume to the ESX Host and mount it with
the given volume name.
Cmd options:
-H|--host=<str> The hostname or IP address of the NAS volume to add
and mount on the system. (required)
-r|--readonly If set this flag will set the mount point to be read-
only.
-s|--share=<str> The share name on the remote system to use for this
NAS mount point. (required)
-v|--volume-name=<str>
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)
Usage: esxcli storage nfs list [cmd options]
Description:
list List the NAS volumes currently known to the ESX host.
Cmd options:
Usage: esxcli storage nfs param get [cmd options]
Description:
get Get the volume parameters of the NAS volumes.
Cmd options:
-n|--volume-name=<str>
NAS volume name("all" to list all). (required)
Usage: esxcli storage nfs param set [cmd options]
Description:
set Set the volume parameters of the NAS volumes.
Cmd options:
-q|--maxqueuedepth=<long>
The maximum queue depth for the NAS volume.
-n|--volume-name=<str>
The NAS volume name. (required)
Usage: esxcli storage nfs remove [cmd options]
Description:
remove Remove an existing NAS volume from the ESX host.
Cmd options:
-v|--volume-name=<str>
The volume name of the NAS volume to remove from the
ESX host. (required)
Usage: esxcli storage nmp device list [cmd options]
Description:
list List the devices currently controlled by the VMware
NMP Multipath Plugin and show the SATP and PSP
information associated with that device.
Cmd options:
-d|--device=<str> Filter the output of this command to only show a
single device.
Usage: esxcli storage nmp device set [cmd options]
Description:
set Allow setting of the Path Selection Policy (PSP) for
the given device to one of the loaded policies on the
system.
Cmd options:
-E|--default The Path selection policy is set back to the default
for the assigned SATP for this device.
-d|--device=<str> The device you wish to set the Path Selection Policy
for. (required)
-P|--psp=<str> The Path selection policy you wish to assign to the
given device.
Usage: esxcli storage nmp path list [cmd options]
Description:
list List the paths currently claimed by the VMware NMP
Multipath Plugin and show the SATP and PSP information
associated with that path.
Cmd options:
-d|--device=<str> Filter the output of this command to only show paths
to a single device.
-p|--path=<str> Filter the output of this command to only show a
single path.
Usage: esxcli storage nmp psp fixed deviceconfig get [cmd options]
Description:
get Allow retrieving of Fixed Path Selection Policy
settings for a given device.
Cmd options:
-d|--device=<str> The device you wish to get the Preferred path for.
(required)
Usage: esxcli storage nmp psp fixed deviceconfig set [cmd options]
Description:
set Allow setting of the perferred path on a given device
controlled by the Fixed Path Selection Policy.
Cmd options:
-g|--cfgfile 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.
-E|--default Clear the preferred path selection for the given
device.
-d|--device=<str> 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)
-p|--path=<str> The path you wish to set as the preferred path for the
given device.
Usage: esxcli storage nmp psp generic deviceconfig get [cmd options]
Description:
get Allow retrieving of per device PSP configuration
parameters.
Cmd options:
-d|--device=<str> The device you wish to get PSP configuration for.
(required)
Usage: esxcli storage nmp psp generic deviceconfig set [cmd options]
Description:
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.
Cmd options:
-g|--cfgfile 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.
-c|--config=<str> The configuration string you wish to set. (required)
-d|--device=<str> The device you wish to set PSP configuration for.
(required)
Usage: esxcli storage nmp psp generic pathconfig get [cmd options]
Description:
get Allow retrieving of per path PSP configuration
parameters.
Cmd options:
-p|--path=<str> The path you wish to get PSP configuration for.
(required)
Usage: esxcli storage nmp psp generic pathconfig set [cmd options]
Description:
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.
Cmd options:
-g|--cfgfile 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.
-c|--config=<str> The configuration string you wish to set. (required)
-p|--path=<str> The path you wish to set PSP configuration for.
(required)
Usage: esxcli storage nmp psp list [cmd options]
Description:
list List the Path Selection Plugins (PSP) that are
currently loaded into the NMP system and display
information about those PSPs
Cmd options:
Usage: esxcli storage nmp psp roundrobin deviceconfig get [cmd options]
Description:
get Allow retrieving of Round Robin Path Selection Policy
settings for a given device.
Cmd options:
-d|--device=<str> The device you wish to get the Round Robin properties
for. (required)
Usage: esxcli storage nmp psp roundrobin deviceconfig set [cmd options]
Description:
set Allow setting of the Round Robin path options on a
given device controlled by the Round Robin Selection
Policy.
Cmd options:
-B|--bytes=<long> When the --type option is set to 'bytes' this is the
value that will be assigned to the byte limit value
for this device.
-g|--cfgfile 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.
-d|--device=<str> 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)
-I|--iops=<long> 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.
-t|--type=<str> 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.
-U|--useano 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
Usage: esxcli storage nmp satp generic deviceconfig get [cmd options]
Description:
get Allow retrieving of per device SATP configuration
parameters.
Cmd options:
-d|--device=<str> The device you wish to get SATP configuration for.
(required)
-e|--exclude-tpg-info Exclude TPG info from the device's SATP configuration.
Usage: esxcli storage nmp satp generic deviceconfig set [cmd options]
Description:
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.
Cmd options:
-c|--config=<str> The configuration string you wish to set. (required)
-d|--device=<str> The device you wish to set SATP configuration for.
Usage: esxcli storage nmp satp generic pathconfig get [cmd options]
Description:
get Allow retrieving of per path SATP configuration
parameters.
Cmd options:
-p|--path=<str> The path you wish to get SATP configuration for.
(required)
Usage: esxcli storage nmp satp generic pathconfig set [cmd options]
Description:
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.
Cmd options:
-c|--config=<str> The configuration string you wish to set. (required)
-p|--path=<str> The path you wish to set SATP configuration for.
(required)
Usage: esxcli storage nmp satp list [cmd options]
Description:
list List the Storage Array Type Plugins (SATP) that are
currently loaded into the NMP system and display
information about those SATPs
Cmd options:
Usage: esxcli storage nmp satp rule add [cmd options]
Description:
add Add a rule to the list of claim rules for the given
SATP.
Cmd options:
-b|--boot This is a system default rule added at boot time. Do
not modify esx.conf or add to host profile.
-c|--claim-option=<str>
Set the claim option string when adding a SATP claim
rule.
-e|--description=<str>
Set the claim rule description when adding a SATP
claim rule.
-d|--device=<str> Set the device when adding SATP claim rules. Device
rules are mutually exclusive with vendor/model and
driver rules.
-D|--driver=<str> Set the driver string when adding a SATP claim rule.
Driver rules are mutually exclusive with vendor/model
rules.
-f|--force Force claim rules to ignore validity checks and
install the rule anyway.
-M|--model=<str> Set the model string when adding SATP a claim rule.
Vendor/Model rules are mutually exclusive with driver
rules.
-o|--option=<str> Set the option string when adding a SATP claim rule.
-P|--psp=<str> Set the default PSP for the SATP claim rule.
-O|--psp-option=<str> Set the PSP options for the SATP claim rule.
-s|--satp=<str> The SATP for which a new rule will be added.
(required)
-R|--transport=<str> Set the claim transport type string when adding a SATP
claim rule.
-t|--type=<str> Set the claim type when adding a SATP claim rule.
-V|--vendor=<str> Set the vendor string when adding SATP claim rules.
Vendor/Model rules are mutually exclusive with driver
rules.
Usage: esxcli storage nmp satp rule list [cmd options]
Description:
list List the claiming rules for Storage Array Type Plugins
(SATP)
Cmd options:
-s|--satp=<str> Filter the SATP rules to a specific SATP
Usage: esxcli storage nmp satp rule remove [cmd options]
Description:
remove Delete a rule from the list of claim rules for the
given SATP.
Cmd options:
-b|--boot This is a system default rule added at boot time. Do
not modify esx.conf or add to host profile.
-c|--claim-option=<str>
The claim option string for the SATP claim rule to
delete.
-e|--description=<str>
The desription string for the SATP claim rule to
delete.
-d|--device=<str> The device for the SATP claim rule to delete
-D|--driver=<str> The driver string for the SATP claim rule to delete.
-M|--model=<str> The model string for the SATP claim rule to delete.
-o|--option=<str> The option string for the SATP claim rule to delete.
-P|--psp=<str> The default PSP for the SATP claim rule to delete.
-O|--psp-option=<str> The PSP options for the SATP claim rule to delete.
-s|--satp=<str> The SATP for which a rule will be deleted. (required)
-R|--transport=<str> The transport type for the SATP claim rule to delete.
-t|--type=<str> Set the claim type when adding a SATP claim rule.
-V|--vendor=<str> The vendor string for the SATP claim rule to delete
Usage: esxcli storage nmp satp set [cmd options]
Description:
set Set the default Path Selection Policy for a given
Storage Array Type Plugin (SATP).
Cmd options:
-b|--boot This is a system default rule added at boot time. Do
not modify esx.conf or add to host profile.
-P|--default-psp=<str>
The default path selection policy to set for a given
--satp (required)
-s|--satp=<str> The SATP name for the Storage Array Type Plugin on
which this command will operate. (required)
Usage: esxcli storage san fc events clear [cmd options]
Description:
clear Clear events for a given FC adapter on the system.
Cmd options:
-A|--adapter=<str> Issue Clear Event command to specified Fibre Channel
HBA. (required)
Usage: esxcli storage san fc events get [cmd options]
Description:
get Get Events for FC Devices
Cmd options:
-A|--adapter=<str> FC adapter name (vmhbaX), or none, to retrieve all.
Usage: esxcli storage san fc list [cmd options]
Description:
list List attributes of all FC adapters on the system.
Cmd options:
-A|--adapter=<str> FC adapter name (vmhbaX), or none, to list all.
Usage: esxcli storage san fc reset [cmd options]
Description:
reset Perform LIP (Loop Initiation Primitive) Reset to a
given FC adapter on the system.
Cmd options:
-A|--adapter=<str> Issue LIP Reset command to given Fibre Channel HBA.
(required)
Usage: esxcli storage san fc stats get [cmd options]
Description:
get Get statistics for a given FC adapter, or all FC
adapters on the system.
Cmd options:
-A|--adapter=<str> FC adapter name (vmhbaX), or none, to list all.
Usage: esxcli storage san fcoe list [cmd options]
Description:
list List attributes of all FCoE adapters on the system.
Cmd options:
-A|--adapter=<str> FCoE adapter name (vmhbaX), or none, to list all.
Usage: esxcli storage san fcoe reset [cmd options]
Description:
reset Perform LIP (Loop Initiation Primitive) Reset to a
given FCoE adapter on the system.
Cmd options:
-A|--adapter=<str> Issue LIP Reset command to given hba. (required)
Usage: esxcli storage san fcoe stats get [cmd options]
Description:
get Get statistics for a given FCoE adapter, or all FCoE
adapters on the system.
Cmd options:
-A|--adapter=<str> FCoE adapter name (vmhbaX), or none, to list all.
Usage: esxcli storage san iscsi list [cmd options]
Description:
list List attributes of all Software iSCSI adapters on the
system.
Cmd options:
-A|--adapter=<str> iSCSI adapter name (vmhbaX), or none, to list all.
Usage: esxcli storage san iscsi stats get [cmd options]
Description:
get Get statistics for Software iSCSI adapter.
Cmd options:
-A|--adapter=<str> iSCSI device name (vmhbaX), or none, to list all.
Usage: esxcli storage san sas list [cmd options]
Description:
list List all SAS IO Device Management devices.
Cmd options:
-A|--adapter=<str> SAS adapter name (vmhbaX), or none, to list all.
Usage: esxcli storage san sas reset [cmd options]
Description:
reset Perform SAS Reset
Cmd options:
-A|--adapter=<str> Issue Reset command to given hba. (required)
Usage: esxcli storage san sas stats get [cmd options]
Description:
get List Stats for given device, or all devices.
Cmd options:
-A|--adapter=<str> SAS adapter name (vmhbaX), or none, to list all.
Usage: esxcli storage vflash cache get [cmd options]
Description:
get Get individual vflash cache info.
Cmd options:
-c|--cache-name=<str> The vflash cache name (required)
-m|--module-name=<str>
The vflash module name
Usage: esxcli storage vflash cache list [cmd options]
Description:
list List individual vflash caches.
Cmd options:
-m|--module-name=<str>
The vflash module name
Usage: esxcli storage vflash cache stats get [cmd options]
Description:
get Get vflash cache statistics.
Cmd options:
-c|--cache-name=<str> The vflash cache file name (required)
-m|--module-name=<str>
The vflash module name
Usage: esxcli storage vflash cache stats reset [cmd options]
Description:
reset Reset vflash cache statistics.
Cmd options:
-c|--cache-name=<str> The vflash cache file name (required)
-m|--module-name=<str>
The vflash module name
Usage: esxcli storage vflash device list [cmd options]
Description:
list List vflash SSD devices.
Cmd options:
-e|--eligible List the eligible / ineligible SSD devices for vflash.
-u|--used List the used / unused SSD devices for vflash.
Usage: esxcli storage vflash module get [cmd options]
Description:
get Get vflash module info.
Cmd options:
-m|--module-name=<str>
The vflash module name
Usage: esxcli storage vflash module list [cmd options]
Description:
list List vflash modules.
Cmd options:
Usage: esxcli storage vflash module stats get [cmd options]
Description:
get Get vflash module statistics
Cmd options:
-m|--module-name=<str>
The vflash module name
Usage: esxcli storage vmfs extent list [cmd options]
Description:
list List the VMFS extents available on the host.
Cmd options:
Usage: esxcli storage vmfs snapshot extent list [cmd options]
Description:
list List extents of unresolved snapshots/replicas of VMFS
volume.
Cmd options:
-l|--volume-label=<str>
The VMFS volume label of the target snapshot to
enumerate.
-u|--volume-uuid=<str>
The VMFS volume uuid of the target snapshot to
enumerate.
Usage: esxcli storage vmfs snapshot list [cmd options]
Description:
list List unresolved snapshots/replicas of VMFS volume.
Cmd options:
-l|--volume-label=<str>
The VMFS volume label of the snapshot to list.
-u|--volume-uuid=<str>
The VMFS volume uuid of the snapshot to list.
Usage: esxcli storage vmfs snapshot mount [cmd options]
Description:
mount Mount a snapshot/replica of a VMFS volume.
Cmd options:
-n|--no-persist Mount the volume non-peristently; the volume will not
be automounted after a restart.
-l|--volume-label=<str>
The VMFS volume label of the snapshot to mount.
-u|--volume-uuid=<str>
The VMFS volume uuid of the snapshot to mount.
Usage: esxcli storage vmfs snapshot resignature [cmd options]
Description:
resignature Resignature a snapshot/replica of a VMFS volume.
Cmd options:
-l|--volume-label=<str>
The VMFS volume label of the snapshot to resignature.
-u|--volume-uuid=<str>
The VMFS volume uuid of the snapshot to resignature.
Usage: esxcli storage vmfs unmap [cmd options]
Description:
unmap Reclaim the space by unmapping free blocks from VMFS
Volume
Cmd options:
-n|--reclaim-unit=<long>
Number of VMFS blocks that should be unmapped per
iteration.
-l|--volume-label=<str>
The label of the VMFS volume to unmap the free blocks.
-u|--volume-uuid=<str>
The uuid of the VMFS volume to unmap the free blocks.
Usage: esxcli storage vmfs upgrade [cmd options]
Description:
upgrade Upgrade a VMFS3 volume to VMFS5.
Cmd options:
-l|--volume-label=<str>
The label of the VMFS volume to upgrade.
-u|--volume-uuid=<str>
The uuid of the VMFS volume to upgrade.
Usage: esxcli system boot device get [cmd options]
Description:
get Get the systems boot device.
Cmd options:
Usage: esxcli system coredump file add [cmd options]
Description:
add Create a VMkernel Dump VMFS file for this system.
Cmd options:
-a|--auto Automatically create a file if none found and
autoCreateDumpFile kernel option is set.
-d|--datastore=<str> Manually specify the datastore the Dump File is
created in. If not provided, a datastore of
sufficient size will be automatically chosen.
-f|--file=<str> Manually specify the file name of the created Dump
File. If not provided, a unique name will be chosen.
-s|--size=<long> Manually set the size in MB of the created Dump File.
If not provided, a default size for the current
machine will be calculated.
Usage: esxcli system coredump file get [cmd options]
Description:
get Get the dump file path. Display path to the active
and/or configured VMFS Dump File.
Cmd options:
Usage: esxcli system coredump file list [cmd options]
Description:
list List the active and configured VMFS Diagnostic Files.
Cmd options:
Usage: esxcli system coredump file remove [cmd options]
Description:
remove Remove a VMkernel Dump VMFS file from this system.
Cmd options:
-f|--file=<str> Specify the file name of the Dump File to be removed.
If not given, the configured dump file will be
removed.
-F|--force Deactivate and unconfigure the dump file being
removed. This option is required if the file is
active.
Usage: esxcli system coredump file set [cmd options]
Description:
set Set the active and configured VMkernel Dump VMFS file
for this system.
Cmd options:
-e|--enable Enable or disable the VMkernel dump file. This option
cannot be specified when unconfiguring the dump file.
-p|--path=<str> The path of the VMFS Dump File to use. This must be a
pre-allocated file.
-s|--smart This flag can be used only with --enable=true. It will
cause the file to be selected using the smart
selection algorithm.
-u|--unconfigure Unconfigure the current VMFS Dump file.
Usage: esxcli system coredump network check [cmd options]
Description:
check Check the status of the configured network dump server
Cmd options:
Usage: esxcli system coredump network get [cmd options]
Description:
get Get the currently configured parameters for network
coredump, if enabled.
Cmd options:
Usage: esxcli system coredump network set [cmd options]
Description:
set Set the parameters used for network core dump
Cmd options:
-e|--enable Enable network dump. This option cannot be specified
when setting the dump parameters below.
-v|--interface-name=<str>
An active interface to be used for the network core
dump. Required option when setting dump parameters.
-i|--server-ipv4=<str>
IP address of the core dump server. Required option
when setting dump parameters.
-o|--server-port=<long>
Port on which the core dump server is listening.
(Optional)
Usage: esxcli system coredump partition get [cmd options]
Description:
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.
Cmd options:
Usage: esxcli system coredump partition list [cmd options]
Description:
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.
Cmd options:
Usage: esxcli system coredump partition set [cmd options]
Description:
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.
Cmd options:
-e|--enable Enable or disable the VMkernel dump partition. This
option cannot be specified when setting or
unconfiguring the dump partition.
-p|--partition=<str> The name of the partition to use. This should be a
device name with a partition number at the end.
Example: naa.xxxxx:1
-s|--smart This flag can be used only with --enable=true. It will
cause the best available partition to be selected
using the smart selection algorithm.
-u|--unconfigure 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.
Usage: esxcli system hostname get [cmd options]
Description:
get Get the host, domain or fully qualified name of the
ESX host.
Cmd options:
Usage: esxcli system hostname set [cmd options]
Description:
set This command allows the user to set the hostname,
domain name or fully qualified domain name of the ESX
host.
Cmd options:
-d|--domain=<str> The domain name to set for the ESX host. This option
is mutually exclusive with the --fqdn option.
-f|--fqdn=<str> Set the fully qualified domain name of the ESX host.
-H|--host=<str> 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.
Usage: esxcli system maintenanceMode get [cmd options]
Description:
get Get the maintenance mode state of the system.
Cmd options:
Usage: esxcli system maintenanceMode set [cmd options]
Description:
set Enable or disable the maintenance mode of the system.
Cmd options:
-e|--enable enable maintenance mode (required)
-t|--timeout=<long> Time to perform operation in seconds (default 60
seconds)
Usage: esxcli system module get [cmd options]
Description:
get Show the ELF header information for the given VMkernel
module.
Cmd options:
-m|--module=<str> The name of the VMkernel module to get the option
string for. (required)
Usage: esxcli system module list [cmd options]
Description:
list List the VMkernel modules that the system knows about.
Cmd options:
-e|--enabled List the enabled / disabled VMkernel modules and
device drivers.
-l|--loaded List the loaded / not loaded VMkernel modules and
device drivers.
Usage: esxcli system module load [cmd options]
Description:
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.
Cmd options:
-f|--force Ignore the enabled/disabled state of this module and
force it to load.
-m|--module=<str> The name of the VMkernel module to load. (required)
Usage: esxcli system module parameters list [cmd options]
Description:
list List the parameters, a descriptions of each parameter
supported for a given module name and the user defined
value for each parameter.
Cmd options:
-m|--module=<str> The name of the VMkernel module to get the option
string for. (required)
Usage: esxcli system module parameters set [cmd options]
Description:
set Set the load time parameters for the given VMkernel
module.
Cmd options:
-f|--force Skip VMkernel module validity checks and set
parameters for a module (or alias) with the given
name.
-m|--module=<str> The name of the VMkernel module to set parameters for.
(required)
-p|--parameter-string=<str>
The string containing the parameters for this module.
(required)
Usage: esxcli system module set [cmd options]
Description:
set Allow enabling and disabling of a VMkernel module.
Cmd options:
-e|--enabled Set to true to enable the module, set to false to
disable the module. (required)
-f|--force Skip VMkernel module validity checks and set options
for a module (or alias) with the given name.
-m|--module=<str> The name of the VMkernel module to set options for.
(required)
Usage: esxcli system process list [cmd options]
Description:
list List the VMkernel UserWorld processes currently on the
host.
Cmd options:
Usage: esxcli system process stats load get [cmd options]
Description:
get System load average over the last 1, 5 and 15 minutes.
Cmd options:
Usage: esxcli system process stats running get [cmd options]
Description:
get Number of currently running processes.
Cmd options:
Usage: esxcli system secpolicy domain list [cmd options]
Description:
list List the enforcement level for each domain.
Cmd options:
Usage: esxcli system secpolicy domain set [cmd options]
Description:
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.
Cmd options:
-a|--all-domains All domains.
-l|--level=<str> The enforcement level. (required)
-n|--name=<str> The domain name.
Usage: esxcli system settings advanced list [cmd options]
Description:
list List the advanced options available from the VMkernel.
Cmd options:
-d|--delta Only display options whose values differ from their
default.
-o|--option=<str> Only get the information for a single VMkernel
advanced option.
-t|--tree=<str> Limit the list of advanced option to a specific sub
tree.
Usage: esxcli system settings advanced set [cmd options]
Description:
set Set the value of an advanced option.
Cmd options:
-d|--default Reset the option to its default value.
-i|--int-value=<long> If the option is an integer value use this option.
-o|--option=<str> The name of the option to set the value of. Example:
"/Misc/HostName" (required)
-s|--string-value=<str>
If the option is a string use this option.
Usage: esxcli system settings kernel list [cmd options]
Description:
list List VMkernel kernel settings.
Cmd options:
-d|--delta Only display options whose values differ from their
default.
-o|--option=<str> The name of the VMkernel kernel setting to get.
Usage: esxcli system settings kernel set [cmd options]
Description:
set Set a VMKernel setting.
Cmd options:
-s|--setting=<str> The name of the VMKernel setting to set. (required)
-v|--value=<str> The value to set the setting to. (required)
Usage: esxcli system settings keyboard layout get [cmd options]
Description:
get Get the keyboard layout
Cmd options:
Usage: esxcli system settings keyboard layout list [cmd options]
Description:
list List the keyboard layout
Cmd options:
Usage: esxcli system settings keyboard layout set [cmd options]
Description:
set Set the keyboard layout
Cmd options:
-l|--layout=<str> The name of the layout to set
--no-persist Only apply this layout for the current boot
Usage: esxcli system shutdown poweroff [cmd options]
Description:
poweroff Power off the system. The host must be in maintenance
mode.
Cmd options:
-d|--delay=<long> Delay interval in seconds
-r|--reason=<str> Reason for performing the operation (required)
Usage: esxcli system shutdown reboot [cmd options]
Description:
reboot Reboot the system. The host must be in maintenance
mode.
Cmd options:
-d|--delay=<long> Delay interval in seconds
-r|--reason=<str> Reason for performing the operation (required)
Usage: esxcli system snmp get [cmd options]
Description:
get Get SNMP Agent configuration
Cmd options:
Usage: esxcli system snmp hash [cmd options]
Description:
hash Generate localized hash values based on this agents
snmp engine id.
Cmd options:
-A|--auth-hash=<str> Provide filename to secret for authentication hash,
use in set --users (required)
-X|--priv-hash=<str> Provide filename to secret for privacy hash, use in
set --users
-r|--raw-secret Make -A and -X flags read raw secret from command line
instead of file.
Usage: esxcli system snmp set [cmd options]
Description:
set This command allows the user to set up ESX SNMP agent.
Cmd options:
-a|--authentication=<str>
Set default authentication protocol. Values: none,
MD5, SHA1
-c|--communities=<str>
Set up to ten communities each no more than 64
characters. Format is: community1[,community2,...]
(this overwrites previous settings)
-e|--enable Start or stop SNMP service. Values: [yes|no,
true|false, 0|1]
-E|--engineid=<str> Set SNMPv3 engine id. Must be at least 5 to 32
hexadecimal characters. 0x is stripped if found as
well as colons (:)
-y|--hwsrc=<str> Where to source hardware events from IPMI sensors or
CIM Indications. One of: indications|sensors
-s|--largestorage 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.
-l|--loglevel=<str> System Agent syslog logging level:
debug|info|warning|error
-n|--notraps=<str> Comma separated list of trap oids for traps not to be
sent by agent. Use value 'reset' to clear setting
-p|--port=<long> Set UDP port to poll snmp agent on. The default is
udp/161
-x|--privacy=<str> Set default privacy protocol. Values: none, AES128
-R|--remote-users=<str>
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|MD5|SHA1, priv-proto is none|AES. '-' indicates
no hash. engine-id is hex string '0x0-9a-f' up to 32
chars max.
-r|--reset Return agent configuration to factory defaults
-C|--syscontact=<str> System contact string as presented in sysContact.0. Up
to 255 characters
-L|--syslocation=<str>
System location string as presented in sysLocation.0.
Up to 255 characters.
-t|--targets=<str> 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)
-u|--users=<str> 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).
-i|--v3targets=<str> Set up to three SNMPv3 notification targets. Format
is: ip-or-hostname[@port]/remote-user/security-
level/trap|inform[,...].
Usage: esxcli system snmp test [cmd options]
Description:
test Verify ESX SNMP notifications can be delivered to
target destinations.
Cmd options:
-A|--auth-hash=<str> Optionally test authentication secret generates
matching hash for user
-X|--priv-hash=<str> Optionally test privacy secret generates matching hash
for user
-r|--raw-secret Make -A and -X flags read raw secret from command line
instead of file.
-u|--user=<str> Validate a given SNMPv3 user name exists
Usage: esxcli system stats uptime get [cmd options]
Description:
get Disply the number of microseconds the system has been
running.
Cmd options:
Usage: esxcli system syslog config get [cmd options]
Description:
get Show the current global configuration values
Cmd options:
Usage: esxcli system syslog config logger list [cmd options]
Description:
list Show the currently configured sub-loggers
Cmd options:
Usage: esxcli system syslog config logger set [cmd options]
Description:
set Set configuration options for a specific sub-logger
Cmd options:
--id=<str> The id of the logger to configure (required)
--reset=<str> Reset values to default
--rotate=<long> Number of rotated logs to keep for a specific logger
(requires --id)
--size=<long> Set size of logs before rotation for a specific
logger, in KiB (requires --id)
Usage: esxcli system syslog config set [cmd options]
Description:
set Set global log configuration options
Cmd options:
--default-rotate=<long>
Default number of rotated local logs to keep
--default-size=<long> Default size of local logs before rotation, in KiB
--default-timeout=<long>
Default network retry timeout in seconds if a remote
server fails to respond
--logdir=<str> The directory to output local logs to
--logdir-unique Place logs in a unique subdirectory of logdir, based
on hostname
--loghost=<str> The remote host(s) to send logs to
--reset=<str> Reset values to default
Usage: esxcli system syslog mark [cmd options]
Description:
mark Mark all logs with the specified string
Cmd options:
-s|--message=<str> The message to place in the logs (required)
Usage: esxcli system syslog reload [cmd options]
Description:
reload Reload the log daemon to apply any new configuration
options
Cmd options:
Usage: esxcli system time get [cmd options]
Description:
get Disply the current system time.
Cmd options:
Usage: esxcli system time set [cmd options]
Description:
set Set the system clock time. Any missing parameters will
default to the current time
Cmd options:
-d|--day=<long> Day
-H|--hour=<long> Hour
-m|--min=<long> Minute
-M|--month=<long> Month
-s|--sec=<long> Second
-y|--year=<long> Year
Usage: esxcli system uuid get [cmd options]
Description:
get Get the system UUID.
Cmd options:
Usage: esxcli system version get [cmd options]
Description:
get Display the product name, version and build
information.
Cmd options:
Usage: esxcli system visorfs get [cmd options]
Description:
get Obtain status information on the memory filesystem as
a whole.
Cmd options:
Usage: esxcli system visorfs ramdisk add [cmd options]
Description:
add Add a new Visorfs RAM disk to the ESXi Host and mount
it.
Cmd options:
-M|--max-size=<long> Maximum size (max reservation in MiB) (required)
-m|--min-size=<long> Minimum size (min reservation in MiB) (required)
-n|--name=<str> Name for the ramdisk (required)
-p|--permissions=<str>
Permissions for the root of the ramdisk (mode)
(required)
-t|--target=<str> Mountpoint for the ramdisk (absolute path) (required)
Usage: esxcli system visorfs ramdisk list [cmd options]
Description:
list List the RAM disks used by the host.
Cmd options:
Usage: esxcli system visorfs ramdisk remove [cmd options]
Description:
remove Remove a Visorfs RAM disk from the ESXi Host.
Cmd options:
-t|--target=<str> Mountpoint for the ramdisk (absolute path) (required)
Usage: esxcli system visorfs tardisk list [cmd options]
Description:
list List the tardisks used by the host.
Cmd options:
Usage: esxcli system welcomemsg get [cmd options]
Description:
get Get the Welcome Message for DCUI.
Cmd options:
Usage: esxcli system welcomemsg set [cmd options]
Description:
set Set the Welcome Message for DCUI.
Cmd options:
-m|--message=<str> Welcome Message String. (required)
Usage: esxcli vm process kill [cmd options]
Description:
kill Used to forcibly kill Virtual Machines that are stuck
and not responding to normal stop operations.
Cmd options:
-t|--type=<str> 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)
-w|--world-id=<long> The World ID of the Virtual Machine to kill. This can
be obtained from the 'vm process list' command
(required)
Usage: esxcli vm process list [cmd options]
Description:
list List the virtual machines on this system. This command
currently will only list running VMs on the system.
Cmd options:
Usage: esxcli vsan cluster get [cmd options]
Description:
get Get the information of the VSAN cluster that this host
is joined to.
Cmd options:
Usage: esxcli vsan cluster join [cmd options]
Description:
join Join the host to a given VSAN cluster.
Cmd options:
-u|--cluster-uuid=<str>
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)
-w|--wait Wait until the node joins the cluster
Usage: esxcli vsan cluster leave [cmd options]
Description:
leave Leave the VSAN cluster the host is currently joined
to.
Cmd options:
Usage: esxcli vsan cluster restore [cmd options]
Description:
restore Restore the persisted VSAN cluster configuration.
Cmd options:
Usage: esxcli vsan datastore name get [cmd options]
Description:
get Get VSAN datastore name.
Cmd options:
Usage: esxcli vsan datastore name set [cmd options]
Description:
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.
Cmd options:
--newname=<str> Set VSAN datastore name. (required)
Usage: esxcli vsan maintenancemode cancel [cmd options]
Description:
cancel Cancel an in-progress VSAN maintenance mode operation.
Cmd options:
Usage: esxcli vsan network clear [cmd options]
Description:
clear Clear the VSAN network configuration.
Cmd options:
Usage: esxcli vsan network ipv4 add [cmd options]
Description:
add Add an IPv4 interface to the VSAN network
configuration.
Cmd options:
-d|--agent-mc-addr=<str>
Optional IPv4 multicast address for agent (also called
as downstream) group.
-p|--agent-mc-port=<long>
Optional multicast address port for agent (also called
as downstream) group.
-i|--interface-name=<str>
Interface name. (required)
-u|--master-mc-addr=<str>
Optional IPv4 multicast address for master (also
called as upstream) group.
-o|--master-mc-port=<long>
Optional multicast address port for master (also
called as upstream) group.
-t|--multicast-ttl=<long>
Optional time-to-live for multicast packets.
Usage: esxcli vsan network ipv4 remove [cmd options]
Description:
remove Remove an IPv4 interface from the VSAN network
configuration.
Cmd options:
-f|--force Notify VSAN subsystem of removal, even if not
configured.
-i|--interface-name=<str>
Interface name. (required)
Usage: esxcli vsan network ipv4 set [cmd options]
Description:
set Reconfigure an IPv4 interface in the VSAN network
configuration.
Cmd options:
-d|--agent-mc-addr=<str>
Optional IPv4 multicast address for agent (also called
as downstream) group.
-p|--agent-mc-port=<long>
Optional multicast address port for agent (also called
as downstream) group.
-i|--interface-name=<str>
Interface name. (required)
-u|--master-mc-addr=<str>
Optional IPv4 multicast address for master (also
called as upstream) group.
-o|--master-mc-port=<long>
Optional multicast address port for master (also
called as upstream) group.
-t|--multicast-ttl=<long>
Optional time-to-live for multicast packets.
Usage: esxcli vsan network list [cmd options]
Description:
list List the network configuration currently in use by
VSAN.
Cmd options:
Usage: esxcli vsan network remove [cmd options]
Description:
remove Remove an interface from the VSAN network
configuration.
Cmd options:
-f|--force Notify VSAN subsystem of removal, even if not
configured.
-i|--interface-name=<str>
Interface name. (required)
Usage: esxcli vsan network restore [cmd options]
Description:
restore Restore the persisted VSAN network configuration.
Cmd options:
Usage: esxcli vsan policy cleardefault [cmd options]
Description:
cleardefault Clear default VSAN storage policy values.
Cmd options:
Usage: esxcli vsan policy getdefault [cmd options]
Description:
getdefault Get default VSAN storage policy values.
Cmd options:
-c|--policy-class=<str>
VSAN policy class whose default value to get. If not
provided, defaults for all classes will be retrieved.
Options are: [cluster, vdisk, vmnamespace, vmswap].
Usage: esxcli vsan policy setdefault [cmd options]
Description:
setdefault Set default VSAN storage policy values.
Cmd options:
-p|--policy=<str> 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 "yes" 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: No3)hostFailuresToTolerate - Defines
the number of host, disk or network failures a storage
object can tolerate. For n failures tolerated, "n+1"
copies of the object are creates and "2n+1" hosts
contributing storage are required.
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%. (required)
-c|--policy-class=<str>
VSAN policy class whose default value to set. Options
are: [cluster, vdisk, vmnamespace, vmswap].
(required)
Usage: esxcli vsan storage add [cmd options]
Description:
add Add physical disk for VSAN usage.
Cmd options:
-d|--disks=[ <str> ... ]
Specify hdds to add for use by VSAN. Expects an empty
disk with no partitions in which case the disk will be
partitioned and formatted. Otherwise this operation
will fail. The command expects the device name for the
disk to be to be provided, e.g.: mpx.vmhba2:C0:T1:L0.
Multiple hdds can be provided using format -d hdd1 -d
hdd2 -d hdd3 (required)
-s|--ssd=<str> Specify ssd to add for use by VSAN. Expects an empty
ssd with no partitions in which case the ssd will be
partitioned and formatted. Otherwise this operation
will fail. The command expects the device name for the
disk to be to be provided, e.g.: mpx.vmhba2:C0:T1:L0
(required)
Usage: esxcli vsan storage automode get [cmd options]
Description:
get Get status of storage auto claim mode.
Cmd options:
Usage: esxcli vsan storage automode set [cmd options]
Description:
set Configure storage auto claim mode
Cmd options:
--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)
Usage: esxcli vsan storage list [cmd options]
Description:
list List VSAN storage configuration.
Cmd options:
-d|--device=<str> Filter the output of this command to only show a
single device.
Usage: esxcli vsan storage remove [cmd options]
Description:
remove Remove physical disks from VSAN disk groups.
Cmd options:
-d|--disk=<str> Specify individual hdd to remove from VSAN usage.e.g.:
mpx.vmhba2:C0:T1:L0
-s|--ssd=<str> 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
-u|--uuid=<str> Specify UUID of VSAN disk.e.g.:
52afa1de-4240-d5d6-17f9-8af1ec8509e5
Usage: esxcli vsan trace set [cmd options]
Description:
set Configure VSAN trace. Please note: This command is not
thread safe.
Cmd options:
-f|--numfiles=<long> Log file rotation for VSAN trace files.
-p|--path=<str> Path to store VSAN trace files.
-r|--reset When set to true, reset defaults for VSAN trace files.
-s|--size=<long> Maximum size of VSAN trace files in MB.