ESXCLI komut kümesi, seçtiğiniz bir yönetim sunucusundan vSphere sistemlerine karşı yaygın sistem yönetimi komutlarını çalıştırmanıza olanak tanır. Komutların gerçek listesi, üzerinde çalıştığınız sisteme bağlıdır. Sisteminizdeki komutların bir listesi için esxcli –help komutunu çalıştırabilirsiniz.
ESXi 8.0 ESXCLI Command Reference
ESXCLI Komutları
| Namespace | Description |
| esxcli device | Lists descriptions of device commands. |
| esxcli esxcli | Lists descriptions of esxcli commands. |
| esxcli fcoe | FCOE (Fibre Channel over Ethernet) comands |
| esxcli graphics | Graphics commands |
| esxcli hardware | Hardware namespace. Used primarily for extracting information about the current system setup. |
| esxcli iscsi | iSCSI namespace for monitoring and managing hardware and software iSCSI. |
| esxcli network | Network namespace for managing virtual networking including virtual switches and VMkernel network interfaces. |
| esxcli nvme | Commands for managing NVMe devices. |
| esxcli rdma | Commands for monitoring RDMA devices. |
| esxcli sched | Manage the shared system-wide swap space. |
| esxcli software | Software namespace. Includes commands for managing and installing image profiles and VIBs. |
| esxcli storage | Includes core storage commands and other storage management commands. |
| esxcli system | System monitoring and management command. |
| esxcli vm | Namespace for listing virtual machines and shutting them down forcefully. |
| esxcli vsan | Namespace for vSAN management commands. See the vSphere Storage publication for details. |
esxcli daemon Commands
| COMMAND | DESCRIPTION | OPTIONS HELP |
|---|---|---|
daemon control restart | Restart the daemons for the specified solution ID. | --solution-id | -sSpecifies the solution ID to restart daemons for. (required)--helpShow the help message. |
daemon control start | Start the daemons for the specified solution ID. | --solution-id | -sSpecifies the solution ID to start daemons for. (required)--helpShow the help message. |
daemon control stop | Stop the daemons for the specified DSDK built solution. | --solution-id | -sSpecifies the solution ID to stop daemons for. (required)--helpShow the help message. |
daemon entitlement add | Add Partner REST entitlements to the partner user. | --partner-user-name | -pSpecifies the partner’s user name. (required)--read-acccess | -rGrant read access to the partner.--write-acccess | -wGrant write access to the partner.--helpShow the help message. |
daemon entitlement list | List the installed DSDK built daemons. | --partner-user-name | -pSpecifies the partner’s user name. (required)--helpShow the help message. |
daemon entitlement remove | Remove Partner REST entitlments from the partner user. | --partner-user-name | -pSpecifies the partner’s user name. (required)--read-acccess | -rRemove read access from the partner.--write-acccess | -wRemove write access from the partner.--helpShow the help message. |
daemon info get | Get running daemon status for the specified solution ID. | --solution-id | -sSpecifies the solution-id to get status for. (required)--helpShow the help message. |
daemon info list | List the installed DSDK built daemons. | --helpShow the help message. |
esxcli device Commands
| COMMAND | DESCRIPTION | OPTIONS HELP |
|---|---|---|
device add | Add a device to enable a software device driver. | --device-identifier | -dDevice identifier from the device specification for the software device driver. Valid input is in reverse domain name format (e.g. com.company.device). (required)--instance-address | -iUnique number to address this instance of the device, if multiple instances of the same device identifier are added. Valid values are integer in the range 0-31. Default is 0.--helpShow the help message. |
device alias get | Display hardware location info for a device alias. | --alias | -nAlias to lookup (required)--helpShow the help message. |
device alias list | List device aliases. | --helpShow the help message. |
device driver list | Show driver status for specific devices. | --devices | -dList of device aliases to look up.--helpShow the help message. |
device software add | Add a device to enable a software device driver. | --device-identifier | -dDevice identifier from the device specification for the software device driver. Valid input is in reverse domain name format (e.g. com.company.device…). (required)--instance-address | -iUnique number to address this instance of the device, if multiple instances of the same device identifier are added. Valid values are integer in the range 0-31. Default is 0.--helpShow the help message. |
device software list | List software devices. | --helpShow the help message. |
device software remove | Remove a software device. | --device-identifier | -dDevice identifier from the device specification for the software device driver. Valid input is in reverse domain name format (e.g. com.company.device…). (required)--instance-address | -iUnique number to address this instance of the device.--helpShow the help message. |
esxcli esxcli Commands
| COMMAND | DESCRIPTION | OPTIONS HELP |
|---|---|---|
esxcli command list | List all of the esxcli commands. | --command-filter | -cShow only commands containing the specified string in their name.--description-filter | -dShow only commands containing the specified string in their description.--namespace-filter | -nShow only commands containing the specified string in their namespace path.--helpShow the help message. |
esxcli fcoe Commands
| COMMAND | DESCRIPTION | OPTIONS HELP |
|---|---|---|
fcoe adapter list | List FCOE-capable CNA devices (Deprecated). | --helpShow the help message. |
fcoe adapter remove | Initiate FCOE adapter removal (Deprecated). | --adapter-name | -aThe FCOE adapter name (vmhbaX) (required)--helpShow the help message. |
fcoe nic disable | Disable rediscovery of FCOE storage on behalf of an FCOE-capable CNA upon next boot (Deprecated). | --nic-name | -nThe CNA adapter name (vmnicX) (required)--helpShow the help message. |
fcoe nic discover | Initiate FCOE adapter discovery on behalf of an FCOE-capable CNA (Deprecated). | --nic-name | -nThe CNA adapter name (vmnicX) (required)--helpShow the help message. |
fcoe nic enable | Enable an FCOE-capable NIC if it is disabled (Deprecated). | --nic-name | -nThe CNA adapter name (vmnicX) (required)--helpShow the help message. |
fcoe nic list | List FCOE-capable CNA devices (Deprecated). | --helpShow the help message. |
fcoe nic remove | Deactivate FCOE configuration for given NIC (Deprecated). | --nic-name | -nThe CNA adapter name (vmnicX) (required)--helpShow the help message. |
fcoe nic set | Set options on FCOE-capable CNA (Deprecated). | --enable-vn2vn | -VEnable or Disable VN2VN mode on the nic (Reboot Required)--nic-name | -nThe CNA adapter name (vmnicX) (required)--priority | -pPriority class (0 – 7) to use for FCOE traffic--vlan-id | -vThe VLAN id for this nic, range ‘0 – 4095′(Reboot Required)--helpShow the help message. |
esxcli graphics Commands
| COMMAND | DESCRIPTION | OPTIONS HELP |
|---|---|---|
graphics device list | List all of the graphics devices on this host. | --configured-typeGet graphics devices configured state.--helpShow the help message. |
graphics device set | Set graphics device property. If setting “type”, restart Xorg e.g. “/etc/init.d/xorg restart” for change to take effect. | --device-id | -dThe bus ID of the PCI device (e.g., 0000:0a:00.1). (required)--type | -tDevice graphics type. Allowed types areShared: Shared graphics. SharedPassthru: SharedPassthru graphics. (required) --helpShow the help message. |
graphics device stats list | List graphics device statistics. | --helpShow the help message. |
graphics host get | Get host graphics properties. | --helpShow the help message. |
graphics host refresh | Refresh host graphics properties. | --helpShow the help message. |
graphics host set | Set host graphics properties. | --default-typeHost default graphics type.--shared-passthru-assignment-policyShared passthru assignment policy.--helpShow the help message. |
graphics vm list | List active VMs associated with graphics devices. | --helpShow the help message. |
esxcli hardware Commands
| COMMAND | DESCRIPTION | OPTIONS HELP |
|---|---|---|
hardware bootdevice list | List the boot device order, if available, for this host. | --helpShow the help message. |
hardware clock get | Display the current hardware clock time. | --helpShow the help message. |
hardware clock set | Set the hardware clock time. Any missing parameters will default to the current time. | --day | -dDay--hour | -HHour--min | -mMinute--month | -MMonth--sec | -sSecond--year | -yYear--helpShow the help message. |
hardware cpu list | List all of the CPUs on this host. | --helpShow the help message. |
hardware cpu cpuid get | Get subset of CPUID fields for a CPU (deprecated, use: esxcli hardware cpu cpuid raw list). | --cpu | -cThe ID of the CPU to query for CPUID data. (required)--helpShow the help message. |
hardware cpu cpuid raw list | Get all CPUID fields for a CPU. | --cpu | -cThe ID of the CPU to query for all CPUID data. (required)--helpShow the help message. |
hardware cpu global get | Get properties that are global to all CPUs. | --helpShow the help message. |
hardware cpu global set | Set properties that are global to all CPUs. | --hyperthreading | -tEnable or disable hyperthreading (required)--helpShow the help message. |
hardware devicecomponent list | List all device components on this host. | --helpShow the help message. |
hardware ipmi bmc get | Get IPMI Baseboard Management Controller (BMC) properties. | --helpShow the help message. |
hardware ipmi bmc set | Set IPMI Baseboard Management Controller (BMC) properties. Changes take effect immediately. | --os-hostname | -HOS hostname that BMC will report.--os-name | -nOS name that BMC will report.--os-version | -vOS system version that BMC will report.--helpShow the help message. |
hardware ipmi fru get | Get IPMI Field Replaceable Unit (FRU) device details. | --ignore-missing | -iDo not fail command if ipmi device is not present--include-all-sensors | -aInclude all SDR entries including those for entities that do not exist, or have no health state.--include-pretty-raw | -pInclude a hex dump where each byte is separated by a space and its value is presented with two hexidecimal characters using a leading zero if needed--include-raw | -rInclude a hex dump where the value of each byte is presented as hexidecimal characters joined without spaces--node | -nSpecify which IPMI device (0..3) to query, defaults to ‘all’ for all ipmi nodes--helpShow the help message. |
hardware ipmi fru list | List IPMI Field Replaceable Unit (FRU) inventory. | --ignore-missing | -iDo not fail command if ipmi device is not present--include-all-sensors | -aInclude all SDR entries including those for entities that do not exist, or have no health state.--include-pretty-raw | -pInclude a hex dump where each byte is separated by a space and its value is presented with two hexidecimal characters using a leading zero if needed--include-raw | -rInclude a hex dump where the value of each byte is presented as hexidecimal characters joined without spaces--node | -nSpecify which IPMI device (0..3) to query, defaults to ‘all’ for all ipmi nodes--helpShow the help message. |
hardware ipmi sdr get | Get IPMI Sensor Data Repository (SDR) properties. | --ignore-missing | -iDo not fail command if ipmi device is not present--include-all-sensors | -aInclude all SDR entries including those for entities that do not exist, or have no health state.--include-pretty-raw | -pInclude a hex dump where each byte is separated by a space and its value is presented with two hexidecimal characters using a leading zero if needed--include-raw | -rInclude a hex dump where the value of each byte is presented as hexidecimal characters joined without spaces--node | -nSpecify which IPMI device (0..3) to query, defaults to ‘all’ for all ipmi nodes--helpShow the help message. |
hardware ipmi sdr list | List IPMI Sensor Data Repository. | --formatter | -fOverride the formatter to use for a given command. Available formatter: simple ,table.--ignore-missing | -iDo not fail command if ipmi device is not present--include-all-sensors | -aInclude all SDR entries including those for entities that do not exist, or have no health state.--include-pretty-raw | -pInclude a hex dump where each byte is separated by a space and its value is presented with two hexidecimal characters using a leading zero if needed--include-raw | -rInclude a hex dump where the value of each byte is presented as hexidecimal characters joined without spaces--node | -nSpecify which IPMI device (0..3) to query, defaults to ‘all’ for all ipmi nodes--helpShow the help message. |
hardware ipmi sel clear | Clear IPMI System Event Log. | --ignore-missing | -iDo not fail command if ipmi device is not present--include-all-sensors | -aInclude all SDR entries including those for entities that do not exist, or have no health state.--include-pretty-raw | -pInclude a hex dump where each byte is separated by a space and its value is presented with two hexidecimal characters using a leading zero if needed--include-raw | -rInclude a hex dump where the value of each byte is presented as hexidecimal characters joined without spaces--node | -nSpecify which IPMI device (0..3) to query, defaults to ‘all’ for all ipmi nodes--helpShow the help message. |
hardware ipmi sel get | Get IPMI System Event Log (SEL) properties. | --ignore-missing | -iDo not fail command if ipmi device is not present--include-all-sensors | -aInclude all SDR entries including those for entities that do not exist, or have no health state.--include-pretty-raw | -pInclude a hex dump where each byte is separated by a space and its value is presented with two hexidecimal characters using a leading zero if needed--include-raw | -rInclude a hex dump where the value of each byte is presented as hexidecimal characters joined without spaces--node | -nSpecify which IPMI device (0..3) to query, defaults to ‘all’ for all ipmi nodes--helpShow the help message. |
hardware ipmi sel list | List IPMI System Event Log. | --ignore-missing | -iDo not fail command if ipmi device is not present--include-all-sensors | -aInclude all SDR entries including those for entities that do not exist, or have no health state.--include-pretty-raw | -pInclude a hex dump where each byte is separated by a space and its value is presented with two hexidecimal characters using a leading zero if needed--include-raw | -rInclude a hex dump where the value of each byte is presented as hexidecimal characters joined without spaces--node | -nSpecify which IPMI device (0..3) to query, defaults to ‘all’ for all ipmi nodes--helpShow the help message. |
hardware memory get | Get information about memory. | --helpShow the help message. |
hardware pci list | List all of the PCI devices on this host. | --class | -cFilter the PCI devices based on their hexadecimal Class ID--mask | -mMask the filter provided by the class flag--helpShow the help message. |
hardware pci pcipassthru list | Display PCI device passthru configuration. | --helpShow the help message. |
hardware pci pcipassthru set | Configure PCI device for passthrough. | --apply-now | -aIf this flag is present, the change takes effect immediately; otherwise the change takes effect after a host reboot. This flag causes the device to be unbound from its native driver andbound to the VMkernel’s PCI passthrough driver(or vice-versa depending on the setting of the –enable parameter).--device-id | -dThe bus ID of the PCI device (e.g., 0000:0a:00.1). (required)--enable | -eEnable or disable passthrough of the device. (required)--helpShow the help message. |
hardware platform get | Get information about the platform | --helpShow the help message. |
hardware power policy get | Display the current power policy. | --helpShow the help message. |
hardware power policy set | Set the power policy. | --id | -iPower policy numeric id--name | -nPower policy name--short-name | -sPower policy short name--helpShow the help message. |
hardware power policy choices list | List the power policies. | --helpShow the help message. |
hardware smartcard certificate list | Certificates from inserted smart cards. | --slot | -sList certificates from only the token in the given slot.--helpShow the help message. |
hardware smartcard info get | Information about the smart card subsystem. | --helpShow the help message. |
hardware smartcard slot list | Information about connected smart card readers. | --helpShow the help message. |
hardware smartcard token list | Information about inserted smart cards. | --slot | -sList tokens only for the given slot.--helpShow the help message. |
hardware tpm tag clear | Clear the TPM’s tag. | --helpShow the help message. |
hardware tpm tag get | Get the TPM’s tag. | --helpShow the help message. |
hardware tpm tag set | Set the TPM’s tag. | --data | -dThe tag data to store in the TPM in hexadecimal byte encoding. Format: a string matching the regular expression [0-9a-fA-F]{1,1024}. (required)--helpShow the help message. |
hardware trustedboot get | Information about the status of trusted boot. (TPM, DRTM status) | --helpShow the help message. |
hardware usb passthrough device disable | Disable usb passthrough | --device | -dThe device you wish to disable passthrough for. Please enter the Bus#,Dev#,vendorId and productId of the device in the format Bus#:Dev#:vendorId:productId using hexadecimal values(as shown by the list command) (required)--helpShow the help message. |
hardware usb passthrough device enable | Enable usb passthrough | --device | -dThe device you wish to enable passthrough for. Please note that this command only makes the device eligible for passthrough. The device can be connected to the VM only if usbarbitrator is running. See /etc/init.d/usbarbitrator status to check the status of the usbarbitrator. Please enter the information of the device in the format Bus#:Dev#:vendorId:productId using hexadecimal values(as shown by the list command) (required)--helpShow the help message. |
hardware usb passthrough device list | List usb devices and their passthrough status | --helpShow the help message. |
esxcli iscsi Commands
| COMMAND | DESCRIPTION | OPTIONS HELP |
|---|---|---|
iscsi adapter get | List the iSCSI information for the iSCSI Host Bus Adapter. | --adapter | -AThe iSCSI adapter name. (required)--helpShow the help message. |
iscsi adapter list | List all the iSCSI Host Bus Adapters on the system. | --adapter | -AThe iSCSI adapter name.--helpShow the help message. |
iscsi adapter set | Set the iSCSI name and alias for the iSCSI Host Bus Adapter. | --adapter | -AThe iSCSI adapter name. (required)--alias | -aThe iSCSI initiator alias.--name | -nThe iSCSI initiator name.--skip-if-session-active | -sDo not change initiator name if a session is active on the adapter.--helpShow the help message. |
iscsi adapter auth chap get | Get the iSCSI CHAP authentication for the iSCSI Host Bus Adapter. | --adapter | -AThe iSCSI adapter name. (required)--direction | -dThe iSCSI CHAP authentication direction. Options are: [uni, mutual]--helpShow the help message. |
iscsi adapter auth chap set | Set the iSCSI CHAP authentication for the iSCSI Host Bus Adapter. | --adapter | -AThe iSCSI adapter name. (required)--authname | -NThe iSCSI CHAP authentication name--default | -DResetting iSCSI CHAP authenthication setting to default.--direction | -dThe iSCSI CHAP authentication direction. Options are: [uni, mutual]--level | -lThe iSCSI CHAP authentication level. Options are: [prohibited, discouraged, preferred, required]--secret | -SThe iSCSI CHAP authentication secret. The recommended length is at least 12 bytes. (secret)--helpShow the help message. |
iscsi adapter capabilities get | List the iSCSI details for the iSCSI Host Bus Adapter. | --adapter | -AThe iSCSI adapter name. (required)--helpShow the help message. |
iscsi adapter discovery rediscover | Do the iSCSI Discovery for the iSCSI Host Bus Adapter. | --adapter | -AThe iSCSI adapter name. (required)--helpShow the help message. |
iscsi adapter discovery sendtarget add | Add a sendtarget address | --adapter | -AThe iSCSI adapter name. (required)--address | -aThe iSCSI sendtarget address: <ip/dns[:port]>. IPv6 address can be specified as [XX:XX:XX:XX::XX]:port or XX:XX:XX:XX::XX (required)--helpShow the help message. |
iscsi adapter discovery sendtarget list | List sendtarget addresses | --adapter | -AThe iSCSI adapter name.--helpShow the help message. |
iscsi adapter discovery sendtarget remove | Remove a sendtarget address | --adapter | -AThe iSCSI adapter name. (required)--address | -aThe iSCSI sendtarget address: <ip/dns[:port]>. IPv6 address can be specified as [XX:XX:XX:XX::XX]:port or XX:XX:XX:XX::XX (required)--force | -fForce the removal of discovery address even when sessions are running.--helpShow the help message. |
iscsi adapter discovery sendtarget auth chap get | Get iSCSI CHAP authentication on a sendtarget address | --adapter | -AThe iSCSI adapter name. (required)--address | -aThe iSCSI sendtarget address: <ip/dns[:port]> (required)--direction | -dThe iSCSI authentication direction. Options are: [uni, mutual]--helpShow the help message. |
iscsi adapter discovery sendtarget auth chap set | Set iSCSI CHAP authentication on a sendtarget address | --adapter | -AThe iSCSI adapter name. (required)--address | -aThe iSCSI sendtarget address: <ip/dns[:port]> (required)--authname | -NThe iSCSI authentication name--default | -DResetting iSCSI authentication setting to default.--direction | -dThe iSCSI authentication direction. Options are: [uni, mutual]--inherit | -IInheriting iSCSI authentication setting from parent.--level | -lThe iSCSI authentication level. Options are: [prohibited, discouraged, preferred, required]--secret | -SThe iSCSI authentication secret. The recommended length is at least 12 bytes. (secret)--helpShow the help message. |
iscsi adapter discovery sendtarget param get | Get iSCSI parameter on a sendtarget address | --adapter | -AThe iSCSI adapter name. (required)--address | -aThe iSCSI sendtarget address: <ip/dns[:port]> (required)--helpShow the help message. |
iscsi adapter discovery sendtarget param set | Set the iSCSI parameter for the iSCSI Sendtarget. | --adapter | -AThe iSCSI adapter name. (required)--address | -aThe iSCSI sendtarget address: <ip/dns[:port]> (required)--default | -DResetting iSCSI parameter setting to default.--inherit | -IInheriting iSCSI parameter setting from parent.--key | -kThe iSCSI parameter key (required)--value | -vThe iSCSI parameter value--helpShow the help message. |
iscsi adapter discovery statictarget add | Add a static target address | --adapter | -AThe iSCSI adapter name. (required)--address | -aThe iSCSI target address: <ip/dns[:port]>. IPv6 address can be specified as [XX:XX:XX:XX::XX]:port or XX:XX:XX:XX::XX (required)--name | -nThe iSCSI target name. (required)--helpShow the help message. |
iscsi adapter discovery statictarget list | List static target addresses | --adapter | -AThe iSCSI adapter name.--helpShow the help message. |
iscsi adapter discovery statictarget remove | Remove a static target | --adapter | -AThe iSCSI adapter name. (required)--address | -aThe iSCSI target address: <ip/dns[:port]>. IPv6 address can be specified as [XX:XX:XX:XX::XX]:port or XX:XX:XX:XX::XX (required)--name | -nThe iSCSI target name. (required)--helpShow the help message. |
iscsi adapter discovery status get | Get the iSCSI adapter discovery status for the iSCSI Host Bus Adapter. | --adapter | -AThe iSCSI adapter name. (required)--helpShow the help message. |
iscsi adapter firmware get | Validate the iSCSI firmware for the iSCSI Host Bus Adapter. | --adapter | -AThe iSCSI adapter name. (required)--file | -fPath to the firmware file to retrieve information from. (required)--helpShow the help message. |
iscsi adapter firmware set | Upload the iSCSI firmware for the iSCSI Host Bus Adapter. | --adapter | -AThe iSCSI adapter name. (required)--file | -fPath to the firmware file to download. (required)--helpShow the help message. |
iscsi adapter param get | Get the iSCSI parameters for the iSCSI Host Bus Adapter. | --adapter | -AThe iSCSI adapter name. (required)--helpShow the help message. |
iscsi adapter param set | Set the iSCSI parameter for the iSCSI Host Bus Adapter. | --adapter | -AThe iSCSI adapter name. (required)--default | -DResetting iSCSI parameter setting to default.--key | -kThe iSCSI initiator parameter key. (required)--value | -vThe iSCSI initiator parameter value.--helpShow the help message. |
iscsi adapter target list | List iSCSI targets. | --adapter | -AThe iSCSI adapter name.--name | -nThe iSCSI target name.--helpShow the help message. |
iscsi adapter target lun list | Get iSCSI LUN information | --adapter | -AThe iSCSI adapter name.--target | -tThe iSCSI target number. If a target number is specified, an adapter name must also be specified.--helpShow the help message. |
iscsi adapter target portal list | List iSCSI target portals. | --adapter | -AThe iSCSI adapter name.--name | -nThe iSCSI target name.--helpShow the help message. |
iscsi adapter target portal auth chap get | Get iSCSI CHAP authentication on a target | --adapter | -AThe iSCSI adapter name. (required)--address | -aThe iSCSI target address: <ip/dns[:port]> (required)--direction | -dThe iSCSI authentication direction. Options are: [uni, mutual]--method | -mThe iSCSI authentication method. Options are: [chap]--name | -nThe iSCSI target name: <iqn/eui> (required)--helpShow the help message. |
iscsi adapter target portal auth chap set | Set the iSCSI CHAP authentication for the iSCSI Target. | --adapter | -AThe iSCSI adapter name. (required)--address | -aThe iSCSI target address: <ip/dns[:port]> (required)--authname | -NThe iSCSI authentication name--default | -DResetting iSCSI authentication setting to default.--direction | -dThe iSCSI authentication direction. Options are: [uni, mutual]--inherit | -IInheriting iSCSI authentication setting from parent.--level | -lThe iSCSI authentication level. Options are: [prohibited, discouraged, preferred, required]--name | -nThe iSCSI target name: <iqn/eui> (required)--secret | -SThe iSCSI authentication secret. The recommended length is at least 12 bytes. (secret)--helpShow the help message. |
iscsi adapter target portal param get | Get iSCSI parameter on a target | --adapter | -AThe iSCSI adapter name. (required)--address | -aThe iSCSI target address: <ip/dns[:port]> (required)--name | -nThe iSCSI target name: <iqn/eui> (required)--helpShow the help message. |
iscsi adapter target portal param set | Set the iSCSI parameter for the iSCSI Target. | --adapter | -AThe iSCSI adapter name. (required)--address | -aThe iSCSI target address: <ip/dns[:port]> (required)--default | -DResetting iSCSI parameter setting to default.--inherit | -IInheriting iSCSI parameter setting from parent.--key | -kThe iSCSI parameter key (required)--name | -nThe iSCSI target name: <iqn/eui> (required)--value | -vThe iSCSI parameter value--helpShow the help message. |
iscsi ibftboot get | Get iSCSI IBFT Boot details. | --helpShow the help message. |
iscsi ibftboot import | Import iSCSI target configuration from iBFT to ESX iSCSI initiators. The boot target recorded in iBFT is added to all the eligible ‘dependent’ iSCSI adapters. | --helpShow the help message. |
iscsi logicalnetworkportal list | List Logical Network Portals for iSCSI Adapter | --adapter | -AThe iSCSI adapter name.--helpShow the help message. |
iscsi networkportal add | Add a network portal for iSCSI adapter | --adapter | -AThe iSCSI adapter name. (required)--force | -fThe force flag (force add of iSCSI vmknic even it’s not compatible for iscsi multipathing)--nic | -nThe iSCSI network portal (bound vmknic) (required)--helpShow the help message. |
iscsi networkportal list | List Network Portal for iSCSI Adapter | --adapter | -AThe iSCSI adapter name.--helpShow the help message. |
iscsi networkportal remove | Remove a network portal for iSCSI adapter | --adapter | -AThe iSCSI adapter name. (required)--force | -fThe force flag (force removal of iSCSI vmknic when sessions are active using it)--nic | -nThe iSCSI network portal (bound vmknic) (required)--helpShow the help message. |
iscsi networkportal ipconfig get | Get iSCSI network portal ipv4 configuration | --adapter | -AThe iSCSI adapter name. (required)--nic | -nThe iSCSI network portal (vmknic)--helpShow the help message. |
iscsi networkportal ipconfig set | Set iSCSI network portal IPv4 configuration. | --adapter | -AThe iSCSI adapter name. (required)--dns1 | -xThe iSCSI network portal primary DNS address--dns2 | -yThe iSCSI network portal secondary DNS address--enable | -eEnable/Disable IPv4. All other options will be ignored if IPv4 is being disabled.--enable-dhcpv4 | -dEnable/Disable IPv4 configuration using DHCPv4. If DHCPv4 is being enabled, static configuration parameters (ip,subnet,gateway,dns1,dns2) are ignored.--gateway | -gThe iSCSI network portal IPv4 gateway address--ip | -iThe iSCSI network portal IPv4 address--nic | -nThe iSCSI network portal (vmknic)--subnet | -sThe iSCSI network portal IPv4 subnet mask--helpShow the help message. |
iscsi networkportal ipv6config get | Get iSCSI network portal ipv6 configuration | --adapter | -AThe iSCSI adapter name. (required)--helpShow the help message. |
iscsi networkportal ipv6config set | Set iSCSI network portal IPv6 configuration. | --adapter | -AThe iSCSI adapter name. (required)--enable | -eEnable/Disable IPv6--enable-dhcpv6 | -dEnable/Disable IPv6 configuration using DHCPv6--enable-linklocal-autoconfiguration | -lEnable/Disable auto configuration of linklocal address--enable-router-advertisement | -rEnable/Disable IPv6 configuration using Router Advertisement--gateway6 | -gThe iSCSI network portal IPv6 gateway address--helpShow the help message. |
iscsi networkportal ipv6config address add | Add IPv6 addresses to the given iSCSI network portal. | --adapter | -AThe iSCSI adapter name. (required)--address-list | -aAn IPv6 address to add in X:X:X::/X format. Multiple addresses can be provided using format -a address1 -a address2 -a address3.--remove-all-existing | -rRemove all existing routable IPv6 addresses before adding the addresses specified by –address-list. If this flag is passed and –address-list is empty, all existing routable addresses are removed.--helpShow the help message. |
iscsi networkportal ipv6config address list | List the IPv6 addresses assigned to the iSCSI network portal. | --adapter | -AThe iSCSI adapter name. (required)--helpShow the help message. |
iscsi networkportal ipv6config address remove | Remove IPv6 addresses from the given iSCSI network portal. | --adapter | -AThe iSCSI adapter name. (required)--address-list | -aAn IPv6 address to remove in X:X:X::/X format. Multiple addresses can be provided using format -a address1 -a address2 -a address3. (required)--helpShow the help message. |
iscsi physicalnetworkportal list | List Physical Network Portal for iSCSI Adapter | --adapter | -AThe iSCSI adapter name.--helpShow the help message. |
iscsi physicalnetworkportal param get | Get network parameters on a Physical Network Portal (vmnic) | --adapter | -AThe iSCSI adapter name. (required)--nic | -nThe physical network portal name: <vmnic>--helpShow the help message. |
iscsi physicalnetworkportal param set | Set network parameter on a Physical Network Portal | --adapter | -AThe iSCSI adapter name. (required)--nic | -nThe physical network portal name: <vmnic>--option | -oThe network parameter option. Supported options are [MTU, ArpRedirect]. (required)--value | -vInput value for a Physical Network Portal option (use 0/1 for bool, and number for int) (required)--helpShow the help message. |
iscsi plugin list | List IMA plugins. | --adapter | -AThe iSCSI adapter name.--plugin | -pThe IMA plugin file name.--helpShow the help message. |
iscsi session add | Login sessions on current iSCSI configuration. | --adapter | -AThe iSCSI adapter name. (required)--isid | -sThe isid of a session to duplicate for login.--name | -nThe iSCSI target name.--helpShow the help message. |
iscsi session list | List iSCSI Sessions. | --adapter | -AThe iSCSI adapter name.--isid | -sThe iSCSI session identifier.--name | -nThe iSCSI target name.--helpShow the help message. |
iscsi session remove | Logout sessions on current iSCSI configuration. | --adapter | -AThe iSCSI adapter name. (required)--isid | -sThe iSCSI session id of a session to be removed.--name | -nThe name of the target to be removed.--helpShow the help message. |
iscsi session connection list | List iSCSI connections. | --adapter | -AThe iSCSI adapter name.--cid | -cThe iSCSI connection identifier(CID).--isid | -sThe iSCSI session identifier(ISID).--name | -nThe iSCSI target name.--helpShow the help message. |
iscsi software get | Software iSCSI information. | --helpShow the help message. |
iscsi software set | Enable or disable software iSCSI. | --enabled | -eEnable or disable the module. (required)--name | -nThe iSCSI initiator name.The initiator name must not be specified when disabling software iSCSI. --helpShow the help message. |
esxcli network Commands
| COMMAND | DESCRIPTION | OPTIONS HELP |
|---|---|---|
network diag ping | Send ICMP echo requests to network hosts. | --count | -cSpecify the number of packets to send.--debug | -DVMKPing debug mode.--df | -dSet DF bit on IPv4 packets.--host | -HSpecify the host to send packets to. This parameter is required when not executing ping in debug mode (-D)--interface | -ISpecify the outgoing interface.--interval | -iSet the interval for sending packets in seconds.--ipv4Ping with ICMPv4 echo requests.--ipv6Ping with ICMPv6 echo requests.--netstackSpecify the TCP/IP netstack which the interface resides on--nexthop | -NOverride the system’s default route selection, in dotted quad notation. (IPv4 only. Requires interface option)--size | -sSet the payload size of the packets to send.--ttl | -tSet IPv4 Time To Live or IPv6 Hop Limit--wait | -WSet the timeout to wait if no responses are received in seconds.--helpShow the help message. |
network ens lcore add | Create ENS context. | --lcore-id | -lENS context id to be created. (required)--helpShow the help message. |
network ens lcore list | List ENS contexts. | --helpShow the help message. |
network ens lcore remove | Destroy ENS context. | --lcore-id | -lENS context id to be destroyed. (required)--helpShow the help message. |
network ens lcore affinity get | Get the affinity for given ENS context. | --lcore-id | -lENS context id. (required)--helpShow the help message. |
network ens lcore affinity set | Set affinity for given ENS context. | --affinity | -aNuma node affinity. (required)--lcore-id | -lENS context id. (required)--helpShow the help message. |
network ens lcore switch add | Associate given ENS context with given switch. | --lcore-id | -lENS context id. (required)--switch | -sSwitch name. (required)--helpShow the help message. |
network ens lcore switch get | Get the switch associated with given ENS context. | --lcore-id | -lENS context id. (required)--helpShow the help message. |
network ens lcore switch remove | Disassociate given ENS context from virtual switch. | --lcore-id | -lENS context id. (required)--helpShow the help message. |
network ens maxLcores get | Get the maximum number of ENS contexts (lcores). | --helpShow the help message. |
network ens maxLcores set | Set the maximum number of ENS contexts. | --maxlcores | -nNumber of maximum ENS contexts to be assigned. (required)--helpShow the help message. |
network firewall get | Get the firewall status. | --helpShow the help message. |
network firewall load | Load firewall module and rulesets configuration. | --helpShow the help message. |
network firewall refresh | Load ruleset configuration for firewall. | --helpShow the help message. |
network firewall set | Set firewall enabled status and default action. | --default-action | -dSet to true to set defaultaction PASS, set to false to DROP.--enabled | -eSet to true to enable the firewall, set to false to disable the firewall.--helpShow the help message. |
network firewall unload | Allow unload firewall module. | --helpShow the help message. |
network firewall ruleset list | List the rulesets in firewall. | --ruleset-id | -rList configuration for specfic ruleset--helpShow the help message. |
network firewall ruleset set | Set firewall ruleset status (allowedAll flag and enabled status). | --allowed-all | -aSet to true to allowed all ip, set to false to use allowed ip list.--enabled | -eSet to true to enable ruleset, set to false to disable it.--ruleset-id | -rThe label of the ruleset. (required)--helpShow the help message. |
network firewall ruleset allowedip add | Add allowed ip address/range to the ruleset ruleset. | --ip-address | -iAllowed ip address/range for the ruleset. (required)--ruleset-id | -rThe label of the ruleset. (required)--helpShow the help message. |
network firewall ruleset allowedip list | list allowed ip addresses for rulesets. | --ruleset-id | -rThe label of the ruleset.--helpShow the help message. |
network firewall ruleset allowedip remove | Remove allowed ip address/range from the ruleset. | --ip-address | -iAllowed ip address/range for the ruleset. (required)--ruleset-id | -rThe label of the ruleset. (required)--helpShow the help message. |
network firewall ruleset client add | Add a new client to a firewall ruleset. This enables the firewall ruleset and increments the number of clients using the ruleset. | --ruleset-id | -rThe label of the ruleset. (required)--helpShow the help message. |
network firewall ruleset client get | Show the number of clients using a firewall ruleset. | --ruleset-id | -rThe label of the ruleset. (required)--helpShow the help message. |
network firewall ruleset client remove | Remove a client from a firewall ruleset. This decrements the number of clients using the ruleset and if the number reaches zero the ruleset is disabled. | --ruleset-id | -rThe label of the ruleset. (required)--helpShow the help message. |
network firewall ruleset rule list | List the rules of each ruleset in firewall. | --ruleset-id | -rList rules for specfic ruleset--helpShow the help message. |
network ip get | Get global IP settings | --helpShow the help message. |
network ip set | Update global IP settings | --ipv6-enabled | -eEnable or disable IPv6 (Reboot Required)--helpShow the help message. |
network ip connection list | List active TCP/IP connections | --netstack | -NThe network stack instance; if unspecified, use the default netstack instance--type | -tConnection type: [ip, tcp, udp, all]--helpShow the help message. |
network ip dns search add | Add a search domain to the list of domains to be searched when trying to resolve an host name on the ESXi host. | --domain | -dThe string name of a domain to add to the list of search domains. (required)--netstack | -NThe network stack instance; if unspecified, use the default netstack instance--helpShow the help message. |
network ip dns search list | List the search domains currently configured on the ESXi host in the order in which they will be used when searching. | --netstack | -NThe network stack instance; if unspecified, use the default netstack instance--helpShow the help message. |
network ip dns search remove | Remove a search domain from the list of domains to be searched when trying to resolve an host name on the ESXi host. | --domain | -dThe string name of a domain to remove from the list of search domains. (required)--netstack | -NThe network stack instance; if unspecified, use the default netstack instance--helpShow the help message. |
network ip dns server add | Add a new DNS server to the end of the list of DNS servers to use for this ESXi host. | --netstack | -NThe network stack instance; if unspecified, use the default netstack instance--server | -sThe IP address (v4 or v6) of the DNS server to add to the DNS server list. (required)--helpShow the help message. |
network ip dns server list | Print a list of the DNS server currently configured on the system in the order in which they will be used. | --netstack | -NThe network stack instance; if unspecified, use the default netstack instance--helpShow the help message. |
network ip dns server remove | Remove a DNS server from the list of DNS servers to use for this ESXi host. | --all | -a--netstack | -NThe network stack instance; if unspecified, use the default netstack instance--server | -s--helpShow the help message. |
network ip hosts add | Add association of IP addresses with host names. | --alias | -AThe list of aliases of the host.--comment | -CComment line of this item--hostname | -HThe name of the host. (required)--ip | -IThe IP address (v4 or v6) of the host. (required)--helpShow the help message. |
network ip hosts list | List the user specified associations of IP addresses with host names. | --helpShow the help message. |
network ip hosts remove | Remove association of IP addresses with host names. | --hostname | -HThe name of the host. (required)--ip | -IThe IP address (v4 or v6) of the host. (required)--helpShow the help message. |
network ip interface add | Add a new VMkernel network interface. | --dvport-id | -PDVPort ID of the connection point. This requires –dvs-name to be given in the same command--dvs-name | -sDVSwitch name of the connection point. This requires –dvport-id to be given in the same command--interface-name | -iThe name of the VMkernel network interface to create. This name must be in the form vmkX, where X is a number 0-255--mac-address | -MSet the MAC address for the newly created VMkernel network interface.--mtu | -mSet the MTU setting for a given VMkernel network interface on creation--netstack | -NThe network stack instance; if unspecified, use the default netstack instance--num-rxqueue | -RSet the number of RX dispatch queues for a given VMkernel network interface on creation--portgroup-name | -pThe name of the vswitch port group to add this VMkernel network interface to.--helpShow the help message. |
network ip interface list | This command will list the VMkernel network interfaces currently known to the system. | --netstack | -NThe network stack instance; if unspecified, consider all netstack instances--type | -tList VMkernel network interfaces with given type(e.g. system).--helpShow the help message. |
network ip interface remove | Remove a VMkernel network interface from the ESXi host. A VMKernel network interface can be uniquely specified by –interface-name or –portgroup-name or –dvs-name/–dvport-id. i.e. Providing its name or its connection point are two ways to uniquely specify a VMKernel network interface. | --dvport-id | -PDVPort ID of the connection point. This requires –dvs-name to be given in the same command--dvs-name | -sDVSwitch name of the connection point. This requires –dvport-id to be given in the same command--interface-name | -iThe name of the VMkernel network interface to remove. This name must be in the form vmkX, where X is a number 0-255--netstack | -NThe network stack instance; if unspecified, use the default netstack instance--portgroup-name | -pThe name of the vswitch port group to delete this VMkernel network interface from.--helpShow the help message. |
network ip interface set | This command sets the enabled status and MTU size of a given IP interface | --enabled | -eSet to true to enable the interface, set to false to disable it.--interface-name | -iThe name of the interface to apply the configurations. (required)--mtu | -mThe MTU size of the IP interface.--helpShow the help message. |
network ip interface ipv4 get | List the IPv4 addresses assigned to VMkernel network interfaces. | --interface-name | -iThe name of the VMkernel network interface to limit the output of this command to.--netstack | -NThe network stack instance; if unspecified, consider all netstack instances--type | -tList IPv4 information of VMkernel network interface with given type(e.g. system).--helpShow the help message. |
network ip interface ipv4 set | Configure IPv4 setting for a given VMkernel network interface. | --gateway | -gThe default gateway for this interface. The value must be a valid IPv4 address. Gateway would be reset if not provided--interface-name | -iThe name of the VMkernel network interface to set IPv4 settings for. This name must be an interface listed in the interface list command. (required)--ipv4 | -IThe static IPv4 address for this interface.--netmask | -NThe static IPv4 netmask for this interface.--peer-dns | -PA boolean value to indicate if the system should use the DNS settings published via DHCPv4 for this interface.--type | -tIPv4 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. --helpShow the help message. |
network ip interface ipv4 address list | List the IPv4 addresses assigned to VMkernel network interfaces. | --interface-name | -iThe name of the VMkernel network interface to limit the output of this command to.--netstack | -NThe network stack instance; if unspecified, consider all netstack instances--type | -tList IPv4 information of VMkernel network interface with given type(e.g. system).--helpShow the help message. |
network ip interface ipv6 get | Get IPv6 settings for VMkernel network interfaces. This does not include the IPv6 addresses which can be found in the “address list” command. | --interface-name | -nThe name of the VMkernel network interface to limit the output of this command to.--netstack | -NThe network stack instance; if unspecified, consider all netstack instances--type | -tList IPv6 information of VMkernel network interface with given type(e.g. system).--helpShow the help message. |
network ip interface ipv6 set | Configure IPv6 settings for a given VMkernel network interface. | --enable-dhcpv6 | -dSetting this value to true will enable DHCPv6 on this interface and attempt to aquire an IPv6 address from the network--enable-ipv6 | -eSetting this value to true enables IPv6 on thisinterface while setting it to false disables IPv6 on this interface.--enable-router-adv | -rSetting this value to true will enable IPv6 Router Advertised IPv6 addresses to be added to this interface from any routers broadcasting on the local network.--gateway | -gA default gateway for this interface. The value must be a valid IPv6 address.--interface-name | -iThe name of the VMkernel network interface to set IPv6 settings for. This name must be an interface listed in the interface list command. (required)--peer-dns | -PA boolean value to indicate if the system should use the DNS settings published via DHCPv6 for this interface.--helpShow the help message. |
network ip interface ipv6 address add | Add a static IPv6 address to a given VMkernel network interface. | --interface-name | -iThe name of the VMkernel network interface to add a static IPv6 address to. This name must be an interface listed in the interface list command. (required)--ipv6 | -IThe IPv6 address to add to the given VMkernel network interface. This must be in X:X:X::/X format (required)--helpShow the help message. |
network ip interface ipv6 address list | This command will list all of the IPv6 addresses currently assigned to the system | --interface-name | -iThe name of the VMkernel network interface to limit the output of this command to.--type | -tList IPv6 addresses of VMkernel network interface with given type(e.g. system).--helpShow the help message. |
network ip interface ipv6 address remove | Remove an IPv6 address from a given VMkernel network interface. | --interface-name | -iThe name of the VMkernel network interface to remove an IPv6 address from. This name must be an interface listed in the interface list command. (required)--ipv6 | -IThe IPv6 address to remove from the given VMkernel network interface. This must be in X:X:X::/X format (required)--helpShow the help message. |
network ip interface tag add | Adds a tag on a given VMkernel network interface. Supported tags are: Management, VMotion, faultToleranceLogging, vSphereReplication, vSphereReplicationNFC, vSphereProvisioning, VSAN, VSANWitness, vSphereBackupNFC, PrecisionTimeProtocol, NVMeTCP, NVMeRDMA | --interface-name | -iThe name of the VMkernel network interface on which tags should be set. This name must be an interface listed in the interface list command. (required)--tagname | -tTag name to assign to the interface (required)--helpShow the help message. |
network ip interface tag get | Gets the tags set on the given VMkernel network interface. | --interface-name | -iName of vmknic whose tags are to be read (required)--helpShow the help message. |
network ip interface tag remove | Removes a tag on a given VMkernel network interface. | --interface-name | -iThe name of the VMkernel network interface from which tags should be removed. This name must be an interface listed in the interface list command. (required)--tagname | -tTag name to assign to the interface (required)--helpShow the help message. |
network ip ipsec sa add | Add a Security Association. | --encryption-algorithm | -eEncryption algorithm for the Security Association. Should be one in set [null, 3des-cbc, aes128-cbc]. (required)--encryption-key | -kEncryption key(ASCII or hex). Length of hex key is dependent upon algorithm used. Required when a encryption algorithm has been specified.--integrity-algorithm | -iIntegrity algorithm for the Security Association. Should be one in set [hmac-sha1, hmac-sha2-256]. (required)--integrity-key | -KIntegrity key(ASCII or hex). Length of hex key is dependent upon algorithm used. (required)--sa-destination | -dIpv6 address of Security Association destination. Can be specified as ‘any’ or a correct IPv6 address. (required)--sa-mode | -mSecurity Association mode. Should be one in set [transport, tunnel].--sa-name | -nName for the Security Association to be added. (required)--sa-source | -sIpv6 address of Security Association source. Can be specified as ‘any’ or a correct IPv6 address. (required)--sa-spi | -pSPI value for the Security Association(hex). (required)--helpShow the help message. |
network ip ipsec sa list | List configured Security Associations | --helpShow the help message. |
network ip ipsec sa remove | Operation to remove Security Association(s) | --remove-all | -aSet to remove all Security Associations.--sa-destination | -dIpv6 address of Security Association destination. This option needs to be specified when removing an auto SA.--sa-name | -nName for the Security Association to be removed. Specify ‘auto’ to remove an auto SA.--sa-source | -sIpv6 address of Security Association source. This option needs to be specified when removing an auto SA.--sa-spi | -pSPI value for the Security Association (hex). This option needs to be specified when removing an auto SA--helpShow the help message. |
network ip ipsec sp add | Add a Security Policy. | --action | -AAction for Security Policy. Should be one in set [none, discard, ipsec].--destination-port | -PDestination Port for Security Policy. ‘0’ stands for ‘any’ (required)--flow-direction | -wFlow direction for Security Policy. Should be one in set [in, out].--sa-name | -aName for the Security Association. Not being Specified lets vmkernel automatically choose an Security Association. If no applicable Security Association exists, then vmkernel may request one using IKE.--source-port | -pSource Port for Security Policy. ‘0’ stands for ‘any’ (required)--sp-destination | -dIpv6 address and prefix length of Security Policy destination. Can be specified as ‘any’ or a correct Ipv6 network address. (required)--sp-mode | -mSecurity Policy mode. Should be one in set [transport, tunnel].--sp-name | -nName for the Security Policy to be added. (required)--sp-source | -sIpv6 address and prefix length of Security Policy source. Can be specified as ‘any’ or a correct IPv6 network address. (required)--upper-layer-protocol | -uUpper layer protocol for Security Policy, Should be one in set [any, tcp, udp, icmp6].--helpShow the help message. |
network ip ipsec sp list | List configured Security Policys | --helpShow the help message. |
network ip ipsec sp remove | Operation to remove Security Policy | --remove-all | -aSet to remove all Security Policys--sp-name | -nName for the Security Policy to be removed.--helpShow the help message. |
network ip neighbor list | List ARP table entries | --interface-name | -iThe name of the VMkernel network interface to limit the output of this command to; if unspecified, list neighbors on all interfaces.--netstack | -NThe network stack instance; if unspecified, use the default netstack instance--type | -tList IP neighbors with given type(e.g. system).--version | -vIP version: [4, 6, all]--helpShow the help message. |
network ip neighbor remove | Remove ARP table entries | --interface-name | -iThe name of the VMkernel network interface to remove the neighbor entry from. If not specified, neighbor will be removed from all interfaces--neighbor-addr | -aThe IPv4/IPv6 address of the neighbor. (required)--netstack | -NThe network stack instance; if unspecified, use the default netstack instance--version | -vIP version: [4, 6] (required)--helpShow the help message. |
network ip netstack add | Add a new Netstack Instance. | --disabled | -dCreate the netstack instance only in config i.e. in disabled state. Does not create in kernel.--netstack | -NThe network stack instance (required)--helpShow the help message. |
network ip netstack get | Get runtime/configuration settings for a given Netstack Instance. | --netstack | -NThe network stack instance (required)--helpShow the help message. |
network ip netstack list | This command will list the VMkernel Netstack instances currently known to the system. | --helpShow the help message. |
network ip netstack remove | Remove a new Netstack Instance. | --netstack | -NThe network stack instance (required)--helpShow the help message. |
network ip netstack set | Configure settings for a given Netstack Instance. | --ccalgo | -cThe TCP Congestion Contol Algorithm for this netstack instance (not applied to existing connections).:cubic: Set cubic as the algorithm dctcp: Set dctcp as the algorithm newreno: Set newreno as the algorithm --ecnThe status of ECN (Explicit Congestion Notification).disabled: Completely disable ECN functionality echo-only: Only echoing ECN, won’t initiate enabled: Fully enable ECN functionality --enable | -eEnable the netstack instance (create in kernel)--ipv6enabled | -iTo enable IPv6 for this netstack instance (aplied only during netstack creation).--maxconn | -mThe maximum number of connections for this netstack instance (applied only during netstack creation).--name | -nThe name for this netstack instance.--netstack | -NThe network stack instance. This name must be an interface listed in the netstack list command. (required)--helpShow the help message. |
network ip route ipv4 add | Add IPv4 route to the VMkernel. | --gateway | -gThe Ipv4 address of the gateway through which a route to be added. (required)--netstack | -NThe network stack instance; if unspecified, use the default netstack instance--network | -nThe Ipv4 address and prefix length of the network to add the route to. Specify ‘default’ to indicate the default network. (required)--helpShow the help message. |
network ip route ipv4 list | List configured IPv4 routes | --netstack | -NThe network stack instance; if unspecified, use the default netstack instance--type | -tList IPv4 routes with given type(e.g. system).--helpShow the help message. |
network ip route ipv4 remove | Remove IPv4 route | --gateway | -gThe Ipv4 address of the gateway through which a route to be removed (required)--netstack | -NThe network stack instance; if unspecified, use the default netstack instance--network | -nThe Ipv4 address and prefix length of the network to remove the route from. Specify ‘default’ to indicate the default network. (required)--helpShow the help message. |
network ip route ipv6 add | Add IPv6 route to the VMkernel. | --gateway | -gThe Ipv6 address of the gateway through which a route to be added. (required)--netstack | -NThe network stack instance; if unspecified, use the default netstack instance--network | -nThe Ipv6 address and prefix length of the network to add the route to. Specify ‘default’ to indicate the default network. (required)--helpShow the help message. |
network ip route ipv6 list | List configured IPv6 routes | --netstack | -NThe network stack instance; if unspecified, use the default netstack instance--type | -tList IPv6 routes with given type(e.g. system).--helpShow the help message. |
network ip route ipv6 remove | Remove IPv6 route from the VMkernel | --gateway | -gThe Ipv6 address of the gateway through which a route to be removed (required)--netstack | -NThe network stack instance; if unspecified, use the default netstack instance--network | -nThe Ipv6 address and prefix length of the network to remove the route from. Specify ‘default’ to indicate the default network. (required)--helpShow the help message. |
network multicast group list | List all the multicast group members. | --helpShow the help message. |
network nic down | Bring down the specified network device. | --nic-name | -nThe name of the NIC to configured. This must be one of the cards listed in the nic list command. (required)--helpShow the help message. |
network nic get | Get the generic configuration of a network device | --nic-name | -nThe name of the NIC to configured. This must be one of the cards listed in the nic list command. (required)--helpShow the help message. |
network nic list | This command will list the Physical NICs currently installed and loaded on the system. | --helpShow the help message. |
network nic set | Set the general options for the specified ethernet device. | --auto | -aSet the speed and duplexity settings to autonegotiate.--duplex | -DThe duplex to set this NIC to. Acceptable values are: [full, half]--message-level | -lSets the driver message level. Meaning differ per driver.--nic-name | -nThe name of the NIC to configured. This must be one of the cards listed in the nic list command. (required)--phy-address | -PSet the PHY address of the device--port | -pSelects device port. Available device ports areaui: Select AUI (Attachment Unit Interface) as the device port backplane: Select Backplane as the device port bnc: Select BNC (Bayonet Neill-Concelman) as the device port da: Select DA (Direct Attach copper) as the device port fibre: Select fibre as the device port mii: Select MII (Media Independent Interface) as the device port tp: Select TP (Twisted Pair) as the device port --speed | -SThe speed to set this NIC to, in Mbps. Acceptable values are: [10, 100, 1000, 2500, 5000, 10000, 20000, 25000, 40000, 50000, 56000, 75000, 100000, 200000, 400000]--transceiver-type | -tSelects transeiver type. Currently only internal and external can be specified, in the future future types might be added. Available transeiver types areexternal: Set the transceiver type to external internal: Set the transceiver type to internal --virtual-address | -VSet the virtual address of the device--wake-on-lan | -wSets 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) --helpShow the help message. |
network nic up | Bring up the specified network device. | --nic-name | -nThe name of the NIC to configured. This must be one of the cards listed in the nic list command. (required)--helpShow the help message. |
network nic attachment add | Attach one uplink as a branch to a trunk uplink with specified VLAN ID. | --branch | -bThe name of the NIC to be attached as branch uplink. (required)--trunk | -tThe name of the NIC to be configured as trunk uplink. (required)--vlan-id | -vThe vlan ID for the branch uplink. Valid values: integer in the range 1-4094 (required)--helpShow the help message. |
network nic attachment list | Show uplink attachment information. | --trunk | -tShow information only for the specified NIC.--helpShow the help message. |
network nic attachment remove | Detach a branch uplink from its trunk. | --branch | -bThe name of the branch uplink. (required)--trunk | -tThe name of the trunk uplink. (required)--helpShow the help message. |
network nic coalesce get | Get coalesce parameters | --vmnic | -nThe name of pnic to get coalesce parameters--helpShow the help message. |
network nic coalesce set | Set coalesce parameters on a nic | --adaptive-rx | -aenable or disable adaptive RX algorithm in driver.--adaptive-tx | -Aenable or disable adaptive TX algorithm in driver.--rx-max-frames | -RMaximum number of RX frames driver to process before interrupting.--rx-usecs | -rNumber of microseconds driver to wait for RX before interrupting.--sample-interval | -iPacket rate sampling internal in seconds for the adaptive coalescing algorithm in driver.--tx-max-frames | -TMaximum number of completed TX frames driver to process before interrupting.--tx-usecs | -tNumber of microseconds driver to wait for completed TX before interrupting.--vmnic | -nName of vmnic to set coalesce parameters. (required)--helpShow the help message. |
network nic coalesce high get | Get information about the behavior of a NIC when it sends or receives packets at high packet rate. | --vmnic | -nThe name of the pnic for which information should be retrieved. (required)--helpShow the help message. |
network nic coalesce high set | Set parameters to control the behavior of a NIC when it sends or receives packets at high packet rate. | --pkt-rate | -pThe high packet rate measured in number of packets per second. When packet rate is above this parameter, the RX/TX coalescing parameters configured by this command are used.--rx-max-frames | -RThe maximum number of RX packets to delay an RX interrupt after they arrive under high packet rate conditions.--rx-usecs | -rThe number of microseconds to delay an RX interrupt after a packet arrives under high packet rate conditions.--tx-max-frames | -TThe maximum number of TX packets to delay an TX interrupt after they are sent under high packet rate conditions.--tx-usecs | -tThe number of microseconds to delay a TX interrupt after a packet is sent under high packet rate conditions.--vmnic | -nName of the vmnic for which parameters should be set. (required)--helpShow the help message. |
network nic coalesce low get | Get information about the behavior of a NIC when it sends or receives packets at low packet rate. | --vmnic | -nThe name of the pnic for which information should be retrieved. (required)--helpShow the help message. |
network nic coalesce low set | Set parameters to control the behavior of a NIC when it sends or receives packets at low packet rate. | --pkt-rate | -pThe low packet rate measured in number of packets per second. When packet rate is below this parameter, the RX/TX coalescing parameters configured by this command are used.--rx-max-frames | -RThe maximum number of RX packets to delay an RX interrupt after they arrive under low packet rate conditions.--rx-usecs | -rThe number of microseconds to delay an RX interrupt after a packet arrives under low packet rate conditions.--tx-max-frames | -TThe maximum number of TX packets to delay an TX interrupt after they are sent under low packet rate conditions.--tx-usecs | -tThe number of microseconds to delay a TX interrupt after a packet is sent under low packet rate conditions.--vmnic | -nName of the vmnic for which parameters should be set. (required)--helpShow the help message. |
network nic cso get | Get checksum offload settings | --vmnic | -nThe name of pnic to get CSO settings--helpShow the help message. |
network nic cso set | Set checksum offload settings on a nic | --enable | -eRX/TX checksum offload (required)--vmnic | -nName of vmnic to set offload settings. (required)--helpShow the help message. |
network nic dcb status get | Get the DCB information for a NIC. | --nic-name | -nThe name of the NIC for which you need the info. See “nic list” command. (required)--helpShow the help message. |
network nic eeprom change | Change EEPROM on a nic | --file | -fFile name of new EEPROM content--magic | -mMagic key of EEPROM (required)--offset | -oOffset of EEPROM to change--value | -vNew EEPROM value in double word--vmnic | -nName of vmnic to change EEPROM. (required)--helpShow the help message. |
network nic eeprom dump | Dump device EEPROM | --length | -lBytes of EEPROM to dump--offset | -oOffset of EEPROM starting to dump--vmnic | -nThe name of pnic to dump EEPROM (required)--helpShow the help message. |
network nic hwCap activated list | List activated hardware capabilities of physical NICs. | --vmnic | -nLimit the output to only the physical NICS with the specified names.--helpShow the help message. |
network nic hwCap supported list | List supported hardware capabilities of physical NICs. | --vmnic | -nLimit the output to only the physical NICS with the specified names.--helpShow the help message. |
network nic negotiate restart | Restart N-Way negotiation on a nic | --vmnic | -nName of vmnic to restart negotiation (required)--helpShow the help message. |
network nic pauseParams list | List pause parameters of all NICs | --nic-name | -nThe name of the NIC whose pause parameters should be retrieved.--helpShow the help message. |
network nic pauseParams set | Set pause parameters for a NIC | --auto | -aEnable/disable auto negotiation.--nic-name | -nName of NIC whose pause parameters should be set. (required)--rx | -rEnable/disable pause RX flow control.--tx | -tEnable/disable pause TX flow control.--helpShow the help message. |
network nic queue count get | Get netqueue count on a nic | --vmnic | -nThe name of pnic to get netqueue count--helpShow the help message. |
network nic queue count set | Set number of netqueues on a nic | --num | -qNumber of queues to set. (required)--rx | -rRx netqueue to set count.--tx | -tTx netqueue to set count.--vmnic | -nName of vmnic to set netqueue count. (required)--helpShow the help message. |
network nic queue filterclass list | List the netqueue supported filterclass of all physical NICs currently installed and loaded on the system. | --helpShow the help message. |
network nic queue loadbalancer list | List the load balancer settings of all the installed and loaded physical NICs. (S:supported, U:unsupported, N:not-applicable, A:allowed, D:disallowed). | --helpShow the help message. |
network nic queue loadbalancer set | Enable/disable netqueue load balancer setting on a NIC. | --dynpoollbConfigure Dynamic queue pool at netqueue load balancer.--geneveoamlbConfigure Geneve OAM at netqueue load balancer.--lrolbConfigure Large Receive Offload at netqueue load balancer.--maclearnlbConfigure Mac learn load balancing at netqueue load balancer.--rsslbConfigure Receive Side Scaling at netqueue load balancer.--rsslrolbConfigure Receive Side Scaling with Large Receive Offload at netqueue load balancer.--rxdynlbConfigure RX dynamic load balancing at netqueue load balancer.--rxqlatencyConfigure Rx queue latency at netqueue load balancer.--rxqnofeatConfigure Rx queue no feature at netqueue load balancer.--rxqpairConfigure Rx queue pair at netqueue load balancer.--rxqpreemptConfigure pre-emptible queue at netqueue load balancer.--vmnic | -nName of vmnic to update netqueue load balancer setting. (required)--helpShow the help message. |
network nic queue loadbalancer plugin list | Details of netqueue balancer plugins on all physical NICs currently installed and loaded on the system | --vmnic | -nThe name of pnic to get netqueue plugin details--helpShow the help message. |
network nic queue loadbalancer plugin set | Enable/disable netqueue balancer plugin on a NIC | --enable | -eNetqueue balancer plugin state (required)--module | -mName of netqueue balancer module (required)--plugin | -pName of netqueue balancer plugin (required)--vmnic | -nName of vmnic to change netqueue balancer plugin state (required)--helpShow the help message. |
network nic queue loadbalancer state list | Netqueue balancer state of all physical NICs currently installed and loaded on the system | --vmnic | -nThe name of pnic to get netqueue balancer state--helpShow the help message. |
network nic queue loadbalancer state set | Enable/disable netqueue balancer on a NIC | --enable | -eNetqueue balancer state (required)--vmnic | -nName of vmnic to change netqueue balancer state (required)--helpShow the help message. |
network nic register dump | Dump device registers | --vmnic | -nThe name of pnic to dump registers (required)--helpShow the help message. |
network nic ring current get | Get current RX/TX ring buffer parameters of a NIC | --nic-name | -nThe name of the NIC whose current RX/TX ring buffer parameters should be retrieved. (required)--helpShow the help message. |
network nic ring current set | Set current RX/TX ring buffer parameters of a NIC | --nic-name | -nThe name of the NIC whose current RX/TX ring buffer parameters should be set. (required)--rx | -rNumber of ring entries for the RX ring.--rx-jumbo | -jNumber of ring entries for the RX jumbo ring.--rx-mini | -mNumber of ring entries for the RX mini ring.--tx | -tNumber of ring entries for the TX ring.--helpShow the help message. |
network nic ring preset get | Get preset maximums for RX/TX ring buffer parameters of a NIC. | --nic-name | -nThe name of the NIC whose preset maximums for RX/TX ring buffer parameters should be retrieved. (required)--helpShow the help message. |
network nic selftest run | Run self test | --online | -oPerforming limited set of tests do not inetrrupt normal adapter operation, default is offline--vmnic | -nThe name of pnic to dump EEPROM (required)--helpShow the help message. |
network nic sg get | Get scatter-gather settings | --vmnic | -nThe name of pnic to get scatter-gather settings--helpShow the help message. |
network nic sg set | Set scatter-gatter settings on a nic | --enable | -eEnable/disable sacatter-gather (required)--vmnic | -nName of vmnic to configure scatter-gather settings. (required)--helpShow the help message. |
network nic software list | List software simulation settings of physical NICs currently installed and loaded on the system. | --vmnic | -nLimit the output to only the physical NICS with the specified names.--helpShow the help message. |
network nic software set | Enable and disable software simulation settings on a NIC. | --geneveoffloadConfigure Geneve encapsulation offload software simulation.--highdmaConfigure high DMA software simulation.--ipv4csoConfigure IPv4 checksum offload software simulation.--ipv4tsoConfigure IPv4 TCP segmentation offload software simulation.--ipv6csoConfigure IPv6 checksum offload software simulation.--ipv6csoextConfigure IPv6 extend header checksum offload software simulation.--ipv6tsoConfigure IPv6 TCP segmentation offload software simulation.--ipv6tsoextConfigure IPv6 extend header TCP segmentation offload software simulation.--oboConfigure offset based encapsulation offload software simulation.--sgConfigure scatter gather software simulation.--sgspConfigure scatter gather span multiple pages software simulation.--taggingConfigure TX VLAN tagging software simulation.--untaggingConfigure RX VLAN untagging software simulation.--vmnic | -nName of the vmnic whose software similation settings should be updated. (required)--vxlanencapConfigure VXLAN encapsulation offload software simulation.--helpShow the help message. |
network nic stats get | Get NIC statistics for a given interface. | --nic-name | -nName of the NIC to get statistics from. (required)--helpShow the help message. |
network nic tso get | Get TCP segmentation offload settings | --vmnic | -nThe name of pnic to get TSO settings--helpShow the help message. |
network nic tso set | Set TCP segmentation offload settings on a nic | --enable | -eTCP segmentation offload (required)--vmnic | -nName of vmnic to set TSO settings. (required)--helpShow the help message. |
network nic vlan stats get | List VLAN statistics for active VLAN’s on the NIC. | --nic-name | -nName of the NIC to get statistics from. (required)--helpShow the help message. |
network nic vlan stats set | Enable/disable VLAN statistics collection on the NIC. | --enabled | -eWhether to enable or disable VLAN statistics (required)--nic-name | -nName of the NIC to get statistics from. (required)--helpShow the help message. |
network port filter stats get | Filter statistics for a given port. | --portid | -pPort ID for the port to get filter statistics. (required)--helpShow the help message. |
network port stats get | Packet statistics for a given port. | --portid | -pPort ID for the port to get statistics. (required)--helpShow the help message. |
network sriovnic list | This command will list the SRIOV Enabled NICs (PFs) currently installed and loaded on the system. | --helpShow the help message. |
network sriovnic vf list | Get the generic configuration of VFs for SRIOV NIC. | --nic-name | -nThe name of the SRIOV NIC to configured. This must be one of the cards listed in the sriovNic list command. (required)--helpShow the help message. |
network sriovnic vf stats | Get statistics for given VF of a SRIOV NIC. | --nic-name | -nThe name of the SRIOV NIC. This must be one of the cards listed in the sriovNic list command. (required)--vf-id | -vThe 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)--helpShow the help message. |
network vm list | List networking information for the VM’s that have active ports. | --helpShow the help message. |
network vm port list | List of active ports for a given VM. | --world-id | -wWorld ID of the VM for listing ports. (required)--helpShow the help message. |
network vswitch dvs vmware list | List the VMware vSphere Distributed Switch currently configured on the ESXi host. | --vds-name | -vLimit the output of this command to only vDS with the given name.--helpShow the help message. |
network vswitch dvs vmware lacp config get | Get LACP configuration on DVS | --dvs | -sThe name of DVS to get configuration on--helpShow the help message. |
network vswitch dvs vmware lacp stats get | Get LACP stats on DVS uplinks | --dvs | -sThe name of DVS to get configuration on--helpShow the help message. |
network vswitch dvs vmware lacp status get | Get LACP status on DVS | --dvs | -sThe name of DVS to get configuration on--helpShow the help message. |
network vswitch dvs vmware lacp timeout set | Set long/short timeout for vmnics in one LACP LAG | --lag-id | -lThe ID of LAG to be configured. (required)--nic-name | -nThe nic name. If it is set, then only this vmnic in the lag will be configured.--timeout | -tSet long or short timeout: 1 for short timeout and 0 for long timeout. (required)--vds | -sThe name of VDS. (required)--helpShow the help message. |
network vswitch standard add | Add a new virtual switch to the ESXi networking system. | --ports | -PThe number of ports to to give this newly created virtual switch. Maximum ports per virtual switch is 4096. If no value is given the default value(128) is used. The number of ports is limited by the number of already allocated ports on the host. The system wide port count cannot be greater than 4608.--vswitch-name | -vThe name of the virtual switch to create. (required)--helpShow the help message. |
network vswitch standard list | List the virtual switches current on the ESXi host. | --type | -tList virtual switches with given type(e.g. system).--vswitch-name | -vLimit the output of this command to only virtual switches with the given name.--helpShow the help message. |
network vswitch standard remove | Remove a virtual switch from the ESXi networking system. | --vswitch-name | -vThe name of the virtual switch to remove. (required)--helpShow the help message. |
network vswitch standard set | This command sets the MTU size and CDP status of a given virtual switch. | --cdp-status | -cThe CDP status of the given virtual switch. It can be ‘down’, ‘listen’, ‘advertise’ or ‘both’--mtu | -mThe MTU size of the given virtual switch.--vswitch-name | -vThe name of virtual switch to apply the configurations. (required)--helpShow the help message. |
network vswitch standard policy failover get | Get the failover policy settings governing the given virtual switch | --vswitch-name | -vThe name of the virtual switch to use when fetching the switch failover policy. (required)--helpShow the help message. |
network vswitch standard policy failover set | Configure the Failover policy for a virtual switch. | --active-uplinks | -aConfigure the list of active adapters and their failover order. This list must be a comma seperated list of values with the uplink name and no spaces. Example: –active-uplinks=vmnic0,vmnic3,vmnic7,vmnic1--failback | -bConfigure whether a NIC will be used immediately when it comes back in service after a failover--failure-detection | -fSet the method of determining how a network outage is detected.beacon: Detect failures based on active beaconing to the vswitch link: Detect failures based on the NIC link state --load-balancing | -lSet the load balancing policy for this policy. This can be one of the following options:explicit: Always use the highest order uplink from the list of active adapters which pass failover criteria. iphash: Route based on hashing the src and destination IP addresses mac: Route based on the MAC address of the packet source. portid: Route based on the originating virtual port ID. --notify-switches | -nIndicate whether to send a notification to physical switches on failover--standby-uplinks | -sConfigure the list of standby adapters and their failover order. This list must be a comma seperated list of values with the uplink name and no spaces. Example: –standby-uplinks=vmnic2,vmnic4,vmnic8,vmnic6,vmnic11--vswitch-name | -vThe name of the virtual switch to use when configuring the switch failover policy. (required)--helpShow the help message. |
network vswitch standard policy security get | Get the Security Policy governing the given virtual switch. | --vswitch-name | -vThe name of the virtual switch to use when fetching the network security policy. (required)--helpShow the help message. |
network vswitch standard policy security set | Set the security policy for a given virtual switch | --allow-forged-transmits | -fAllow ports on the virtual switch to send packets with forged source information.--allow-mac-change | -mAllow ports on the virtual switch to change their MAC address.--allow-promiscuous | -pAllow ports on the virtual switch to enter promiscuous mode.--vswitch-name | -vThe name of the virtual switch to use when setting the switch security policy. (required)--helpShow the help message. |
network vswitch standard policy shaping get | Get the shaping policy settings for the given virtual switch | --vswitch-name | -vThe name of the virtual switch to use when fetching the switch shaping policy. (required)--helpShow the help message. |
network vswitch standard policy shaping set | Set the shaping policy settings for the given virtual switch | --avg-bandwidth | -bThe averge bandwidth allowed for this shaping policy. This value is in Kbps (1 Kbps = 1000 bits/s)--burst-size | -tThe largest burst size allowed for this shaping policy. This value is in Kib (1 Kib = 1024 bits)--enabled | -eIndicate whether to enable traffic shaping on this policy. If this is true then the –avg-bandwidth, –peak-bandwidth and –burst-size options are required.--peak-bandwidth | -kThe peak bandwidth allowed for this shaping policy. This value is in Kbps (1 Kbps = 1000 bits/s)--vswitch-name | -vThe name of the virtual switch to use when setting the switch shaping policy. (required)--helpShow the help message. |
network vswitch standard portgroup add | Allows the addition of a standard port group to a virtual switch. | --portgroup-name | -pThe name of the port group to add (required)--vswitch-name | -vThe virtual switch to add the port group to. (required)--helpShow the help message. |
network vswitch standard portgroup list | List all of the port groups currently on the system. | --type | -tList port groups with given type(e.g. system).--helpShow the help message. |
network vswitch standard portgroup remove | Remove a port group from the given virtual switch | --portgroup-name | -p(required)--vswitch-name | -v(required)--helpShow the help message. |
network vswitch standard portgroup set | Set the vlan id for the given port group | --portgroup-name | -pThe name of the port group to set vlan id for. (required)--vlan-id | -vThe vlan id for this port group. This value is in the range (0 – 4095)--helpShow the help message. |
network vswitch standard portgroup policy failover get | Get the network failover policy settings governing the given port group | --portgroup-name | -pThe name of the port group to use when fetching the port group failover policy. (required)--helpShow the help message. |
network vswitch standard portgroup policy failover set | Configure the Failover policy for a port group. These setting may potentially override virtual switch settings. | --active-uplinks | -aConfigure the list of active adapters and their failover order. This list must be a comma seperated list of values with the uplink name and no spaces. Example: –active-uplinks=vmnic0,vmnic3,vmnic7,vmnic1--failback | -bConfigure whether a NIC will be used immediately when it comes back in service after a failover--failure-detection | -fSet the method of determining how a network outage is detected.beacon: Detect failures based on active beaconing to the vswitch link: Detect failures based on the NIC link state --load-balancing | -lSet the load balancing policy for this policy. This can be one of the following options:explicit: Always use the highest order uplink from the list of active adapters which pass failover criteria. iphash: Route based on hashing the src and destination IP addresses mac: Route based on the MAC address of the packet source. portid: Route based on the originating virtual port ID. --notify-switches | -nIndicate whether to send a notification to physical switches on failover--portgroup-name | -pThe name of the port group to set failover policy for. (required)--standby-uplinks | -sConfigure the list of standby adapters and their failover order. This list must be a comma seperated list of values with the uplink name and no spaces. Example: –standby-uplinks=vmnic2,vmnic4,vmnic8,vmnic6,vmnic11--use-vswitch | -uReset 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.--helpShow the help message. |
network vswitch standard portgroup policy security get | Get the Security Policy governing the given port group. | --portgroup-name | -pThe name of the port group to use when fetching the network security policy. (required)--helpShow the help message. |
network vswitch standard portgroup policy security set | Set the security policy for a given port group | --allow-forged-transmits | -fAllow ports on the virtual switch to send packets with forged source information.--allow-mac-change | -mAllow ports on the virtual switch to change their MAC address.--allow-promiscuous | -oAllow ports on the virtual switch to enter promiscuous mode.--portgroup-name | -pThe name of the port group to set security policy for. (required)--use-vswitch | -uReset 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.--helpShow the help message. |
network vswitch standard portgroup policy shaping get | Get the network shaping policy settings governing the given port group | --portgroup-name | -pThe name of the port group to use when fetching the port group shaping policy. (required)--helpShow the help message. |
network vswitch standard portgroup policy shaping set | Set the shaping policy settings for the given port group | --avg-bandwidth | -bThe averge bandwidth allowed for this shaping policy. This value is in Kbps (1 Kbps = 1000 bits/s)--burst-size | -tThe largest burst size allowed for this shaping policy. This value is in Kib (1 Kib = 1024 bits)--enabled | -eIndicate whether to enable traffic shaping on this policy. If this is true then the –avg-bandwidth, –peak-bandwidth and –burst-size options are required.--peak-bandwidth | -kThe peak bandwidth allowed for this shaping policy. This value is in Kbps (1 Kbps = 1000 bits/s)--portgroup-name | -pThe name of the port group to set shaping policy for. (required)--use-vswitch | -uReset 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.--helpShow the help message. |
network vswitch standard uplink add | Add an uplink to the given virtual switch. Note if this virtual switch has a NIC teaming policy assigned to it then the policy must also be modified to enable use of this uplink on this virtual switch | --uplink-name | -uThe name of the uplink to add to the virtual switch. (required)--vswitch-name | -vThe name of the virtual switch to add an uplink to. (required)--helpShow the help message. |
network vswitch standard uplink remove | Remove an uplink from the given virtual switch. Note if this virtual switch has a NIC teaming policy assigned to it then the policy must also be modified to disable use of this uplink on this virtual switch | --uplink-name | -uThe name of the uplink to remove from the virtual switch. (required)--vswitch-name | -vThe name of the virtual switch to remove an uplink from. (required)--helpShow the help message. |
esxcli nvme Commands
| COMMAND | DESCRIPTION | OPTIONS HELP |
|---|---|---|
nvme adapter list | List all NVMe adapters. | --helpShow the help message. |
nvme controller identify | Get NVMe Identify Controller data. | --controller | -cController to operate on. (required)--format | -fOutput format. Valid values are:detailed: Show bit level value and description. hex: Dump the data in hex format. --helpShow the help message. |
nvme controller list | List NVMe controllers. | --adapter | -aFilter the output to a specific adapter.--protocol | -pFilter the output to a specific transport protocol. Valid Values are: [FC, PCIe, RDMA, TCP].--skip-vvols | -VFilter the output to exclude vVol controllers.--vvols | -vFilter the output to vVol controllers only.--helpShow the help message. |
nvme device get | Get NVMe device information | --adapter | -AAdapter to operate on (required)--helpShow the help message. |
nvme device list | List NVMe devices registered to VMware NVMe driver | --helpShow the help message. |
nvme device config list | List the configurable parameters for this plugin | --helpShow the help message. |
nvme device config set | Set the plugin’s parameter | --parameter | -pParameter name (required)--value | -vParameter value (required)--helpShow the help message. |
nvme device controller list | List all controllers on the device if namespace is not specified, otherwise list all controllers the namespace attached | --adapter | -AAdapter to operate on (required)--namespace | -nNamespace ID attached. ID starts from 1--helpShow the help message. |
nvme device feature cap | Get NVMe device feature supported capabilities information | --adapter | -AAdapter to operate on (required)--helpShow the help message. |
nvme device feature get | Get NVMe device feature | --adapter | -AAdapter to operate on (required)--cdw11 | -cCommand Dword 11--cdw12 | -wCommand Dword 12--cdw13 | -xCommand Dword 13--cdw14 | -yCommand Dword 14--cdw15 | -zCommand Dword 15--fid | -fFeature ID (required)--length | -lFeature data length.--namespace | -nNamespace to operate on--path | -pData path. If set, the raw feature data will be wrote to the specified file. If not set, the feature data will be printed in hex format.--select | -Sspecify which value of the attributes to return, “current”, “default”, “saved”--helpShow the help message. |
nvme device feature set | Set NVMe device feature | --adapter | -AAdapter to operate on (required)--cdw11 | -cCommand Dword 11--cdw12 | -wCommand Dword 12--cdw13 | -xCommand Dword 13--cdw14 | -yCommand Dword 14--cdw15 | -zCommand Dword 15--fid | -fFeature ID (required)--namespace | -nNamespace to operate on--path | -pFeature data file path--save | -Ssave the attribute--helpShow the help message. |
nvme device feature aec get | Get NVMe device feature async event configuration information | --adapter | -AAdapter to operate on (required)--select | -Sspecify which value of the attributes to return, “current”, “default”, “saved”--helpShow the help message. |
nvme device feature aec set | Set NVMe device feature async event configuration information | --adapter | -AAdapter to operate on (required)--fwnotices | -wan asynchronous event notification is sent to the host for a Firmware Activation Starting event, 0 for false, 1 for true, 0 will be passed as default value, if not set--nsnotices | -man asynchronous event notification is sent to the host for a Namespace Attribute change, 0 for false, 1 for true, 0 will be passed as default value, if not set--save | -Ssave the attribute--value | -vSMART health critical warnings bitmap to be set, refer to Figure 79, NVMe 1.2 SPEC (required)--helpShow the help message. |
nvme device feature apst get | Get NVMe device feature autonomous power state transition information | --adapter | -AAdapter to operate on (required)--select | -Sspecify which value of the attributes to return, “current”, “default”, “saved”--helpShow the help message. |
nvme device feature ar get | Get NVMe device feature arbitration information | --adapter | -AAdapter to operate on (required)--select | -Sspecify which value of the attributes to return, “current”, “default”, “saved”--helpShow the help message. |
nvme device feature ar set | Set NVMe device feature arbitration information | --adapter | -AAdapter to operate on (required)--save | -Ssave the attribute--value | -vArbitration Burst value to be set (required)--value2 | -xLow Priority Weight value to be set (required)--value3 | -yMedium Priority Weight value to be set (required)--value4 | -zHigh Priority Weight value to be set (required)--helpShow the help message. |
nvme device feature er get | Get NVMe device feature error recovery information | --adapter | -AAdapter to operate on (required)--namespace | -nNamespace to operate on--select | -Sspecify which value of the attributes to return, “current”, “default”, “saved”--helpShow the help message. |
nvme device feature er set | Set NVMe device feature error recovery information | --adapter | -AAdapter to operate on (required)--enable | -eDeallocated or unwritten logical block error enable value to be set. The default value is 0.--namespace | -nNamespace to operate on, 0 will be passed as default value, if not set--save | -SSave the attribute--value | -vTime limited error recovery value to be set (required)--helpShow the help message. |
nvme device feature hi get | Get NVMe device feature host identifier information | --adapter | -AAdapter to operate on (required)--select | -Sspecify which value of the attributes to return, “current”, “default”, “saved”--helpShow the help message. |
nvme device feature hmb get | Get NVMe device feature host memory buffer information | --adapter | -AAdapter to operate on (required)--select | -Sspecify which value of the attributes to return, “current”, “default”, “saved”--helpShow the help message. |
nvme device feature ic get | Get NVMe device feature interrupt coalescing information | --adapter | -AAdapter to operate on (required)--select | -Sspecify which value of the attributes to return, “current”, “default”, “saved”--helpShow the help message. |
nvme device feature ic set | Set NVMe device feature interrupt coalescing information | --adapter | -AAdapter to operate on (required)--save | -Ssave the attribute--value | -vAggregation threshold value to be set (required)--value2 | -xAggregation time value to be set (required)--helpShow the help message. |
nvme device feature ivc get | Get NVMe device feature interrupt vector configuration information | --adapter | -AAdapter to operate on (required)--select | -Sspecify which value of the attributes to return, “current”, “default”, “saved”--helpShow the help message. |
nvme device feature ivc set | Set NVMe device feature interrupt vector configuration information | --adapter | -AAdapter to operate on (required)--save | -SSave the attribute--value | -vInterrupt vector value to be set (required)--value2 | -xCoalescing deactivate value to be set, 0 for false (activate), 1 for true (deactivate) (required)--helpShow the help message. |
nvme device feature kat get | Get NVMe device feature keep alive timer information | --adapter | -AAdapter to operate on (required)--select | -Sspecify which value of the attributes to return, “current”, “default”, “saved”--helpShow the help message. |
nvme device feature kat set | Set NVMe device feature keep alive timer information | --adapter | -AAdapter to operate on (required)--save | -Ssave the attribute--timeout | -ttimeout value for the keep alive feature to be set (required)--helpShow the help message. |
nvme device feature lba get | Get NVMe device feature LBA range type information | --adapter | -AAdapter to operate on (required)--namespace | -nNamespace to operate on (required)--select | -Sspecify which value of the attributes to return, “current”, “default”, “saved”--helpShow the help message. |
nvme device feature nq get | Get NVMe device feature number of queue information | --adapter | -AAdapter to operate on (required)--select | -Sspecify which value of the attributes to return, “current”, “default”, “saved”--helpShow the help message. |
nvme device feature pm get | Get NVMe device feature power management information | --adapter | -AAdapter to operate on (required)--select | -Sspecify which value of the attributes to return, “current”, “default”, “saved”--helpShow the help message. |
nvme device feature pm set | Set NVMe device feature power management information | --adapter | -AAdapter to operate on (required)--save | -Ssave the attribute--value | -vPower state value to be set (required)--workload | -wWorkload Hint to be set, 0 will be passed as default value, if not set--helpShow the help message. |
nvme device feature spm get | Get NVMe device feature software progress marker information | --adapter | -AAdapter to operate on (required)--select | -Sspecify which value of the attributes to return, “current”, “default”, “saved”--helpShow the help message. |
nvme device feature spm set | Set software progress marker feature information, will clear Pre-boot Software Load Count (PBSLC) to 0 | --adapter | -AAdapter to operate on (required)--save | -Ssave the attribute--helpShow the help message. |
nvme device feature tt get | Get NVMe device feature temperature threshold information | --adapter | -AAdapter to operate on (required)--select | -Sspecify which value of the attributes to return, “current”, “default”, “saved”--helpShow the help message. |
nvme device feature tt set | Set NVMe device feature temperature threshold information | --adapter | -AAdapter to operate on (required)--save | -Ssave the attribute--sensor | -sThreshold temperature select value to be set, 0 will be passed as default value, if not set--under | -uSet under temperature threshold--value | -vTemperature threshold value to be set (required)--helpShow the help message. |
nvme device feature vwc get | Get NVMe device feature volatile write cache information | --adapter | -AAdapter to operate on (required)--select | -Sspecify which value of the attributes to return, “current”, “default”, “saved”--helpShow the help message. |
nvme device feature vwc set | Set NVMe device feature volatile write cache information | --adapter | -AAdapter to operate on (required)--save | -Ssave the attribute--value | -vVolitale write cache enable value to be set (required)--helpShow the help message. |
nvme device feature wa get | Get NVMe device feature write atomicity information | --adapter | -AAdapter to operate on (required)--select | -Sspecify which value of the attributes to return, “current”, “default”, “saved”--helpShow the help message. |
nvme device feature wa set | Set NVMe device feature write atomicity information | --adapter | -AAdapter to operate on (required)--save | -SSave the attribute--value | -vDeactivate Normal value to be set, 0 for false (activate), 1 for true (deactivate) (required)--helpShow the help message. |
nvme device firmware activate | Commit downloaded firmware image to a specific slot | --action | -aActivate action 0: Downloaded image replaces the image indicated by the firmware slot field. This image is not activated. 1: Downloaded image replaces the image indicated by the firmware slot field. This image is activated at the next reset. 2: The image specified by the firmware slot field is activated at the next reset. 3: The image specified by the firmware slot field is requested to be activated immediately without reset. (required) --adapter | -AAdapter to operate on (required)--slot | -sSlot number. If the value specified is 0, then the controller shall choose the firmware slot. (required)--helpShow the help message. |
nvme device firmware download | Download firmware image to the device | --adapter | -AAdapter to operate on (required)--firmware | -fFirmware image path (required)--offset | -oFirmware image offset. This parameter is needed if the firmware image is split across multiple files. The default value is 0.--xfersize | -xSize to split each transfer. This parameter is needed if the device has special requirement on the firmware transfer size.--helpShow the help message. |
nvme device log get | Get NVMe log page | --adapter | -AAdapter to operate on (required)--length | -lLog page length. (required)--lid | -iLog page ID. Both decimal number and hexadecimal number are accepted. Hexadecimal number should start with ‘0x’ or ‘0X’. (required)--lsi | -ILog specific ID. The default value is 0.--lsp | -sLog specific field. The default value is 0.--namespace | -nNamespace ID. The default value is 0xFFFFFFFF.--offset | -oLog page offset. The default value is 0.--path | -pLog path. If set, the raw log data will be wrote to the specified file. If not set, the log data will be printed in hex format.--rae | -rRetain asynchronous event. The default value is 0.--uuid | -uUUID index. The default value is 0.--helpShow the help message. |
nvme device log error get | Get NVMe device error log information | --adapter | -AAdapter to operate on (required)--elpe | -eError log page entries. This value indicates the number of log entries you wish to get. The maximum number of entries supported is device-specific. (required)--helpShow the help message. |
nvme device log fwslot get | Get NVMe device firmware slot log information | --adapter | -AAdapter to operate on (required)--helpShow the help message. |
nvme device log persistentevent get | Get NVMe persistent event log | --action | -aAction the controller shall take during processing this command. 0: Read log data. 1: Establish context and read log data. 2: Release context. (required)--adapter | -AAdapter to operate on (required)--path | -pPersistent event log path. This parameter is required if the –action parameter is 0 or 1.--helpShow the help message. |
nvme device log smart get | Get NVMe device SMART log information | --adapter | -AAdapter to operate on (required)--namespace | -nNamespace ID. If log page is supported on a per namespace basis this value indicates the ID of namespace you wish to get log from. This parameter can be omitted to request global log page.--helpShow the help message. |
nvme device log telemetry controller get | Get NVMe telemetry controller-initiated data | --adapter | -AAdapter to operate on (required)--data | -dData area to get telemetry data, 3 is selected if not set--path | -pTelemetry log path (required)--helpShow the help message. |
nvme device log telemetry host get | Get NVMe telemetry host-initiated data | --adapter | -AAdapter to operate on (required)--data | -dData area to get telemetry data, 3 is selected if not set--path | -pTelemetry log path (required)--helpShow the help message. |
nvme device namespace attach | Attach namespace on NVMe device | --adapter | -AAdapter to operate on (required)--controller | -cController ID to attach. ID starts from 0 (required)--namespace | -nNamespace ID to attach. ID starts from 1 (required)--helpShow the help message. |
nvme device namespace create | Create namespace on NVMe device | --adapter | -AAdapter to operate on (required)--capacity | -cNamespace Capacity (required)--dps | -pEnd-to-End Data Protection Type Settings (required)--flbas | -fFormatted LBA Size (required)--nmic | -mNamespace Multi-path IO and Namespace Sharing Capabilities (required)--size | -sNamespace Size (required)--helpShow the help message. |
nvme device namespace delete | Delete namespace on NVMe device | --adapter | -AAdapter to operate on (required)--namespace | -nID of namespace to delete, starts from 1 (required)--helpShow the help message. |
nvme device namespace detach | Detach namespace on NVMe device | --adapter | -AAdapter to operate on (required)--controller | -cController ID to detach. ID starts from 0 (required)--namespace | -nID of namespace to detach. ID starts from 1 (required)--helpShow the help message. |
nvme device namespace format | Change namespace format | --adapter | -AAdapter to operate on (required)--format | -fLBA Format(LBAF) (required)--ms | -mMetadata Settings(MS). 0: Metadata is transferred as part of a separate buffer. 1: Metadata is transferred as part of an extended data LBA. (required)--namespace | -nNamespace ID (required)--pi | -pProtection Information(PI). 0: Protection information is not enabled. 1: Protection information is enabled, Type 1. 2: Protection information is enabled, Type 2. 3: Protection information is enabled, Type 3. (required)--pil | -lProtection Information Location(PIL). 0: PI is transferred as the last eight bytes of metadata, if PI is enabled. 1: PI is transferred as the first eight bytes of metadata, if PI is enabled. (required)--ses | -sSecure Erase Settings(SES). 0: No secure erase operation requested. 1: User Data Erase. 2: Cryptographic Erase. (required)--helpShow the help message. |
nvme device namespace get | Get nvme namespace information | --adapter | -AAdapter to operate on (required)--namespace | -nID of namespace to get information from. ID starts from 1 (required)--helpShow the help message. |
nvme device namespace list | List namespace on NVMe device | --adapter | -AAdapter to operate on (required)--helpShow the help message. |
nvme device register get | Dump NVMe device registers | --adapter | -AAdapter to operate on (required)--helpShow the help message. |
nvme device timeout get | Get timeout value of IO timeout checker | --adapter | -AAdapter to operate on (required)--helpShow the help message. |
nvme device timeout set | Set timeout value for IO timeout checker | --adapter | -AAdapter to operate on (required)--timeout | -tIO timeout seconds for internal checker. Maximum timeout value is 40. 0: deactivate timeout checker. (required)--helpShow the help message. |
nvme driver loglevel set | Set NVMe driver log level and debug level | --debuglevel | -dDebug level(hex int format). When log level is 5, this value is used to manupulate NVMe driver parameter: nvme_dbg. This parameter can be omitted to indicate value 0. BIT_0: Print ctrlr level log BIT_1: Print namespace level log BIT_2: Print queue level log BIT_3: Print IO command level log BIT_4: Print admin command level log BIT_5: Print management level log BIT_6: Print exception handler log BIT_7: Print split command log BIT_13: Print timeout handler log BIT_14: Print init/cleanup log BIT_15: Print temp log BIT_16: Dump SG array BIT_17: Dump PRP BIT_18: Dump cdb BIT_19: Dump NVM command BIT_20: Dump completion queue entry BIT_21: Dump user passthru data BIT_22: Dump namespace info BIT_23: Dump timeout info BIT_24: Dump smart log info --loglevel | -lLog level. This value is used to manupulate NVMe driver parameter: nvme_log_level. 1: error 2: warning 3: info 4: verbose 5: debug (required) --helpShow the help message. |
nvme fabrics connect | Connect to an NVMe controller on a specified target through an adapter. | --adapter | -aAdapter through which the controller will be connected. (required)--admin-queue-size | -qSize of the admin queue (default: 32).--controller-id | -cID of the controller to be connected. (default: 0xFFFF)--digest | -dEnable/disable digest verification (only for NVMe over TCP). Available options are:0: Disable digest verification (default) 1: Enable header digest verification 2: Enable data digest verification 3: Enable header and data digest verification --io-queue-number | -NExpected number of IO queues to create. (range: 1~16)--io-queue-size | -QExpected size of IO queue to create. (range: 8~1024)--ip-address | -iIP(v4/v6) address of the RDMA/TCP target port. (required for NVMe over RDMA/TCP)--keep-alive-timeout | -tKeep alive timeout value in seconds. (range: 5~60, default: 30)--port-number | -pTarget port number. Default: 4420 (for NVMe/RDMA), 8009(for NVMe/TCP)--subsystem-nqn | -sNVMe Qualified Name of the NVM subsystem. (required)--world-wide-node-name | -WWorld Wide Node Name of the fibre channel target port. (required for NVMe/FC)--world-wide-port-name | -wWorld Wide Port Name of the fibre Channel target port. (required for NVMe/FC)--helpShow the help message. |
nvme fabrics disable | Disable NVMe over Fabrics for a transport protocol. | --device | -dDevice on which to disable NVMe. (required)--protocol | -pTransport protocol to be disabled. Options are:RDMA: RDMA Protocol TCP: TCP protocol (required) --helpShow the help message. |
nvme fabrics disconnect | Disconnect specified NVMe controller(s) on the specified NVMe adapter. | --adapter | -aAdapter to use for target disconnection. (required)--controller-number | -nController number to disconnect.--subsystem-nqn | -sNVMe Qualified Name of the NVM subsystem. This will be ignored if –controller-number is specified.--helpShow the help message. |
nvme fabrics discover | Discover NVMe controllers on the specified target port through the specified NVMe adapter and list all of them. | --adapter | -aAdapter to use for target discovery. (required)--connect-all | -cConnect to all the discovered NVM Subsystems.--digest | -dEnable/disable digest verification (only for NVMe over TCP). Available options are:0: Disable digest verification (default) 1: Enable header digest verification 2: Enable data digest verification 3: Enable header and data digest verification --dynamic | -DDynamically discover and connect to controllers (only for NVMe/TCP adapters).--io-queue-number | -NExpected number of IO queues to create. (range: 1~16)--io-queue-size | -QExpected size of IO queue to create. (range: 8~1024)--ip-address | -iIP(v4/v6) address of the RDMA/TCP target port. (required for NVMe over RDMA/TCP)--port-number | -pTarget port number. Default: 4420 (for NVMe/RDMA), 8009 (for NVMe/TCP)--rdc | -rConnect to RDC/CDC (Root/Central Discovery Controller).--world-wide-node-name | -WWorld Wide Node Name of the fibre channel target port. (required for NVMe/FC)--world-wide-port-name | -wWorld Wide Port Name of the fibre Channel target port. (required for NVMe/FC)--helpShow the help message. |
nvme fabrics enable | Enable NVMe over Fabrics for a transport protocol. | --device | -dDevice on which to enable NVMe. (required)--protocol | -pTransport protocol to be enabled. Available options are:RDMA: RDMA Protocol TCP: TCP Protocol (required) --helpShow the help message. |
nvme fabrics connection delete | Delete persistent NVMe over Fabrics connection entries. Reboot required for settings to take effect. | --aqn | -aAdapter’s AQN(Adapter Qualified Name) of the NVMe over Fabrics connection to be deleted. (required)--ip-address | -iIP(v4/v6) address of the RDMA/TCP target port. (required for NVMe over RDMA/TCP)--port-number | -pTarget port number. Default: 4420 (for NVMe/RDMA), 8009 (for NVMe/TCP)--rdc | -rDelete RDC/CDC (Root/Central Discovery Controller) connection.--subsystem-nqn | -sNVMe Qualified Name of the NVM subsystem.--world-wide-node-name | -WWorld Wide Node Name of the fibre channel target port. (required for NVMe/FC)--world-wide-port-name | -wWorld Wide Port Name of the fibre Channel target port. (required for NVMe/FC)--helpShow the help message. |
nvme fabrics connection list | List all persistent NVMe over Fabrics connection entries. | --helpShow the help message. |
nvme info get | Get NVMe host information. | --helpShow the help message. |
nvme info set | Set NVMe host information. | --hostnqnThe HostNQN to set. –hostnqn=default will regenerate HostNQN with default policy.--helpShow the help message. |
nvme namespace identify | Get NVMe Identify Namespace data. | --format | -fOutput format. Valid values are:detailed: Show bit level value and description. hex: Dump the data in hex format. --namespace | -nNamespace to operate on. (required)--helpShow the help message. |
nvme namespace list | List all NVMe namespaces. | --controller-number | -cFilter the output to a specific controller number.--namespace | -nFilter the output to a specific namespace name.--helpShow the help message. |
esxcli rdma Commands
| COMMAND | DESCRIPTION | OPTIONS HELP |
|---|---|---|
rdma device list | List the logical RDMA devices currently registered on the system. | --helpShow the help message. |
rdma device protocol list | List the enabled RDMA protocols. | --helpShow the help message. |
rdma device stats get | Get statistics for a given RDMA device. | --device | -dName of the RDMA device. (required)--helpShow the help message. |
rdma device vmknic list | List the vmknics associated with RDMA devices. | --device | -dName of the RDMA device whose vmknics to display.--helpShow the help message. |
rdma iser add | Add an iSER device to enable iser module driver. | --device | -dDevice on which to enable iSER.--helpShow the help message. |
rdma iser delete | Delete an iser logical device. | --device | -dDevice on which to disable iSER.--helpShow the help message. |
rdma iser params set | Change iSER kernel driver settings. (This operation is deprecated.) | --adapter | -aAdapter to set RoCE type on. (required)--roce | -rRDMA type (0:Auto 1:V1: 2:V2 3:iWarp). (required)--helpShow the help message. |
esxcli sched Commands
| COMMAND | DESCRIPTION | OPTIONS HELP |
|---|---|---|
sched reliablemem get | Check if the system is currently aware of reliable memory. | --helpShow the help message. |
sched swap system get | Get current state of the options of the system-wide shared swap space. | --helpShow the help message. |
sched swap system set | Change the configuration of system-wide shared swap space. | --datastore-enabled | -dIf the datastore option should be enabled or not.--datastore-name | -nThe name of the datastore used by the datastore option.--datastore-order | -DThe order of the datastore option in the preference of the options--hostcache-enabled | -cIf the host cache option should be enabled or not.--hostcache-order | -CThe order of the host cache option in the preference of the options.--hostlocalswap-enabled | -lIf the host local swap option should be enabled or not.--hostlocalswap-order | -LThe order of the host local swap option in the preference of the options.--helpShow the help message. |
esxcli software Commands
| COMMAND | DESCRIPTION | OPTIONS HELP |
|---|---|---|
software apply | Applies a complete image with a software spec that specifies base image, addon and components to install on the host. | --depot | -dSpecifies full remote URLs of the depot index.xml or a local offline bundle .zip file on the server. (required)--dry-runPerforms a dry-run. Report the VIB-level operations that would be performed, but do not change anything in the system.--no-hardware-warningAllows the transaction to ignore hardware precheck warnings. A hardware precheck error will continue to be shown with this option. Use of this option may result in device not functioning normally.--no-live-installForces 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-checkBypasses acceptance level and signing verifications. Use of this option poses a large security risk and will result in a SECURITY ALERT warning being displayed in vSphere Web Client.--proxySpecifies a proxy server for HTTP, FTP, and HTTPS connections, in the format of proxy-url:port.--software-spec | -sSpecifies the JSON software spec to apply on the host. A local file path or a remote URL can be supplied. (required)--helpShow the help message. |
software acceptance get | Gets the host acceptance level. This controls what VIBs will be allowed on a host. | --helpShow the help message. |
software acceptance set | Sets the host acceptance level. This controls what VIBs will be allowed on a host. | --levelSpecifies the acceptance level to set. Should be one of VMwareCertified / VMwareAccepted / PartnerSupported / CommunitySupported. (required)--helpShow the help message. |
software addon get | Display the installed Addon on the host and the managed DPU(s). | --rebooting-imageDisplays information for the ESXi image which becomes active after a reboot, or nothing if the pending-reboot image has not been created yet. If not specified, information from the current ESXi image in memory will be returned.--helpShow the help message. |
software baseimage get | Display the installed baseimage on the host. | --rebooting-imageDisplays information for the ESXi image which becomes active after a reboot, or nothing if the pending-reboot image has not been created yet. If not specified, information from the current ESXi image in memory will be returned.--helpShow the help message. |
software component apply | Installs Component packages from a depot. Components may be installed, upgraded. WARNING: If your installation requires a reboot, you need to disable HA first. | --component | -nSpecifies Components from a depot, using one of the following forms: name, name:version.--depot | -dSpecifies the full remote URL to the depot’s index.xml, or a local file path to an offline bundle .zip file. (required)--dry-runPerforms a dry-run only. Report the Component-level operations that would be performed, but do not change anything in the system.--no-sig-checkBypasses acceptance level verification, including signing. Use of this option poses a large security risk and will result in a SECURITY ALERT warning being displayed in vSphere Web Client.--proxySpecifies a proxy server to use for HTTP, FTP, and HTTPS connections. The format is proxy-url:port.--helpShow the help message. |
software component get | Displays detailed information about one or more installed Components on host and managed DPU(s). | --component | -nSpecifies one or more installed Components to display more information about. If this option is not specified, then all of the installed Components will be displayed. Must be one of the following forms: name, name:version.--rebooting-imageDisplays information for the ESXi image which becomes active after a reboot, or nothing if the pending-reboot image has not been created yet. If not specified, information from the current ESXi image in memory will be returned.--helpShow the help message. |
software component list | Lists the installed Component packages on the host and the managed DPU(s). | --rebooting-imageDisplays information for the ESXi image which becomes active after a reboot, or nothing if the pending-reboot image has not been created yet. If not specified, information from the current ESXi image in memory will be returned.--helpShow the help message. |
software component remove | Removes components from the host. WARNING: If your installation requires a reboot, you need to disable HA first. | --component | -nSpecifies one or more Components on the host to remove. Must be one of the following forms: name, name:version. (required)--dry-runPerforms a dry-run only. Report the Components-level operations that would be performed, but do not change anything in the system.--helpShow the help message. |
software component signature verify | Verifies the signatures of installed Components on the host and the managed DPU(s) and displays the name, version, vendor, acceptance level and the result of signature verification for each of them. | --rebooting-imageDisplays information for the ESXi image which becomes active after a reboot. If not specified, information from the current ESXi image in memory will be returned.--helpShow the help message. |
software component vib list | List VIBs in an installed Component on the host and the managed DPU(s). | --component | -nSpecifies an installed Components to display more information about. Must be one of the following forms: name, name:version. (required)--rebooting-imageDisplays information for the ESXi image which becomes active after a reboot, or nothing if the pending-reboot image has not been created yet. If not specified, information from the current ESXi image in memory will be returned.--helpShow the help message. |
software profile get | Display the installed image profile on host and managed DPU(s). | --rebooting-imageDisplays information for the ESXi image which becomes active after a reboot, or nothing if the pending-reboot image has not been created yet. If not specified, information from the current ESXi image in memory will be returned.--helpShow the help message. |
software profile install | Installs or applies an image profile from a depot to this host. This command completely replaces the installed image with the image defined by the new image profile, and may result in the loss of installed VIBs. The common vibs between host and image profile will be skipped. To preserve installed VIBs, use profile update instead. WARNING: If your installation requires a reboot, you need to disable HA first. | --depot | -dSpecifies full remote URLs of the depot index.xml or server file path pointing to an offline bundle .zip file. (required)--dry-runPerforms a dry-run only. Report the VIB-level operations that would be performed, but do not change anything in the system.--force | -fBypasses checks for package dependencies, conflicts, obsolescence, and acceptance levels. Really not recommended unless you know what you are doing. Use of this option will result in a warning being displayed in vSphere Web Client. Use this option only when instructed to do so by VMware Technical Support.--maintenance-modePretends that maintenance mode is in effect. Otherwise, installation will stop for live installs that require maintenance mode. This flag has no effect for reboot required remediations.--no-hardware-warningAllows the transaction to proceed when hardware precheck returns a warning. A hardware error will continue to be shown with this option. Use of this option may result in device not functioning normally.--no-live-installForces 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-checkBypasses acceptance level verification, including signing. Use of this option poses a large security risk and will result in a SECURITY ALERT warning being displayed in vSphere Web Client.--ok-to-removeAllows the removal of installed VIBs as part of applying the image profile. If not specified, esxcli will error out if applying the image profile results in the removal of installed VIBs.--profile | -pSpecifies the name of the image profile to install. (required)--proxySpecifies a proxy server to use for HTTP, FTP, and HTTPS connections. The format is proxy-url:port.--helpShow the help message. |
software profile update | Updates the host with VIBs from an image profile in a depot. Installed VIBs may be upgraded (or downgraded if –allow-downgrades is specified), but they will not be removed. Any VIBs in the image profile which are not related to any installed VIBs will be added to the host. WARNING: If your installation requires a reboot, you need to disable HA first. | --allow-downgradesIf this option is specified, then the VIBs from the image profile which update, downgrade, or are new to the host will be installed. If the option is not specified, then the VIBs which update or are new to the host will be installed.--depot | -dSpecifies full remote URLs of the depot index.xml or server file path pointing to an offline bundle .zip file. (required)--dry-runPerforms a dry-run only. Report the VIB-level operations that would be performed, but do not change anything in the system.--force | -fBypasses checks for package dependencies, conflicts, obsolescence, and acceptance levels. Really not recommended unless you know what you are doing. Use of this option will result in a warning being displayed in vSphere Web Client. Use this option only when instructed to do so by VMware Technical Support.--maintenance-modePretends that maintenance mode is in effect. Otherwise, installation will stop for live installs that require maintenance mode. This flag has no effect for reboot required remediations.--no-hardware-warningAllows the transaction to proceed when hardware precheck returns a warning. A hardware error will continue to be shown with this option. Use of this option may result in device not functioning normally.--no-live-installForces 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-checkBypasses acceptance level verification, including signing. Use of this option poses a large security risk and will result in a SECURITY ALERT warning being displayed in vSphere Web Client.--profile | -pSpecifies the name of the image profile to update the host with. (required)--proxySpecifies a proxy server to use for HTTP, FTP, and HTTPS connections. The format is proxy-url:port.--helpShow the help message. |
software profile validate | Validates the current image profile on the host and managed DPU(s) against an image profile in a depot. | --depot | -dSpecifies full remote URLs of the depot index.xml or server file path pointing to an offline bundle .zip file. (required)--profile | -pSpecifies the name of the image profile to validate the host with. (required)--proxySpecifies a proxy server to use for HTTP, FTP, and HTTPS connections. The format is proxy-url:port.--helpShow the help message. |
software sources addon get | Display details about Addons in the depots. | --addon | -aSpecify the Addon to display, in one of the follwing formats: name, name:version. (required)--depot | -dSpecifies full remote URLs of the depot index.xml or server file path pointing to an offline bundle .zip file. (required)--proxySpecifies a proxy server to use for HTTP, FTP, and HTTPS connections. The format is proxy-url:port.--helpShow the help message. |
software sources addon list | List all Addons in the depots. | --depot | -dSpecifies full remote URLs of the depot index.xml or server file path pointing to an offline bundle .zip file. (required)--proxySpecifies a proxy server to use for HTTP, FTP, and HTTPS connections. The format is proxy-url:port.--helpShow the help message. |
software sources baseimage get | Display details about a Base Image from the depot. | --baseimageversion | -bSpecifies the name of the Base Image to display. (required)--depot | -dSpecifies full remote URL of the depot index.xml or server file path pointing to an offline bundle .zip file. (required)--proxySpecifies a proxy server to use for HTTP, FTP, and HTTPS connections. The format is proxy-url:port.--helpShow the help message. |
software sources baseimage list | List all the Base Images in a depot. | --depot | -dSpecifies full remote URLs of the depot index.xml or server file path pointing to an offline bundle .zip file. (required)--proxySpecifies a proxy server to use for HTTP, FTP, and HTTPS connections. The format is proxy-url:port.--helpShow the help message. |
software sources component get | Displays detailed information about one or more Components in the depot | --component | -nSpecifies one or more Components in the depot to display more information about. If this option is not specified, then all of the Component packages from the depot will be displayed. Must be one of the following forms: name, name:version.--depot | -dSpecifies the full remote URL to the depot’s index.xml, or a local file path to an offline bundle .zip file. (required)--proxySpecifies a proxy server to use for HTTP, FTP, and HTTPS connections. The format is proxy-url:port.--helpShow the help message. |
software sources component list | List all the Components from depots. | --depot | -dSpecifies full remote URLs of the depot index.xml or server file path pointing to an offline bundle .zip file. (required)--proxySpecifies a proxy server to use for HTTP, FTP, and HTTPS connections. The format is proxy-url:port.--helpShow the help message. |
software sources component vib list | List VIB packages in the specified Component in a depot. | --component | -nSpecifies a Component to display information about. Must be one of the following forms: name, name:version. (required)--depot | -dSpecifies full remote URLs of the depot index.xml or server file path pointing to an offline bundle .zip file. (required)--proxySpecifies a proxy server to use for HTTP, FTP, and HTTPS connections. The format is proxy-url:port.--helpShow the help message. |
software sources profile get | Display details about an image profile from the depot. | --depot | -dSpecifies full remote URLs of the depot index.xml or server file path pointing to an offline bundle .zip file. (required)--profile | -pSpecifies the name of the image profile to display. (required)--proxySpecifies a proxy server to use for HTTP, FTP, and HTTPS connections. The format is proxy-url:port.--helpShow the help message. |
software sources profile list | List all the image profiles in a depot. | --depot | -dSpecifies full remote URLs of the depot index.xml or server file path pointing to an offline bundle .zip file. (required)--proxySpecifies a proxy server to use for HTTP, FTP, and HTTPS connections. The format is proxy-url:port.--helpShow the help message. |
software sources vib get | Displays detailed information about one or more VIB packages in the depot | --depot | -dSpecifies full remote URLs of the depot index.xml or server file path pointing to an offline bundle .zip file.--proxySpecifies a proxy server to use for HTTP, FTP, and HTTPS connections. The format is proxy-url:port.--vibname | -nSpecifies one or more VIBs in the depot to display more information about. If this option is not specified, then all of the VIB packages from the depot will be displayed. Must be one of the following forms: name, name:version, vendor:name, or vendor:name:version.--viburl | -vSpecifies one or more URLs to VIB packages to display information about. http:, https:, ftp:, and file: are all supported.--helpShow the help message. |
software sources vib list | List all the VIBs from depots. | --depot | -dSpecifies full remote URLs of the depot index.xml or server file path pointing to an offline bundle .zip file. (required)--proxySpecifies a proxy server to use for HTTP, FTP, and HTTPS connections. The format is proxy-url:port.--helpShow the help message. |
software vib get | Displays detailed information about one or more installed VIBs on the host and the managed DPU(s). | --rebooting-imageDisplays information for the ESXi image which becomes active after a reboot, or nothing if the pending-reboot image has not been created yet. If not specified, information from the current ESXi image in memory will be returned.--vibname | -nSpecifies 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.--helpShow the help message. |
software vib install | Installs VIB packages from a URL or depot. VIBs may be installed, upgraded, or downgraded. WARNING: If your installation requires a reboot, you need to disable HA first. | --depot | -dSpecifies full remote URLs of the depot index.xml or server file path pointing to an offline bundle .zip file.--dry-runPerforms a dry-run only. Report the VIB-level operations that would be performed, but do not change anything in the system.--force | -fBypasses checks for package dependencies, conflicts, obsolescence, and acceptance levels. Really not recommended unless you know what you are doing. Use of this option will result in a warning being displayed in vSphere Web Client. Use this option only when instructed to do so by VMware Technical Support.--maintenance-modePretends 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-installForces 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-checkBypasses acceptance level verification, including signing. Use of this option poses a large security risk and will result in a SECURITY ALERT warning being displayed in vSphere Web Client.--proxySpecifies a proxy server to use for HTTP, FTP, and HTTPS connections. The format is proxy-url:port.--vibname | -nSpecifies VIBs from a depot, using one of the following forms: name, name:version, vendor:name, or vendor:name:version.--viburl | -vSpecifies one or more URLs to VIB packages to install. http:, https:, ftp:, and file: are all supported. If ‘file:’ is used, then the file path must be an absolute path on the ESXi host.--helpShow the help message. |
software vib list | Lists the installed VIB packages on the host and the managed DPU(s). | --rebooting-imageDisplays information for the ESXi image which becomes active after a reboot, or nothing if the pending-reboot image has not been created yet. If not specified, information from the current ESXi image in memory will be returned.--helpShow the help message. |
software vib remove | Removes VIB packages from the host. WARNING: If your installation requires a reboot, you need to disable HA first. | --dry-runPerforms a dry-run only. Report the VIB-level operations that would be performed, but do not change anything in the system.--force | -fBypasses checks for package dependencies, conflicts, obsolescence, and acceptance levels. Really not recommended unless you know what you are doing. Use of this option will result in a warning being displayed in vSphere Web Client. Use this option only when instructed to do so by VMware Technical Support.--maintenance-modePretends 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-installForces an remove to /altbootbank even if the VIBs are eligible for live removal. Will cause installation to be skipped on PXE-booted hosts.--vibname | -nSpecifies 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)--helpShow the help message. |
software vib update | Update installed VIBs to newer VIB packages. No new VIBs will be installed, only updates. WARNING: If your installation requires a reboot, you need to disable HA first. | --depot | -dSpecifies full remote URLs of the depot index.xml or server file path pointing to an offline bundle .zip file.--dry-runPerforms a dry-run only. Report the VIB-level operations that would be performed, but do not change anything in the system.--force | -fBypasses checks for package dependencies, conflicts, obsolescence, and acceptance levels. Really not recommended unless you know what you are doing. Use of this option will result in a warning being displayed in vSphere Web Client. Use this option only when instructed to do so by VMware Technical Support.--maintenance-modePretends 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-installForces 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-checkBypasses acceptance level verification, including signing. Use of this option poses a large security risk and will result in a SECURITY ALERT warning being displayed in vSphere Web Client.--proxySpecifies a proxy server to use for HTTP, FTP, and HTTPS connections. The format is proxy-url:port.--vibname | -nSpecifies VIBs from a depot, using one of the following forms: name, name:version, vendor:name, or vendor:name:version. VIB packages which are not updates will be skipped.--viburl | -vSpecifies 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.--helpShow the help message. |
software vib signature verify | Verifies the signatures of installed VIB packages on the host and the managed DPU(s) and displays the name, version, vendor, acceptance level and the result of signature verification for each of them | --rebooting-imageDisplays information for the ESXi image which becomes active after a reboot. If not specified, information from the current ESXi image in memory will be returned.--helpShow the help message. |
esxcli storage Commands
| COMMAND | DESCRIPTION | OPTIONS HELP |
|---|---|---|
storage core adapter list | List all the SCSI Host Bus Adapters on the system. | --helpShow the help message. |
storage core adapter rescan | Rescan SCSI HBAs to search for new Devices, remove DEAD paths and update path state. This operation will also run an claim operation equivalent to the claimrule run command and a filesystem rescan. | --adapter | -ASelect the adapter to use when rescanning SCSI adapters. This must be a SCSI HBA name as shown in the adapter list command. This cannot be used with the –all option--all | -aIndicate the rescan should rescan all adapters instead of a specific one.--skip-claim | -SBy default after an add operation a claiming session is run to find new devices and have them be claimed by the appropriate Multipath Plugin. Passing this flag will skip that claiming session.--skip-fs-scan | -FThis option is deprecated as no filesystem scan is performed by default--type | -tSpecify the type of rescan to perform. Available types areadd: 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. --helpShow the help message. |
storage core adapter capabilities list | List the capabilities of the SCSI HBAs in the system. | --adapter | -aLimit the capabilities output to one adapter--helpShow the help message. |
storage core adapter device list | List the devices associated with HBAs. | --adapter | -ALimit the output to one or more adapter(s).--helpShow the help message. |
storage core adapter stats get | List the SCSI stats for the SCSI Host Bus Adapters in the system. | --adapter | -aLimit the stats output to one adapter--helpShow the help message. |
storage core claiming autoclaim | Control the automatic PSA (path/device) claiming code allowing the disabling of the automatic claiming process or re-enabling of the claiming process if it was previously disabled. By default the automatic PSA claiming process is on and should not be disabled by users unless specifically instructed to do so. | --claimrule-class | -cIndicate the claim rule class to use in this operation [MP, Filter, VAAI, all]. NVMe devices will not be claimed by Filter/VAAI plugins.--enabledSet the autoclaiming enabled state for a givenPSA plugin type in the VMkernel. Default is to have this process enabled. This should not be changed by users unless specifically instructed to do so. (required)--wait | -wIf 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.--helpShow the help message. |
storage core claiming reclaim | Attempt to unclaim all paths to a device and then run the loaded claimrules on each of the paths unclaimed to attempt to reclaim them. | --device | -dReclaim requires the name of a device on which all paths will be unclaimed and then reclaimed. (required)--helpShow the help message. |
storage core claiming unclaim | 1) Unclaim a path or set of paths, disassociating them from a PSA plugin. NOTES: It is normal for path claiming to fail especially when unclaiming by plugin or adapter. Only inactive paths with no I/O will be able to be unclaimed. Typically the ESXi USB partition and devices with VMFS volumes on them will not be unclaimable. Also NOTE unclaiming will not persist and periodic path claiming will reclaim these paths in the near future unless claim rules are configured to mask the path. 2) Detach a (set of) filter(s) from one or more devices. | --adapter | -AIf the –type paramter is ‘location’ this value indicates the name of the host bus adapter for the paths you wish to unclaim. This parameter can be omitted to indicate unclaiming should be run on paths from all adapters.--channel | -CIf the –type parameter is ‘location’ this value indicates the value of the SCSI channel number for the paths you wish to unclaim. This parameter can be omitted to indicate unclaiming should be run on paths with any channel number.--claimrule-class | -cIndicate the claim rule class to use in this operation [MP, Filter]. NVMe devices will not be claimed by Filter/VAAI plugins.--device | -dIf the –type parameter is ‘device’ attempt to unclaim all paths to a specific device (for multipathing plugins) or unclaim the device itself (for filter plugins). NOTE. For paths, if there are any active I/O operations on this device, at least 1 path will fail to unclaim.--driver | -DIf the –type parameter is ‘driver’ attempt to unclaim all paths provided by a specific HBA driver.--lun | -LIf the –type parameter is ‘location’ this value indicates the value of the SCSI Logical Unit Number (LUN) for the paths you wish to unclaim. This parameter can be omitted to indicate unclaiming should be run on paths with any Logical Unit Number. If passed, this value must not be higher than the value of the advanced config option /Disk/MaxLUN--model | -mIf the –type parameter is ‘vendor’ attempt to unclaim all paths to devices with specific model info (for multipathing plugins) or unclaim the device itself (for filter plugins). NOTE. For paths, if there are any active I/O operations on this device, at least 1 path will fail to unclaim.--path | -pIf the –type parameter is ‘path’ attempt to unclaim a specific path given its path UID or runtime name.--plugin | -PIf the –type parameter is ‘plugin’ attempt to unclaim all paths on for a given multipath plugin OR all devices attached to a filter plugin.--target | -TIf the –type paramter is ‘location’ this value indicates the value of the SCSI target number for the paths you wish to unclaim. This parameter can be omitted to indicate unclaiming should be run on paths with any target number.--type | -tIndicate the type of unclaim you wish to perform. Valid values for this paramter are [location, path, driver, device, plugin, vendor] (required)--vendor | -vIf 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.--helpShow the help message. |
storage core claimrule add | Add a claimrule to the set of claimrules on the system. | --adapter | -AIndicate the adapter of the paths to use in this operation.--autoassign | -uThe system will auto assign a rule id.--boot | -bThis is a system default rule added at boot time. Do not modify Config-store or add to host profile.--channel | -CIndicate the channel of the paths to use in this operation.--claimrule-class | -cIndicate the claim rule class to use in this operation [MP, Filter, VAAI]. NVMe devices will not be claimed by Filter/VAAI plugins.--config-string | -gInput parameter string for multi path plugins that can include one or more comma separated key-value pairs without spaces in between. e.g. key1=value1,key2=value2. If plugin is HPP, the path selection scheme can be configured with same options available through ‘esxcli storage hpp device set’ without ‘–‘ prefix. Device can be marked local, remote, SSD using options ‘mark-device-local=true’, ‘mark-device-remote=true’, ‘mark-device-ssd=true’.--device | -dIndicate the Device Uid to use for this operation.--driver | -DIndicate the driver of the paths to use in this operation.--force | -fForce claim rules to ignore validity checks and install the rule anyway.--force-reservedOverride protection of reserved rule id ranges.--if-unsetExecute this command if this advanced user variable is not set to 1--iqn | -iIndicate the iSCSI Qualified Name for the target to use in this operation.--lun | -LIndicate the LUN of the paths to use in this operation. It must not be higher than the value of the advanced config option /Disk/MaxLUN--model | -MIndicate the model of the paths to use in this operation.--nvme-controller-modelNVMe controller model for the device. This option is specific to NVMe devices. Value can be partial string as prefix ending with wildcard ‘*’ e.g. abcd*. If this option is specified then –vendor/–model and –pci-vendor-id/–pci-sub-vendor-id should not be specified. This option is applicable for claimrule class ‘MP’.--pci-sub-vendor-idPCI sub vendor identifier for the device. The value should be hexadecimal number. For example, if PCI sub vendor ID is ‘0x8086’ then ‘8086’ should be provided as input. This option should be specified in combination with –pci-vendor-id and applicable in case of claimrule class ‘MP’.--pci-vendor-idPCI vendor identifier for the device. The value should be hexadecimal number. For example, if PCI vendor ID is ‘0x8086’ then ‘8086’ should be provided as input. –pci-sub-vendor-id can be specified along with this option. –vendor, –model or –nvme-controller-model options should not be specified with this option. This option is applicable for claimrule class ‘MP’.--plugin | -PIndicate which PSA plugin to use for this operation. (required)--rule | -rIndicate the rule ID to use for this operation.--target | -TIndicate the target of the paths to use in this operation.--transport | -RIndicate the transport of the paths to use in this operation. Valid Values are: [block, fc, iscsi, iscsivendor, ide, sas, sata, usb, parallel, fcoe, pcie, rdma, tcp, unknown]--type | -tIndicate which type of matching used for claim/unclaim or claimrule. Valid values are: [vendor, location, driver, transport, device, target] (required)--vendor | -VIndicate the vendor of the paths to use in this operation. If this option is specified then –nvme-controller-model and –pci-vendor-id/–pci-sub-vendor-id should not be specified.--wwnnIndicate the World-Wide Node Number for the target to use in this operation.--wwpnIndicate the World-Wide Port Number for the target to use in this operation.--xcopy-max-transfer-size | -mMaximum transfer size in MB to use for XCOPY commands if admin wants to use a transfer size different than array reported. This option only takes effect when –xcopy-use-array-values is specified. This option is deprecated. Use –xcopy-max-transfer-size-kib instead--xcopy-max-transfer-size-kib | -kMaximum transfer size in KiB to use for XCOPY commands if admin wants to use a transfer size different than array reported. This option only takes effect when –xcopy-use-array-values is specified. This option takes precedence over –xcopy-max-transfer-size option--xcopy-use-array-values | -aUse array reported values for XCOPY commands.--xcopy-use-multi-segs | -sUse multiple segments for XCOPY commandsThis option only takes effect when –xcopy-use-array-values is specified.--helpShow the help message. |
storage core claimrule convert | Convert ESX 3.x style /adv/Disk/MaskLUNs LUN masks to Claim Rule format. WARNING: This conversion will not work for all input MaskLUNs variations! Please inspect the list of generated claim rules carefuly, then if the suggested LUN mask claim rules are correct use the –commit parameter to write the list to the config file. | --commit | -CForce LUN mask config changes to be saved. If this parameter is omitted, config file changes will not be saved.--helpShow the help message. |
storage core claimrule list | List all the claimrules on the system. | --claimrule-class | -cIndicate the claim rule class to use in this operation [MP, Filter, VAAI, all]. NVMe devices will not be claimed by Filter/VAAI plugins.--helpShow the help message. |
storage core claimrule load | Load path claiming rules from config file into the VMkernel. | --claimrule-class | -cIndicate the claim rule class to use in this operation [MP, Filter, VAAI, all]. NVMe devices will not be claimed by Filter/VAAI plugins.--helpShow the help message. |
storage core claimrule move | Move a claimrule from one rule id to another | --claimrule-class | -cIndicate the claim rule class to use in this operation [MP, Filter, VAAI]. NVMe devices will not be claimed by Filter/VAAI plugins.--force-reservedOverride protection of reserved rule id ranges.--new-rule | -nIndicate the new rule id you wish to apply to the rule given by the –rule parameter. (required)--rule | -rIndicate the rule ID to use for this operation. (required)--helpShow the help message. |
storage core claimrule remove | Delete a claimrule to the set of claimrules on the system. | --claimrule-class | -cIndicate the claim rule class to use in this operation [MP, Filter, VAAI]. NVMe devices will not be claimed by Filter/VAAI plugins.--plugin | -PIndicate the plugin to use for this operation.--rule | -rIndicate the rule ID to use for this operation.--helpShow the help message. |
storage core claimrule run | Execute path claiming rules. | --adapter | -AIf the –type parameter is ‘location’ this value indicates the name of the host bus adapter for the paths you wish to run claim rules on. This parameter can be omitted to indicate claim rules should be run on paths from all adapters.--channel | -CIf the –type parameter is ‘location’ this value indicates the value of the SCSI channel number for the paths you wish to run claim rules on. This parameter can be omitted to indicate claim rules should be run on paths with any channel number.--claimrule-class | -cIndicate the claim rule class to use in this operation [MP, Filter]. NVMe devices will not be claimed by Filter/VAAI plugins.--device | -dIndicate the Device Uid to use for this operation.--lun | -LIf the –type paramter is ‘location’ this value indicates the value of the SCSI Logical Unit Number (LUN) for the paths you wish to run claim rules on. This parameter can be omitted to indicate claim rules should be run on paths with any Logical Unit Number.--path | -pIf the –type paramter is ‘path’ this value indicates the unique path identifier (UID) or the runtime name of a path which you wish to run claim rules on.--target | -TIf the –type parameter is ‘location’ this value indicates the value of the SCSI target number for the paths you wish to run claim rules on. This parameter can be omitted to indicate claim rules should be run on paths with any target number.--type | -tIndicate the type of claim run you wish to perform. By default the value of ‘all’ will be used indicating you wish to run claim rules without restricting the run to specific paths or SCSI addresses. Valid values for this parameter are [location, path, device, all]--wait | -wIf 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.--helpShow the help message. |
storage core device list | List the devices currently registered with the PSA. | --device | -dFilter the output of this command to only show a single device.--exclude-offline | -oIf set this flag will exclude the offline devices--pe-only | -pIf set this flag will list the mount points of pe type.--skip-slow-fieldsDo not show the value of some fields that need more time to fetch. The output will show the value <skipped> for such fields.--helpShow the help message. |
storage core device purge | Removes storage devices which have not been seen in some time interval. | --force | -fPurge the LUNs that are not in active state.--interval | -iTimeout interval (in days) for storage device removal. If a storage device has not been seen for the specified number of days, it will be removed. If not specified, the advanced setting ‘/Scsi/LunCleanupInterval’ will be used (see esxcli system settings advanced list and esxcli system settings advanced set).--helpShow the help message. |
storage core device set | Modify the state of a storage device. | --data-integrity-enabled | -IEnable / Disable device data integrity 0 -> Protection disabled 1 -> Protection enabled.Please refer to ESX release notes for more Information--default-name | -DSet the default display name for the device. If there is an existing user defined name it will be changed.--device | -dThe device upon which to operate. This can be any of the UIDs that a device reports. (required)--force | -fForce the device state to be set.--led-duration | -LSet the duration of LED in seconds. If not specified, use maximum duration that hardware can support.--led-state | -lSet the disk LED state. Valid values are:error: Turn on error LED. locator: Turn on locator LED. off: Turn off LED. --max-queue-depth | -mSet device’s max queue depth.--name | -nThe new name to assign the given device.--no-persist | -NSet device state non-persistently; state is lost after reboot.--queue-full-sample-size | -sSet device’s queue full sample size. IO samples to monitor for detecting non-transient queue full condition. Should be non zero to enable queue depth throttling.--queue-full-threshold | -qSet device’s queue full threshold. BUSY or QFULL threshold,upon which LUN queue depth will be throttled. Should be <= queue-full-sample-size if throttling is enabled.--sched-num-req-outstanding | -OSet number of outstanding IOs with competing worlds.--stateSet the storage device state for the specific device given. Valid values are:off: Set the device’s state to OFF. on: Set the device’s state to ON. --write-cache-enabled | -wSet device’s write cache state.--helpShow the help message. |
storage core device setconfig | Set device configuration | --detachedMark device as detached.--device | -dThe device upon which to operate. This can be any of the UIDs that a device reports. (required)--perennially-reservedMark device as perennially reserved.--shared-clusterwideMark device as not shared clusterwide.--helpShow the help message. |
storage core device capacity list | List capacity information for the known storage devices. | --device | -dLimit the output to a specific device.--helpShow the help message. |
storage core device detached list | Lists all devices that were detached manually by changing their state on the system. | --device | -dFilter the output of the command to limit the output to a specific device.--helpShow the help message. |
storage core device detached remove | Provide control to allow a user to remove Detached devices from the persistent detached device list. | --all | -aIf set, all devices will be removed from the Detached Device List.--device | -dSelect the detached device to remove from the Detached Device List.--helpShow the help message. |
storage core device inquirycache list | List inquiry cache information for the known storage devices. | --device | -dLimit the output to a specific device.--helpShow the help message. |
storage core device inquirycache set | Manipulate inquiry cache settings of storage devices. | --apply-allOperate on all existing devices.--device | -dNAA ID of the device upon which to operate.--ignoreIgnore device inquiry cache. (required)--helpShow the help message. |
storage core device latencythreshold list | List latency sensitive threshold for the known storage devices. | --device | -dLimit the output to a specific device.--helpShow the help message. |
storage core device latencythreshold set | Set latency sensitive threshold for devices. This option is applicable only for devices claimed by MPPs that support fastpath. The device(s) can be selected based on the mutually exclusive parameters device name, vendor/model, NVMe controller model (For NVMe devices), PCIe vendor ID/PCIe sub vendor ID. See the examples for more details. | --device | -dSelect the device by its device name.--latency-sensitive-threshold | -tSet device’s latency sensitive threshold (in milliseconds). If IO latency exceeds the threshold, new IOs will use the default IO scheduler. (required)--model | -mSelect the devices based on model in addition to its vendor. Select by model prefix if the value ends with ‘*’. Only valid with option –vendor.--nvme-controller-model | -cSelect the NVMe devices based on NVMe controller model. Select by NVMe controller model prefix if the value ends with ‘*’. Controller model for a NVMe device can be found in ‘Model’ field under ‘storage core device list’ output.--pci-sub-vendor-id | -sSelect the devices based on PCI sub vendor ID in addition to its PCI vendor ID. This is a hexadecimal number without leading ‘0x’.--pci-vendor-id | -pSelect the devices based on PCI vendor ID. This is a hexadecimal number without leading ‘0x’. –pci-sub-vendor-id can be specified with this option--vendor | -vSelect the devices based on vendor. Select by vendor prefix if the value ends with ‘*’. –model can be specified along with this option.--helpShow the help message. |
storage core device partition list | For a given device list all of the partitions | --device | -dFilter the output to a specific device.--helpShow the help message. |
storage core device partition showguid | For a given device list the GUID for GPT partitions | --device | -dFilter the output to a specific device.--helpShow the help message. |
storage core device physical get | Get information about a physical storage device. | --device | -dSpecify a device name. (required)--helpShow the help message. |
storage core device raid list | List the physical devices that compose a given logical device. | --device | -dSpecify a device name. (required)--helpShow the help message. |
storage core device smart get | List Smart device parameters. | --device-name | -dThe Smart device name (required)--helpShow the help message. |
storage core device smart daemon start | Enable smartd. | --helpShow the help message. |
storage core device smart daemon stop | Disable smartd. | --helpShow the help message. |
storage core device smart daemon status get | Get status of smartd. | --helpShow the help message. |
storage core device smart status get | Get status of SMART stats on a device. | --device-name | -dThe SMART device name. (required)--helpShow the help message. |
storage core device smart status set | Enable or disable SMART stats gathering on a device. | --device-name | -dThe SMART device name. (required)--enabled | -eEnable or disable SMART stats gathering. (required)--helpShow the help message. |
storage core device stats get | List the SCSI stats for SCSI Devices in the system. | --device | -dLimit the stats output to one specific device. This device name can be any of the UIDs the device reports--helpShow the help message. |
storage core device uidmap list | Get a mapping between a device’s primary UID and the alternative UIDs for that device on the system. | --device | -dFilter 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.--helpShow the help message. |
storage core device vaai ats list | List the ATS VAAI attributes (as per SCSI standard) for the devices. | --device | -dFilter the output of this command to only show a single device.--helpShow the help message. |
storage core device vaai clone list | List the Clone VAAI attributes (as per SCSI standard) for the devices. | --device | -dFilter the output of this command to only show a single device.--helpShow the help message. |
storage core device vaai delete list | List the Delete VAAI attributes (as per SCSI standard) for the devices. | --device | -dFilter the output of this command to only show a single device.--helpShow the help message. |
storage core device vaai status get | List VAAI properties for devices currently registered with the PSA. | --device | -dFilter the output of this command to only show a single device.--helpShow the help message. |
storage core device vaai status set | Enable/Disable VAAI operations on local SCSI disks. (NOTE: A request to enable an operation will take effect only if the underlying device supports the VAAI operation.) | --ats | -AEnable or Disable ATS operation (1/0)--clone | -CEnable or Disable CLONE operation (1/0)--delete | -DEnable or Disable DELETE operation (1/0)--device | -dThe device upon which to operate (NAA ID). (required)--zero | -ZEnable or Disable ZERO operation (1/0)--helpShow the help message. |
storage core device vaai zero list | List the Zero VAAI attributes (as per SCSI standard) for the devices. | --device | -dFilter the output of this command to only show a single device.--helpShow the help message. |
storage core device world list | Get a list of the worlds that are currently using devices on the ESX host. | --device | -dFilter 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.--helpShow the help message. |
storage core nvme device list | List the NVMe devices currently registered with the PSA. | --device | -dFilter the output of this command to only show a single device.--exclude-offline | -oIf set this flag will exclude the offline devices.--pe-only | -pIf set this flag will list the mount points of PE type.--skip-slow-fieldsDo not show the value of some fields that need more time to fetch. The output will show the value <skipped> for such fields.--helpShow the help message. |
storage core nvme path list | List all the NVMe paths on the system. | --device | -dLimit the output to paths to a specific device. This name can be any of the UIDs for a specific device.--path | -pLimit the output to a specific path. This name can be either the UID or the runtime name of the path.--helpShow the help message. |
storage core path list | List all the storage paths on the system. | --device | -dLimit the output to paths to a specific device. This name can be any of the UIDs for a specific device.--path | -pLimit the output to a specific path. This name can be either the UID or the runtime name of the path.--helpShow the help message. |
storage core path set | Provide control to allow a user to modify a single path’s state. This efffectively allows a user to enable or disable storage paths. The user is not able to change the full range of path states, but can toggle between ‘active’ and ‘off’. Please NOTE changing the Path state on any path that is the only path to a given device is likely to fail. The VMkernel will not change the path’s state if changing the state would cause an ‘All paths down’ state or the device is currently in use. | --path | -pSelect the path to set path state on. This can be a Runtime Name or Path UID (required)--stateSet the storage path state for the specific path given. Valid values are:active: Set the path’s state to active. This may be immediately changed by the system to another state if the active state is not appropriate. off: Administratively disable this path. (required) --helpShow the help message. |
storage core path stats get | List the SCSI stats for the SCSI Paths in the system. | --path | -pLimit the stats output to one specific path. This path name can be the runtime name or the path UID.--helpShow the help message. |
storage core plugin list | List loaded PSA plugins on the system. | --plugin-class | -NIndicate 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) --helpShow the help message. |
storage core plugin registration add | Register a plugin module with PSA. | --dependencies | -dAdd the [optional] dependencies for this module to loaded--full-path | -IAdd the [optional] full path to this module--module-name | -mSelect the module name to be registered (required)--plugin-class | -NIndicate the class of plugin to register. Allowed values are MP, VAAI or MPP defined subplugins like PSP, SATP. (required)--plugin-name | -PSelect the plugin name to be registered (required)--helpShow the help message. |
storage core plugin registration list | List modules currently registered with PSA. | --module-name | -mFilter the output of this command to only show a single module.--plugin-class | -NIndicate the class of plugin to list. Allowed values are MP, VAAI or MPP defined subplugins like PSP, SATP.--helpShow the help message. |
storage core plugin registration remove | UnRegister a plugin module with PSA. | --module-name | -mSelect the module name to be unregistered (required)--helpShow the help message. |
storage core scsi device list | List the SCSI devices currently registered with the PSA. | --device | -dFilter the output of this command to only show a single device.--exclude-offline | -oIf set this flag will exclude the offline devices.--pe-only | -pIf set this flag will list the mount points of PE type.--skip-slow-fieldsDo not show the value of some fields that need more time to fetch. The output will show the value <skipped> for such fields.--helpShow the help message. |
storage core scsi path list | List all the SCSI paths on the system. | --device | -dLimit the output to paths to a specific device. This name can be any of the UIDs for a specific device.--path | -pLimit the output to a specific path. This name can be either the UID or the runtime name of the path.--helpShow the help message. |
storage filesystem automount | Request mounting of known datastores not explicitly unmounted. | --helpShow the help message. |
storage filesystem list | List the volumes available to the host. This includes VMFS, NAS, VFAT and UFS partitions. | --ignore-errors | -iIgnore errors encountered (if any) while retrieving information for each file system.--uuid | -uOnly show information for the filesystem with the specified UUID.--helpShow the help message. |
storage filesystem mount | Connect to and mount an unmounted volume on the ESX host. | --no-persist | -nMount the volume non-persistently; the volume will not be mounted after a restart.--volume-label | -lThe label of the volume to mount. This volume must be unmounted for this operation to succeed.--volume-uuid | -uThe UUID of the VMFS filesystem to mount. This volume must be unmounted for this operation to succeed.--helpShow the help message. |
storage filesystem rescan | Scan storage devices for new mountable filesystems. | --helpShow the help message. |
storage filesystem unmount | Disconnect and unmount and existing VMFS or NAS volume. This will not delete the configuration for the volume, but will remove the volume from the list of mounted volumes. | --no-persist | -nUnmount the volume non-persistently; the volume will be automounted after a restart.--unmount-all-vmfs | -aUnmount all vmfs volumes.--volume-label | -lThe label of the volume to unmount.--volume-path | -pThe path of the volume to unmount.--volume-uuid | -uThe uuid of the volume to unmount.--helpShow the help message. |
storage hpp device list | List the devices currently controlled by the VMware High Performance Plugin. | --device | -dFilter the output of this command to only show a single device.--helpShow the help message. |
storage hpp device set | Configure settings for an HPP device. | --bytes | -BMaximum bytes on the path after which the path will be switched.--cfg-fileUpdate the config file and runtime with the new setting. In case device is claimed by another PSS, ignore any errors when applying to runtime configuration.--device | -dThe HPP device upon which to operate. This can be any of the UIDs that a device reports. (required)--iops | -IMaximum IOPS on the path after which the path will be switched.--latency-eval-time | -TInterval at which the latency of paths is evaluated (in ms).--mark-device-local | -LSet whether or not HPP should treat the device as local.--mark-device-ssd | -MSet whether or not HPP should treat the device as an SSD.--path | -pThe path you wish to set as the preferred path for the given device.--pss | -PThe path selection scheme you wish to assign to the given device. One of the following options can be specified as input. Default values will be chosen for unspecified options.FIXED: Fixed path is chosen for the I/Os. Preferred path can be specified using –path option. LB-BYTES: Load Balance – Bytes scheme selects optimal path having least outstanding bytes. –bytes option can be specified as input. LB-IOPS: Load Balance – IOPS scheme selects optimal path having least outstanding I/Os. –iops option can be specified as input. LB-Latency: Load Balance – Latency scheme selects optimal path having least latency. –latency-eval-time and/or –sampling-ios-per-path options can be specified as input. LB-RR: [Default] Load Balance – Round Robin scheme chooses path in round robin manner based on IOPS and bytes count. –iops and/or –bytes options can be specified as input. This is the default path selection scheme for the device. default: Default scheme[LB-RR] for the device. --sampling-ios-per-path | -SNumber of I/Os to be issued on each path to calculate the latency on the path--use-ano | -USet the option to ‘true’ to include non-optimized paths in the set of active paths used to issue I/Os on this device, otherwise set it to ‘false’.--helpShow the help message. |
storage hpp device usermarkedssd list | List the devices that were marked/unmarked as SSD by user. | --device | -dFilter the output of the command to limit the output to a specific device.--helpShow the help message. |
storage hpp path list | List the paths currently claimed by the VMware High Performance Plugin | --device | -dFilter the output of this command to only show info for a single device.--path | -pFilter the output of this command to only show a single path.--type | -tFilter the output of this command to only list protocol(scsi/nvme) specific paths(–type=scsi or –type=nvme).--helpShow the help message. |
storage iofilter enable | Enable an iofilter. | --filter | -fName of the iofilter. (required)--helpShow the help message. |
storage iofilter list | List the iofilters installed on this host. | --filter | -fFilter the output of this command to only show a single iofilter.--helpShow the help message. |
storage nfs add | Add a new NAS volume to the ESX Host and mount it with the given volume name. | --host | -HThe hostname or IP address of the NAS volume to add and mount on the system. (required)--ispe | -pIf set this flag will set the mount point to be PE.--readonly | -rIf set this flag will set the mount point to be read-only.--share | -sThe share name on the remote system to use for this NAS mount point. (required)--unsupported-mount-retry--unsupported-queue-depth--volume-name | -vThe 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)--helpShow the help message. |
storage nfs list | List the NAS volumes currently known to the ESX host. | --pe-only | -pFilter the output to only show VVol PE volumes--helpShow the help message. |
storage nfs remove | Remove an existing NAS volume from the ESX host. | --volume-name | -vThe volume name of the NAS volume to remove from the ESX host. (required)--helpShow the help message. |
storage nfs param get | Get the volume parameters of the NAS volumes. | --volume-name | -vNAS volume name(“all” to list all). (required)--helpShow the help message. |
storage nfs param set | Set the volume parameters of the NAS volumes. | --maxqueuedepth | -qThe maximum queue depth for the NAS volume.--volume-name | -vThe NAS volume name. (required)--helpShow the help message. |
storage nfs41 add | Add a new NFS v4.1 volume to the ESX Host and mount it with the given volume name. | --hosts | -HThe hostname(s) or IP address(es) (comma-separated) of the server for the NFS v4.1 volume to add and mount on the system. (required)--ispe | -pIf set, this flag will set the mount point to be PE.--readonly | -rIf set, this flag will make the mount point be read-only.--sec | -aSecurity flavors. Acceptable values are: [AUTH_SYS, SEC_KRB5, SEC_KRB5I].--share | -sThe share name on the remote system to use for this NFS v4.1 mount point. (required)--volume-name | -vThe volume name to use for the NFS v4.1 mount. This must be a unique volume name and cannot conflict with existing NAS, NFS v4.1, VMFS, or other volume names. (required)--helpShow the help message. |
storage nfs41 list | List the NFS v4.1 volumes currently known to the ESX host. | --pe-only | -pFilter the output to only show VVol PE Volumes--helpShow the help message. |
storage nfs41 remove | Remove an existing NFS v4.1 volume from the ESX host. | --volume-name | -vThe volume name of the NFS v4.1 volume to remove from the ESX host. (required)--helpShow the help message. |
storage nfs41 param get | Get the volume parameters of the NFS v4.1 volumes. | --volume-name | -vNFS v4.1 volume name(“all” to list all). (required)--helpShow the help message. |
storage nfs41 param set | Set the volume parameters of the NFS v4.1 volumes. | --maxqueuedepth | -qThe maximum queue depth for the NFS v4.1 volume.--volume-name | -vThe NFS v4.1 volume name. (required)--helpShow the help message. |
storage nmp device list | List the devices currently controlled by the VMware NMP Multipath Plugin and show the SATP and PSP information associated with that device. | --device | -dFilter the output of this command to only show a single device.--helpShow the help message. |
storage nmp device set | Allow setting of the Path Selection Policy (PSP) for the given device to one of the loaded policies on the system. | --default | -EThe Path selection policy is set back to the default for the assigned SATP for this device.--device | -dThe device you wish to set the Path Selection Policy for. (required)--psp | -PThe Path selection policy you wish to assign to the given device.--helpShow the help message. |
storage nmp path list | List the paths currently claimed by the VMware NMP Multipath Plugin and show the SATP and PSP information associated with that path. | --device | -dFilter the output of this command to only show paths to a single device.--path | -pFilter the output of this command to only show a single path.--helpShow the help message. |
storage nmp psp list | List the Path Selection Plugins (PSP) that are currently loaded into the NMP system and display information about those PSPs | --helpShow the help message. |
storage nmp psp fixed deviceconfig get | Allow retrieving of Fixed Path Selection Policy settings for a given device. | --device | -dThe device you wish to get the Preferred path for. (required)--helpShow the help message. |
storage nmp psp fixed deviceconfig set | Allow setting of the perferred path on a given device controlled by the Fixed Path Selection Policy. | --cfgfile | -gUpdate the config file and runtime with the new setting. In case device is claimed by another PSP, ignore any errors when applying to runtime configuration.--default | -EClear the preferred path selection for the given device.--device | -dThe device you wish to set the preferred path for. This device must be controlled by the Fixed Path Selection Policy(except when -g is specified) (required)--path | -pThe path you wish to set as the preferred path for the given device.--helpShow the help message. |
storage nmp psp generic deviceconfig get | Allow retrieving of per device PSP configuration parameters. | --device | -dThe device you wish to get PSP configuration for. (required)--helpShow the help message. |
storage nmp psp generic deviceconfig set | Allow setting of per device PSP configuration parameters. This command will set the configuration for the given device with whichever PSP it is currently configurated with. | --cfgfile | -gUpdate the config file and runtime with the new setting. In case device is claimed by another PSP, ignore any errors when applying to runtime configuration.--config | -cThe configuration string you wish to set. (required)--device | -dThe device you wish to set PSP configuration for. (required)--helpShow the help message. |
storage nmp psp generic pathconfig get | Allow retrieving of per path PSP configuration parameters. | --path | -pThe path you wish to get PSP configuration for. (required)--helpShow the help message. |
storage nmp psp generic pathconfig set | Allow setting of per path PSP configuration parameters. This command will set the configuration for the given path with whichever PSP it is currently configurated with. | --cfgfile | -gUpdate the config file and runtime with the new setting. In case device is claimed by another PSP, ignore any errors when applying to runtime configuration.--config | -cThe configuration string you wish to set. (required)--path | -pThe path you wish to set PSP configuration for. (required)--helpShow the help message. |
storage nmp psp roundrobin deviceconfig get | Allow retrieving of Round Robin Path Selection Policy settings for a given device. | --device | -dThe device you wish to get the Round Robin properties for. (required)--helpShow the help message. |
storage nmp psp roundrobin deviceconfig set | Allow setting of the Round Robin path options on a given device controlled by the Round Robin Selection Policy. | --bytes | -BWhen the –type option is set to ‘bytes’ this is the value that will be assigned to the byte limit value for this device.--cfgfile | -gUpdate the config file and runtime with the new setting. In case device is claimed by another PSP, ignore any errors when applying to runtime configuration.--device | -dThe device you wish to set the Round Robin settings for. This device must be controlled by the Round Robin Path Selection Policy(except when -g is specified) (required)--iops | -IWhen the –type option is set to ‘iops’ this is the value that will be assigned to the I/O operation limit value for this device.--latency-eval-time | -TWhen the –type option is set to ‘latency’ this value can control at what interval (in ms) the latency of paths should be evaluated.--num-sampling-cycles | -SWhen the –type option is set to ‘latency’ this value will control how many sample IOs should be issued on each path to calculate latency of the path.--type | -tSet the type of the Round Robin path switching that should be enabled for this device. Valid values for type are:bytes: Set the trigger for path switching based on the number of bytes sent down a path. default: Set the trigger for path switching back to default values. iops: Set the trigger for path switching based on the number of I/O operations on a path. latency: Set the trigger for path switching based on latency and pending IOs on path. --useano | -USet 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--helpShow the help message. |
storage nmp satp list | List the Storage Array Type Plugins (SATP) that are currently loaded into the NMP system and display information about those SATPs | --helpShow the help message. |
storage nmp satp set | Set the default Path Selection Policy for a given Storage Array Type Plugin (SATP). | --boot | -bThis is a system default rule added at boot time. Do not modify esx.conf or add to host profile.--default-psp | -PThe default path selection policy to set for a given –satp (required)--satp | -sThe SATP name for the Storage Array Type Plugin on which this command will operate. (required)--helpShow the help message. |
storage nmp satp generic deviceconfig get | Allow retrieving of per device SATP configuration parameters. | --device | -dThe device you wish to get SATP configuration for. (required)--exclude-tpg-info | -eExclude TPG info from the device’s SATP configuration.--helpShow the help message. |
storage nmp satp generic deviceconfig set | Allow setting of per device SATP configuration parameters. This command will set the configuration for the given device with whichever SATP it is currently configurated with. | --config | -cThe configuration string you wish to set. (required)--device | -dThe device you wish to set SATP configuration for.--helpShow the help message. |
storage nmp satp generic pathconfig get | Allow retrieving of per path SATP configuration parameters. | --path | -pThe path you wish to get SATP configuration for. (required)--helpShow the help message. |
storage nmp satp generic pathconfig set | Allow setting of per path SATP configuration parameters. This command will set the configuration for the given path with whichever SATP it is currently configurated with. | --config | -cThe configuration string you wish to set. (required)--path | -pThe path you wish to set SATP configuration for. (required)--helpShow the help message. |
storage nmp satp rule add | Add a rule to the list of claim rules for the given SATP. | --boot | -bThis is a system default rule added at boot time. Do not modify esx.conf or add to host profile.--claim-option | -cSet the claim option string when adding a SATP claim rule.--description | -eSet the claim rule description when adding a SATP claim rule.--device | -dSet the device when adding SATP claim rules. Device rules are mutually exclusive with vendor/model and driver rules.--driver | -DSet the driver string when adding a SATP claim rule. Driver rules are mutually exclusive with vendor/model rules.--force | -fForce claim rules to ignore validity checks and install the rule anyway.--model | -MSet the model string when adding SATP a claim rule. Vendor/Model rules are mutually exclusive with driver rules.--option | -oSet the option string when adding a SATP claim rule.--psp | -PSet the default PSP for the SATP claim rule.--psp-option | -OSet the PSP options for the SATP claim rule.--satp | -sThe SATP for which a new rule will be added. (required)--transport | -RSet the claim transport type string when adding a SATP claim rule.--type | -tSet the claim type when adding a SATP claim rule.--vendor | -VSet the vendor string when adding SATP claim rules. Vendor/Model rules are mutually exclusive with driver rules.--helpShow the help message. |
storage nmp satp rule list | List the claiming rules for Storage Array Type Plugins (SATP) | --satp | -sFilter the SATP rules to a specific SATP--helpShow the help message. |
storage nmp satp rule remove | Delete a rule from the list of claim rules for the given SATP. | --boot | -bThis is a system default rule added at boot time. Do not modify esx.conf or add to host profile.--claim-option | -cThe claim option string for the SATP claim rule to delete.--description | -eThe desription string for the SATP claim rule to delete.--device | -dThe device for the SATP claim rule to delete--driver | -DThe driver string for the SATP claim rule to delete.--force | -fIgnore validity checks and remove the rule anyway.--model | -MThe model string for the SATP claim rule to delete.--option | -oThe option string for the SATP claim rule to delete.--psp | -PThe default PSP for the SATP claim rule to delete.--psp-option | -OThe PSP options for the SATP claim rule to delete.--satp | -sThe SATP for which a rule will be deleted. (required)--transport | -RThe transport type for the SATP claim rule to delete.--type | -tSet the claim type when adding a SATP claim rule.--vendor | -VThe vendor string for the SATP claim rule to delete--helpShow the help message. |
storage osdata create | Create an OSData partition on a disk. | --clearpartitionsErase existing partitions and force the operation.--diskname | -dTarget disk device on which to create the OSData partition. (required)--mediasize | -mThe size of the created partition.default: 128 GB max: Use whole device min: 32 GB small: 64 GB (required) --helpShow the help message. |
storage san fc list | List attributes of all FC adapters on the system. | --adapter | -AFC adapter name (vmhbaX), or none, to list all.--helpShow the help message. |
storage san fc reset | Perform LIP (Loop Initiation Primitive) Reset to a given FC adapter on the system. | --adapter | -AIssue LIP Reset command to given Fibre Channel HBA. (required)--helpShow the help message. |
storage san fc events clear | Clear events for a given FC adapter on the system. | --adapter | -AIssue Clear Event command to specified Fibre Channel HBA. (required)--helpShow the help message. |
storage san fc events get | Get Events for FC Devices | --adapter | -AFC adapter name (vmhbaX), or none, to retrieve all.--helpShow the help message. |
storage san fc stats get | Get statistics for a given FC adapter, or all FC adapters on the system. | --adapter | -AFC adapter name (vmhbaX), or none, to list all.--helpShow the help message. |
storage san fcoe list | List attributes of all FCoE adapters on the system. | --adapter | -AFCoE adapter name (vmhbaX), or none, to list all.--helpShow the help message. |
storage san fcoe reset | Perform LIP (Loop Initiation Primitive) Reset to a given FCoE adapter on the system. | --adapter | -AIssue LIP Reset command to given hba. (required)--helpShow the help message. |
storage san fcoe stats get | Get statistics for a given FCoE adapter, or all FCoE adapters on the system. | --adapter | -AFCoE adapter name (vmhbaX), or none, to list all.--helpShow the help message. |
storage san iscsi list | List attributes of all Software iSCSI adapters on the system. | --adapter | -AiSCSI adapter name (vmhbaX), or none, to list all.--helpShow the help message. |
storage san iscsi stats get | Get statistics for Software iSCSI adapter. | --adapter | -AiSCSI device name (vmhbaX), or none, to list all.--helpShow the help message. |
storage san sas list | List all SAS IO Device Management devices. | --adapter | -ASAS adapter name (vmhbaX), or none, to list all.--helpShow the help message. |
storage san sas reset | Perform SAS Reset | --adapter | -AIssue Reset command to given hba. (required)--helpShow the help message. |
storage san sas stats get | List Stats for given device, or all devices. | --adapter | -ASAS adapter name (vmhbaX), or none, to list all.--fail-on-error | -FDo not ignore errors when fetching stats for all devices.--helpShow the help message. |
storage vflash device list | List vflash SSD devices. | --eligible | -eList the eligible / ineligible SSD devices for vflash.--used | -uList the used / unused SSD devices for vflash.--helpShow the help message. |
storage vflash module get | Get vflash module info. | --module-name | -mThe vflash module name--helpShow the help message. |
storage vflash module list | List vflash modules. | --helpShow the help message. |
storage vflash module stats get | Get vflash module statistics | --module-name | -mThe vflash module name--helpShow the help message. |
storage vmfs unmap | Reclaim the space by unmapping free blocks from VMFS Volume | --reclaim-unit | -nNumber of VMFS blocks that should be unmapped per iteration.--volume-label | -lThe label of the VMFS volume to unmap the free blocks.--volume-uuid | -uThe uuid of the VMFS volume to unmap the free blocks.--helpShow the help message. |
storage vmfs upgrade | Upgrade a VMFS3 volume to VMFS5. | --volume-label | -lThe label of the VMFS volume to upgrade.--volume-uuid | -uThe uuid of the VMFS volume to upgrade.--helpShow the help message. |
storage vmfs extent list | List the VMFS extents available on the host. | --ignore-errors | -iIgnore errors encountered (if any) while retrieving information for each file system.--helpShow the help message. |
storage vmfs host list | List hosts accessing a particular VMFS Volume. | --liveness | -vThe type of liveness check to perform on the VMFS volume. Valid values are [none, quick] (default is none).--volume-label | -lThe label of the target VMFS volume.--volume-uuid | -uThe uuid of the target VMFS volume.--helpShow the help message. |
storage vmfs lockmode list | List the on-disk critical section locking mode for VMFS volumes available on this host. | --ignore-errors | -iIgnore errors encountered (if any) while retrieving information for each file system.--volume-label | -lThe label of the target VMFS volume.--volume-uuid | -uThe uuid of the target VMFS volume.--helpShow the help message. |
storage vmfs lockmode set | Update the on-disk critical section locking mode for a particular VMFS Volume. | --ats | -aEnable ATS-only locking.--scsi | -sEnable SCSI locking.--volume-label | -lThe label of the target VMFS volume.--volume-uuid | -uThe uuid of the target VMFS volume.--helpShow the help message. |
storage vmfs pbcache get | Get VMFS Pointer Block cache statistics. | --helpShow the help message. |
storage vmfs pbcache reset | Reset the VMFS Pointer Block cache statistics. | --helpShow the help message. |
storage vmfs reclaim config get | Get space reclamation configuration parameters | --volume-label | -lThe label of the target VMFS volume.--volume-uuid | -uThe uuid of the target VMFS volume.--helpShow the help message. |
storage vmfs reclaim config set | Set space reclamation configuration parameters | --reclaim-bandwidth | -bSpace reclamation fixed bandwidth (MB/s)--reclaim-granularity | -gMinimum granularity of automatic space reclamation in bytes--reclaim-method | -mMethod of automatic space reclamation. Supported options are [priority, fixed].--reclaim-priority | -pPriority of automatic space reclamation. Supported options are [none, low, medium, high].--volume-label | -lThe label of the target VMFS volume.--volume-uuid | -uThe uuid of the target VMFS volume.--helpShow the help message. |
storage vmfs snapshot list | List unresolved snapshots/replicas of VMFS volume. | --volume-label | -lThe VMFS volume label of the snapshot to list.--volume-uuid | -uThe VMFS volume uuid of the snapshot to list.--helpShow the help message. |
storage vmfs snapshot mount | Mount a snapshot/replica of a VMFS volume. | --no-persist | -nMount the volume non-persistently; the volume will not be automounted after a restart.--volume-label | -lThe VMFS volume label of the snapshot to mount.--volume-uuid | -uThe VMFS volume uuid of the snapshot to mount.--helpShow the help message. |
storage vmfs snapshot resignature | Resignature a snapshot/replica of a VMFS volume. | --volume-label | -lThe VMFS volume label of the snapshot to resignature.--volume-uuid | -uThe VMFS volume uuid of the snapshot to resignature.--helpShow the help message. |
storage vmfs snapshot extent list | List extents of unresolved snapshots/replicas of VMFS volume. | --volume-label | -lThe VMFS volume label of the target snapshot to enumerate.--volume-uuid | -uThe VMFS volume uuid of the target snapshot to enumerate.--helpShow the help message. |
storage vvol daemon unbindall | Unbind all Virtual Volumes from all VASA Providers known to this host. | --helpShow the help message. |
storage vvol protocolendpoint list | List the VVol Protocol EndPoints currently known to this host. | --pe | -pShow Protocol Endpoint (PE) information associated with the given VASA PE ID.--pe-type | -tPE type to display. Acceptable values are: [SCSI, NFS, NFS4x].--helpShow the help message. |
storage vvol stats add | Add entity for stats tracking | --entity | -eentity Id (required)--namespace | -nentity namespace (required)--helpShow the help message. |
storage vvol stats disable | Disable stats for complete namespace | --helpShow the help message. |
storage vvol stats enable | Enable stats for complete namespace | --helpShow the help message. |
storage vvol stats get | Get stats for given stats namespace | --dump | -dDump the stats in log file with given custom message--entity | -eentity Id--namespace | -nnode namespace expression--raw | -rEnable raw format output--helpShow the help message. |
storage vvol stats list | List all supported stats | --namespace | -nnode namespace expression--helpShow the help message. |
storage vvol stats remove | Remove tracked entity | --entity | -eentity Id (required)--namespace | -nentity namespace (required)--helpShow the help message. |
storage vvol stats reset | Reset stats for given namespace | --entity | -eentity Id--namespace | -nnode namespace (required)--helpShow the help message. |
storage vvol storagecontainer list | List VVol storage containers known to this host. | --helpShow the help message. |
storage vvol storagecontainer abandonedvvol scan | Scans the specified storage container for abandoned VVols. | --path | -pPath to VVol Storage Container to scan. (required)--helpShow the help message. |
storage vvol vasacontext get | Get the VVol VASA Context (vCenter UUID). | --helpShow the help message. |
storage vvol vasaprovider list | List the VASA Providers registered on this host. | --helpShow the help message. |
storage vvol vmstats get | Get the VVol information and statistics for a specific virtual machine. | --get-config-vvol | -cGet config VVol stats along with data VVols.--vm-name | -vDisplay name of the virtual machine. (required)--helpShow the help message. |
esxcli system Commands
| COMMAND | DESCRIPTION | OPTIONS HELP |
|---|---|---|
system account add | Create a new local user account. | --description | -dUser description, e.g. full name.--id | -iUser ID, e.g. “administrator”. (required)--password | -pUser password. (secret)--password-confirmation | -cPassword confirmation. Required if password is specified. (secret)--shell-access | -sWhether the user is allowed shell access if they have the appropriate administrator privileges. Default value is false for new users, unless overridden by host configuration settings.--helpShow the help message. |
system account list | List local user accounts. | --helpShow the help message. |
system account remove | Remove an existing local user account. | --id | -iID of user to be removed. (required)--helpShow the help message. |
system account set | Modify an existing local user account. | --description | -dUser description, e.g. full name.--id | -iUser ID, e.g. “administrator”. (required)--password | -pUser password. (secret)--password-confirmation | -cPassword confirmation. Required if password is specified. (secret)--shell-access | -sWhether the user is allowed shell access if they have the appropriate administrator privileges.--helpShow the help message. |
system auditrecords get | Audit record configuration settings. | --helpShow the help message. |
system auditrecords local disable | Disable audit record storage. | --helpShow the help message. |
system auditrecords local enable | Enable audit record storage. | --helpShow the help message. |
system auditrecords local set | Set audit record storage configuration options. | --directoryThe directory to use for audit record storage. If not specified, /scratch/auditLog is used. The directory must be within a persistent file system.--resetReset param value to default.--sizeThe audit record storage capacity (in MiB). If not specified, 4 is used.--helpShow the help message. |
system auditrecords remote disable | Disable transmitting audit records to remote hosts. | --helpShow the help message. |
system auditrecords remote enable | Enable transmitting audit records to remote hosts. | --helpShow the help message. |
system boot device get | Get the systems boot device. | --helpShow the help message. |
system clock get | Display the current system clock parameters. | --helpShow the help message. |
system clock set | Set system clock parameters. | --max-neg-phase | -nmax negative phase correction--max-phase-corrections | -mmax number of phase corrections--max-pos-phase | -pmax positive phase correction--helpShow the help message. |
system coredump file add | Create a VMkernel Dump VMFS file for this system. | --auto | -aAutomatically create a file if none found and autoCreateDumpFile kernel option is set.--datastore | -dManually specify the datastore the Dump File is created in. If not provided, a datastore of sufficient size will be automatically chosen.--enable | -eEnable diagnostic file after creation.--file | -fManually specify the file name of the created Dump File. If not provided, a unique name will be chosen.--size | -sManually set the size in MB of the created Dump File. If not provided, a default size for the current machine will be calculated.--helpShow the help message. |
system coredump file get | Get the dump file path. This command will print the path to the active and/or configured VMFS Dump File. | --helpShow the help message. |
system coredump file list | List the active and configured VMFS Diagnostic Files. | --helpShow the help message. |
system coredump file remove | Remove a VMkernel Dump VMFS file from this system. | --file | -fSpecify the file name of the Dump File to be removed. If not given, the configured dump file will be removed.--force | -FDeactivate and unconfigure the dump file being removed. This option is required if the file is active.--helpShow the help message. |
system coredump file set | Set the active and configured VMkernel Dump VMFS file for this system. | --enable | -eEnable or disable the VMkernel dump file. This option cannot be specified when unconfiguring the dump file.--path | -pThe path of the VMFS Dump File to use. This must be a pre-allocated file.--smart | -sThis flag can be used only with –enable=true. It will cause the file to be selected using the smart selection algorithm.--unconfigure | -uUnconfigure the current VMFS Dump file.--helpShow the help message. |
system coredump network check | Check the status of the configured network dump server | --helpShow the help message. |
system coredump network get | Get the currently configured parameters for network coredump, if enabled. | --helpShow the help message. |
system coredump network set | Set the parameters used for network core dump | --enable | -eEnable network dump. This option cannot be specified when setting the dump parameters below.--interface-name | -vAn active interface to be used for the network core dump. Required option when setting dump parameters.--server-ip | -jIP address of the core dump server (IPv4 or IPv6). Required when setting dump parameters.--server-ipv4 | -iIPv4 address of the core dump server.(deprecated, use -j|–server-ip instead)--server-port | -oPort on which the core dump server is listening. (Optional)--helpShow the help message. |
system coredump partition get | Get one of the dump partition configured values. This command will print either the active dump partition or the configured dump partition depending on the flags passed. | --helpShow the help message. |
system coredump partition list | List all of the partitions on the system that have a partition type matching the VMware Core partition type. Also indicate which partition, if any, is being used as the system’s dump partition and which is configured to be used at next boot. | --helpShow the help message. |
system coredump partition set | Set the specific VMkernel dump partition for this system. This will configure the dump partition for the next boot. This command will change the active dump partition to the partition specified. | --enable | -eEnable or disable the VMkernel dump partition. This option cannot be specified when setting or unconfiguring the dump partition.--partition | -pThe name of the partition to use. This should be a device name with a partition number at the end. Example: naa.xxxxx:1--smart | -sThis flag can be used only with –enable=true. It will cause the best available partition to be selected using the smart selection algorithm.--unconfigure | -uSet the dump partition into an unconfigured state. This will remove the current configured dump partition for the next boot. This will result in the smart activate algorithm being used at the next boot.--helpShow the help message. |
system health report get | Displays one or more health reports | --all-reportsRetrieve all the health reports. The default behavior is to retrieve only the latest health report.--filename | -fThe absolute path on the ESXi host where the health report(s) should be copied. If multiple reports are specified, they will be concatenated to this file.--report-names | -rSpecifies one or more health reports to display. The name(s) of the report can be obtained from the ‘esxcli system health report list’ command. (required)--helpShow the help message. |
system health report list | List all the health reports currently generated. | --helpShow the help message. |
system hostname get | Get the host, domain or fully qualified name of the ESX host. | --helpShow the help message. |
system hostname set | This command allows the user to set the hostname, domain name or fully qualified domain name of the ESX host. | --domain | -dThe domain name to set for the ESX host. This option is mutually exclusive with the –fqdn option.--fqdn | -fSet the fully qualified domain name of the ESX host.--host | -HThe 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.--helpShow the help message. |
system maintenanceMode get | Get the maintenance mode state of the system. | --helpShow the help message. |
system maintenanceMode set | Enable or disable the maintenance mode of the system. | --enable | -eMaintenance mode state. (required)--timeout | -tTimeout in seconds to wait for entering the new state. Zero (default) means no timeout. The host will enter maintenance mode when there are no running virtual machines on the host. The user is required to power off or evacuate them. This includes vSphere Cluster Service VMs which may be running on the host if it is part of a vSphere cluster. Exiting maintenance mode is done when there are no running mainenance operations.--vsanmode | -mAction the VSAN service must take before the host can enter maintenance mode (default ensureObjectAccessibility). Allowed values are:ensureObjectAccessibility: Evacuate data from the disk to ensure object accessibility in the vSAN cluster, before entering maintenance mode. evacuateAllData: Evacuate all data from the disk before entering maintenance mode. noAction: Do not move vSAN data out of the disk before entering maintenance mode. --helpShow the help message. |
system module get | Show information for a VMkernel module. | --module | -mThe name of the VMkernel module. (required)--helpShow the help message. |
system module list | List the VMkernel modules that the system knows about. | --enabled | -eList the enabled / disabled VMkernel modules and device drivers.--loaded | -lList the loaded / not loaded VMkernel modules and device drivers.--helpShow the help message. |
system module load | Load a VMkernel module with the given name if it is enabled. If the module is disabled then the use of –force is required to load the module. | --force | -fIgnore the enabled/disabled state of this module and force it to load.--module | -mThe name of the VMkernel module to load. (required)--helpShow the help message. |
system module set | Allow enabling and disabling of a VMkernel module. | --enabled | -eSet to true to enable the module, set to false to disable the module. (required)--force | -fSkip VMkernel module validity checks and set options for a module (or alias) with the given name.--module | -mThe name of the VMkernel module to set options for. (required)--helpShow the help message. |
system module parameters clear | Clear the load time parameters for a given VMkernel module. | --force | -fSkip VMkernel module validity checks and clear configuration anyway.--module | -mThe name of the VMkernel module to clear parameters for. (required)--helpShow the help message. |
system module parameters copy | Copy the load time parameters from one VMkernel module to another. | --force | -fSkip VMkernel module validity checks for the source VMkernel module.--parameter-keys | -pParameter key that should get copied. (required)--source | -sThe name of the source VMkernel module. (required)--target | -tThe name of the target VMkernel module. (required)--helpShow the help message. |
system module parameters list | List the parameters, a descriptions of each parameter supported for a given module name and the user defined value for each parameter. | --module | -mThe name of the VMkernel module to get the option string for. (required)--helpShow the help message. |
system module parameters set | Set the load time parameters for the given VMkernel module. | --append | -aAppend the specified parameter string to the currently configured parameter string for the VMkernel module. If –append is not specified, the parameter string currently configured for the VMkernel module will be replaced by the specified parameter string.--force | -fSkip VMkernel module validity checks and set parameters for a module (or alias) with the given name.--module | -mThe name of the VMkernel module to set parameters for. (required)--parameter-string | -pThe string containing the parameters for this module. (required)--helpShow the help message. |
system ntp get | Display Network Time Protocol configuration | --server-names | -sList server hostname only. Default is to list both hostname and any options.--helpShow the help message. |
system ntp set | Configures the ESX Network Time Protocol agent. | --enabled | -eStart or stop ntpd. Values: [yes|no, true|false, 0|1]--file | -fSpecify an absolute path to text file containing NTP configuration commands to load into ESXi NTP configuration.--loglevel | -lSyslog logging level:debug: Most detailed logging level. error: Least detailed logging, Reports only errors. info: Reports normal actions in addition to warnings, events. warning: Reports only warnings or errors. --reset | -rRestore the NTP configuration to factory defaults.--server | -sProvide one or more NTP servers as a fully qualified domain name or IP address.--helpShow the help message. |
system ntp test | Verify operational status of ESX NTP service. | --helpShow the help message. |
system ntp config get | Display Network Time Protocol configuration. | --helpShow the help message. |
system ntp stats get | Report operational state of Network Time Protocol Daemon | --helpShow the help message. |
system permission list | List permissions defined on the host. | --helpShow the help message. |
system permission set | Set permission for a user or group. | --group | -gSpecifies that the supplied ID refers to a group. ESXi local groups are not supported.--id | -iID of user or group. Domain users or groups should be specified as “DOMAIN\user_name” or “DOMAIN\group_name”. (required)--role | -rName of role that specifies user access rights.Admin: Full access rights NoAccess: Used for restricting granted access. E.g. to deny access for some user whose group already has access. ReadOnly: See details of objects, but not make changes (required) --helpShow the help message. |
system permission unset | Remove permission for a user or group. | --group | -gSpecifies that the supplied ID refers to a group.--id | -iID of user or group. (required)--helpShow the help message. |
system process list | List the VMkernel UserWorld processes currently on the host. | --helpShow the help message. |
system process stats load get | System load average over the last 1, 5 and 15 minutes. | --helpShow the help message. |
system process stats running get | Number of currently running processes. | --helpShow the help message. |
system ptp get | Display Precision Time Protocol configuration | --helpShow the help message. |
system ptp set | Configures the ESX Precision Time Protocol agent. | --device | -dName of network device to be used with PTP service.--device-type | -TType of network device to be used with PTP service: [vmknic, pcipassthru, none]--domainPTP domain number (0-255).--enabled | -eEnable or disable PTP agent. Values: [yes|no, true|false, 0|1]--fallback | -bAllow PTP on failure to fall back to NTP service (Non-revertive). Values: [yes|no, true|false, 0|1]--ipv4-address | -IStatic IPv4 address for the network device.--ipv4-netmask | -NStatic IPv4 netmask for the network device.--ipv4-type | -tType of IPv4 address for the network device: [dhcp, static, none]--loglevel | -lSyslog logging level: [debug, info, warning, error].--reset | -rRestore the PTP configuration to factory defaults.--restart | -RRestart PTP agent with current config.--helpShow the help message. |
system ptp test | Verify operational status of ESX PTP service. | --helpShow the help message. |
system ptp stats get | Report operational state of Precision Time Protocol Daemon | --helpShow the help message. |
system secpolicy domain list | List the enforcement level for each domain. | --helpShow the help message. |
system secpolicy domain set | Set the enforcement level for a domain in the system. Any option specified here is not persistent and will not survive a reboot of the system. | --all-domains | -aAll domains.--level | -lThe enforcement level. (required)--name | -nThe domain name.--helpShow the help message. |
system security certificatestore add | Add a new CA certificate to the CA certificate store. | --filename | -fAbsolute path to certificate file in PEM format, located on the ESXi host. (required)--helpShow the help message. |
system security certificatestore list | List all certificates in the CA certificate store. | --helpShow the help message. |
system security certificatestore remove | Remove a certificate from the CA certificate store. | --filename | -fAbsolute path to the file in PEM format, located on the ESXi host, describing the certificate to be removed.--issuer | -iIssuer name of the certificate to be removed. Also requires –serial.--serial | -sSerial number of the certificate to be removed. Also requires –issuer.--helpShow the help message. |
system security fips140 rhttpproxy get | Get FIPS140 mode of rhttpproxy. | --helpShow the help message. |
system security fips140 rhttpproxy set | Set FIPS140 mode of rhttpproxy. | --enable | -eEnable/disable FIPS140 mode for rhttpproxy. (required)--helpShow the help message. |
system security fips140 ssh get | Get FIPS140 mode of ssh. | --helpShow the help message. |
system security fips140 ssh set | Set FIPS140 mode of ssh. | --enable | -eEnable/disable FIPS140 mode for ssh. (required)--helpShow the help message. |
system security keypersistence disable | Disable key persistence daemon. | --remove-all-stored-keysConfirm deletion of all stored keys. This confirmation is required.--helpShow the help message. |
system security keypersistence enable | Enable key persistence daemon. | --helpShow the help message. |
system settings advanced add | Add a user defined advanced option to the /UserVars/ advanced option tree. | --description | -dDescription of the new option. (required)--hidden | -HWhether the option is hidden.--host-specific | -OThis indicates that the value of this option is always unique to a host.--impact | -IThis specifies the impact on the host when the value of the option is modified:maintenance-mode: This indicates that the host must be in maintenance mode before the option value is modified. reboot: This indicates that the host must be rebooted for the option value to take effect. --int-default | -iThe default value of the new option (integer option only, required).--max | -MThe maximum allowed value (integer option only, required).--min | -mThe minimum allowed value (integer option only, required).--option | -oThe name of the new option. Valid characters: letters, digits and underscore. (required)--string-default | -sThe default value of the new option (string option only). An empty string is assumed if not specified.--type | -tThe type of the new option. Supported values:integer: Advanced option with integer value. string: Advanced option with string value. (required) --helpShow the help message. |
system settings advanced list | List the advanced options available from the VMkernel. | --delta | -dOnly display options whose values differ from their default.--option | -oOnly get the information for a single VMkernel advanced option.--tree | -tLimit the list of advanced option to a specific sub tree.--helpShow the help message. |
system settings advanced remove | Remove a user defined advanced option from the /UserVars/ advanced option tree. | --option | -oThe name of the option to remove (without the /UserVars/ prefix as it is implied). (required)--helpShow the help message. |
system settings advanced set | Set the value of an advanced option. | --default | -dReset the option to its default value.--int-value | -iIf the option is an integer value use this option.--option | -oThe name of the option to set the value of. Example: “/Misc/HostName” (required)--string-value | -sIf the option is a string use this option.--helpShow the help message. |
system settings encryption get | Get the encryption mode and policy. | --helpShow the help message. |
system settings encryption set | Set the encryption mode and policy. | --mode | -mSet the encryption mode.--require-exec-installed-only | -eRequire executables to be loaded only from installed VIBs.--require-secure-boot | -sRequire secure boot.--helpShow the help message. |
system settings encryption recovery list | List recovery keys. | --helpShow the help message. |
system settings encryption recovery rotate | Rotate the recover key. | --keyid | -kThe ID of the new recovery key. If no value is specified, the system will generate a new key.--uuid | -uThe UUID of the recovery key to be rotated. (required)--helpShow the help message. |
system settings gueststore repository get | Get GuestStore repository. | --helpShow the help message. |
system settings gueststore repository set | Set or clear GuestStore repository. | --urlURL of a repository to set; to clear GuestStore repository, set –url “” (required)--helpShow the help message. |
system settings kernel list | List VMkernel kernel settings. | --delta | -dOnly display options whose values differ from their default.--option | -oThe name of the VMkernel kernel setting to get.--helpShow the help message. |
system settings kernel set | Set a VMKernel setting. | --setting | -sThe name of the VMKernel setting to set. (required)--value | -vThe value to set the setting to. (required)--helpShow the help message. |
system settings keyboard layout get | Get the keyboard layout | --helpShow the help message. |
system settings keyboard layout list | List the keyboard layout | --helpShow the help message. |
system settings keyboard layout set | Set the keyboard layout | --layout | -lThe name of the layout to set--no-persistOnly apply this layout for the current boot--helpShow the help message. |
system shutdown poweroff | Power off the system. The host must be in maintenance mode. | --delay | -dDelay interval in seconds--reason | -rReason for performing the operation (required)--helpShow the help message. |
system shutdown reboot | Reboot the system. The host must be in maintenance mode. | --delay | -dDelay interval in seconds--reason | -rReason for performing the operation (required)--helpShow the help message. |
system slp get | Get SLP Agent configuration. | --helpShow the help message. |
system slp search | Perform SLP search for neighboring services | --node | -nOptional, host FQDN or IP address to connect to. Use -P to control protocol used.--port | -pOptional, override the default port value 427.--protocol | -POptional, override unicast protocol: [tcp, udp], default tcp, requires -n.--service | -sOptional, the service name to search for. Defaults to ‘service-agent’.--helpShow the help message. |
system slp set | Configure ESX SLP agent. | --enable | -eStart or stop SLP service. Values: [yes|no, true|false, 0|1]. (required)--helpShow the help message. |
system slp stats get | Report operational state of Service Location Protocol Daemon | --helpShow the help message. |
system snmp get | Get SNMP Agent configuration | --helpShow the help message. |
system snmp hash | Generate localized hash values based on this agents snmp engine id. | --auth-hash | -ASecret to use when generating authentication hash. This should be a filename unless –raw-secret is specified. The authentication hash is used in the –users option of ‘esxcli system snmp set’ (required secret)--priv-hash | -XSecret to use when generating privacy hash. This should be a filename unless –raw-secret is specified. The privacy hash is used in the –users option of ‘esxcli system snmp set’. (secret)--raw-secret | -rMake –auth-hash and –priv-hash options read raw secret from command line instead of file.--helpShow the help message. |
system snmp set | This command allows the user to set up ESX SNMP agent. | --authentication | -aSet default authentication protocol. Supported values:SHA1: SHA1 auth protocol used for authentication. none: No authentication. reset: Resets the param value to default. --communities | -cSet up to ten communities each no more than 64 characters. Format is: community1[,community2,…] (this overwrites previous settings). Use value ‘reset’ to set the paramter value to default.--enable | -eStart or stop SNMP service. Values: [yes|no, true|false, 0|1].--engineid | -ESet SNMPv3 engine id. Must be at least 10 to 32 hexadecimal characters. 0x or 0X is stripped if found as well as colons (:)--hwsrc | -yWhere to source hardware events from, IPMI sensors or CIM Indications. One of:indications: source hardware events from CIM Indications. sensors: source hardware events from IPMI sensors. --largestorage | -sSupport 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 supportlarge storage with small allocation units, the agent re-calculates these values so they all fit Integer32 and hrStorageAllocationUnits * hrStorageSize gives real size of the storage. ( Note: hrStorageAllocationUnits will not be real allocation units if real hrStorageSize won’t fit into Integer32 ). Setting this directive to 0 turns off this calculation and the agent reports real hrStorageAllocationUnits, but it might report wrong hrStorageSize for large storage because the value won’t fit into Integer32.--loglevel | -lSystem Agent syslog logging level:debug: Most detailed logging level. error: Least detailed logging, Reports only errors. info: Reports normal actions in addition to warnings, events. warning: Reports only warnings or errors. --notraps | -nComma separated list of trap oids for traps not to be sent by agent. Use value ‘reset’ to set the paramter value to default.--port | -pSet UDP port to poll snmp agent on. The default is udp/161. May not use ports 32768 to 40959--privacy | -xSet default privacy protocol. Supported Values:AES128: AES128 priv protocol used for encryption. none: No encryption. reset: Resets the param value to default. --remote-users | -RSet up to five inform user ids. Format is: user/auth-proto/-|auth-hash/priv-proto/-|priv-hash/engine-id[,…] where user is 32 chars max. auth-proto is none|SHA1, priv-proto is none|AES. ‘-‘ indicates no hash. engine-id is hex string ‘0x0-9a-f’ up to 32 chars max. Use value ‘reset’ to set the paramter value to default.--reset | -rReturn agent configuration to factory defaults.--syscontact | -CSystem contact string as presented in sysContact.0. Up to 255 characters.--syslocation | -LSystem location string as presented in sysLocation.0. Up to 255 characters.--targets | -tSet 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) Use value ‘reset’ to set the paramter value to default.--users | -uSet 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). Use value ‘reset’ to set the paramter value to default.--v3targets | -iSet up to three SNMPv3 notification targets. Format is: ip-or-hostname[@port]/remote-user/security-level/trap|inform[,…]. Use value ‘reset’ to set the paramter value to default.--helpShow the help message. |
system snmp test | Verify ESX SNMP notifications can be delivered to target destinations. | --auth-hash | -AOptionally test authentication secret generates matching hash for user--priv-hash | -XOptionally test privacy secret generates matching hash for user--raw-secret | -rMake -A and -X flags read raw secret from command line instead of file.--user | -uValidate a given SNMPv3 user name exists--helpShow the help message. |
system stats installtime get | Display the date and time when this system was first installed. Value will not change on subsequent updates. | --helpShow the help message. |
system stats uptime get | Display the number of microseconds the system has been running. | --helpShow the help message. |
system syslog mark | Issue a message to all outputs. | --message | -sThe message to issue. (required)--helpShow the help message. |
system syslog reload | Reload the log daemon to apply any new configuration options. | --helpShow the help message. |
system syslog config get | Show the current global configuration values. | --helpShow the help message. |
system syslog config set | Set syslog daemon configuration options. | --check-ssl-certsVerify remote SSL certificates against the local CA Store.--crl-checkCheck the revocation status of all the certificates in an SSL certificate chain.--default-rotateNumber of older log files to keep.--default-sizeSize of each log file before switching to a new one (in KiB).--default-timeoutDelay before retrying to connect to a remote host after a connection attempt has failed (in seconds).--drop-log-rotateNumber of older dropped message log files to keep.--drop-log-sizeSize of each dropped message log file before switching to a new one (in KiB).--logdirThe directory to output local logs to.--logdir-uniquePlace logs in a unique subdirectory of logdir, based on hostname.--loghostComma (,) separated list of remote hosts to transmit messages to. Format is: proto://hostname|ipv4|'[‘ipv6’]'[:port][?formatter=value[&framing=value]]. Protocol must be one of (tcp|udp|ssl). If a port is not provided, ssl and tcp will use 1514; udp will use 514. Formatter must be one of (RFC_3164|RFC_5424). Framing must be one of (octet_counting|non_transparent). The default formatter is RFC 3164; the default framing is non_transparent.--log-level | -lSyslog daemon logging level. This should only be changed when troubleshooting an issue with the syslog daemon. Values may be ‘debug’ (most detailed level), ‘info’ (default detail level), ‘warning’ (only warnings or errors), or ‘error’ (only errors).--queue-drop-markMessage queue capacity after which messages are dropped (as a percentage).--remote-host-max-msg-lenMaximum remote host transmission length (in bytes) when using the TCP and TLS (SSL) protocols. Messages longer than this will truncated.--resetReset param value to default.--vsan-backingAllow the logging and audit record storage directories to be placed on a VSAN. WARNING! Enabling this parameter may cause ESXi to hang.--x509-strictStrict X.509 compliance when checking SSL certificates.--helpShow the help message. |
system syslog config logfilter add | Add a log filter. | --filter | -fThe filter to be added. Format is: numLogs | ident | logRegexp. ‘numLogs’ sets the maximum number of log entries for the specified log messages. After reaching this number, the specified log messages are filtered and ignored. ‘ident’ specifies one or more system components to apply the filter to the log messages that these components generate. ‘logRegexp’ specifies a case-sensitive phrase with Python regular expression syntax to filter the log messages by their content. (required)--helpShow the help message. |
system syslog config logfilter get | Show the current log filter configuration values. | --helpShow the help message. |
system syslog config logfilter list | Show the added log filters. | --helpShow the help message. |
system syslog config logfilter remove | Remove a log filter. | --filter | -fThe filter to be removed. (required)--helpShow the help message. |
system syslog config logfilter set | Set log filtering configuration options. | --log-filtering-enabledEnable or disable log filtering. (required)--helpShow the help message. |
system syslog config logger list | Show the currently configured sub-loggers. | --idShow information only for the specified logger.--helpShow the help message. |
system syslog config logger set | Set configuration options for a specific sub-logger. | --idThe ID of the logger to configure. (required)--resetReset param value to default.--rotateNumber of rotated logs to keep for a specific logger.--sizeSet size of logs before rotation for a specific logger, in KiB.--helpShow the help message. |
system time get | Display the current system time. | --helpShow the help message. |
system time set | Set the system clock time. Any missing parameters will default to the current time | --day | -dDay--hour | -HHour--min | -mMinute--month | -MMonth--sec | -sSecond--year | -yYear--helpShow the help message. |
system uuid get | Get the system UUID. | --helpShow the help message. |
system version get | Display the product name, version and build information. | --alternate | -aReport version of software image in alternate boot bank if any.--helpShow the help message. |
system visorfs get | Obtain status information on the memory filesystem as a whole. | --helpShow the help message. |
system visorfs ramdisk add | Add a new Visorfs RAM disk to the ESXi Host and mount it. | --max-size | -MMaximum size (max reservation in MiB) (required)--min-size | -mMinimum size (min reservation in MiB) (required)--name | -nName for the ramdisk (required)--permissions | -pPermissions for the root of the ramdisk (mode) (required)--target | -tMountpoint for the ramdisk (absolute path) (required)--helpShow the help message. |
system visorfs ramdisk list | List the RAM disks used by the host. | --helpShow the help message. |
system visorfs ramdisk remove | Remove a Visorfs RAM disk from the ESXi Host. | --target | -tMountpoint for the ramdisk (absolute path) (required)--helpShow the help message. |
system visorfs tardisk list | List the tardisks used by the host. | --helpShow the help message. |
system wbem get | Display WBEM Agent configuration. | --helpShow the help message. |
system wbem set | This command allows the user to set up ESX CIMOM agent. | --auth | -aSpecify how to authorize incoming requests. Values are password, certificate, password is by default. Changes take effect when –enable is specified.--enable | -eStart or stop the WBEM services (sfcbd, openwsmand). Values: [yes|no, true|false, 0|1].--enable-https | -HEnable or disable https connection to sfcbd. Values: [yes|no, true|false, 0|1].--http-max-content-length | -MMaximum allowed length in bytes of http requests. Default is 1048576.--http-procsMaximum number of simultaneous HTTP client connections before blocking new incoming HTTP requests. Default is 2.--https-procsMaximum number of simultaneous HTTPS client connections before blocking new incoming HTTPS requests. Default is 4.--keepalive-max-request | -kSpecify the maximum number of consecutive requests on one connection. Setting it to 0 will effectively disable HTTP keep-alive. Default is 10.--keepalive-timeout | -KSpecify the maximum time in seconds an sfcb HTTP process will wait between two requests on one connection before terminating. Setting it to 0 will disable HTTP keep-alive. Default is 1.--loglevel | -lSyslog logging level: debug|info|warning|error.--max-msg-len | -mMaximum allowed length in bytes of wbem messages. Default is 40000000.--port | -pSet the TCP port on which the CIMOM listens for requests. The default is 5989.--protocols | -PEnable or disable SSL protocols. To reset to factory defaults specify ‘reset’ which allows only TLS 1.2 unless system defaults have been changed.Values can be one of: [tlsv1, tlsv1.1, reset] and setting protocols here overrules system defaults. Multiple protocols can be provided using format -P protocol1 -P protocol2. Command takes effect immediately.--provider-sample-interval | -iThe interval in seconds at which the provider manager is checking for idle providers. Default is 30.--provider-timeout-interval | -IThe interval in seconds before an idle provider gets unloaded by the provider manager. Default is 120.--prov-procsMaximum number of simultaneous provider processes. After this point if a new incoming request requires loading a new provider, then one of the existing providers will first be automatically unloaded. Default is 16.--readonly | -RSet readonly mode. Default is false.--reset | -rRestore the WBEM configuration to factory defaults.--rp-override | -oThis overrides the configured resource pool size of a provider.--shutdown-interval | -sThis param is no longer configurable from the CLI and can only be configured by providers.--ssl-cipher-list | -SThe cipher list consists of one or more cipher strings separated by ‘:’. Default is ECDHE+AESGCM:ECDHE+AES.--thread-pool-size | -tNumber of threads in the sfcb thread pool. Default is 5.--thread-stack-size | -TMinimum stack size allocated to sfcb threads. Default is 1048576.--ws-man | -WEnable or disable the WS-Management service (openwsmand). Enabled by default. Changes take effect when –enable is specified.--helpShow the help message. |
system wbem provider list | Display WBEM provider configuration. | --helpShow the help message. |
system wbem provider set | This command is used to manage ESX CIMOM providers. | --enable | -eEnable or disable the provider immediately. Values: [yes|no, true|false, 0|1]--name | -nSpecify provider identifier. (required)--helpShow the help message. |
system welcomemsg get | Get the Welcome Message for DCUI. | --helpShow the help message. |
system welcomemsg set | Set the welcome message string. | --message | -mThe welcome message in the initial screen of the Direct Console User Interface (DCUI) and Host Client. (required)--helpShow the help message. |
esxcli vm Commands
| COMMAND | DESCRIPTION | OPTIONS HELP |
|---|---|---|
vm appinfo get | Get the state of appinfo component on the ESXi host. | --helpShow the help message. |
vm appinfo set | Modify the appinfo component on the ESXi host. | --enabled | -eEnable or Disable the appinfo component on the ESXi host. (required)--helpShow the help message. |
vm process kill | Used to forcibly kill Virtual Machines that are stuck and not responding to normal stop operations. | --type | -tThe type of kill operation to attempt. There are three types of VM kills that can be attempted: [soft, hard, force]. Users should always attempt ‘soft’ kills first, which will give the VMX process a chance to shutdown cleanly (like kill or kill -SIGTERM). If that does not work move to ‘hard’ kills which will shutdown the process immediately (like kill -9 or kill -SIGKILL). ‘force’ should be used as a last resort attempt to kill the VM. If all three fail then a reboot is required. (required)--world-id | -wThe World ID of the Virtual Machine to kill. This can be obtained from the ‘vm process list’ command (required)--helpShow the help message. |
vm process list | List the virtual machines on this system. This command currently will only list running VMs on the system. | --helpShow the help message. |
esxcli vsan Commands
| COMMAND | DESCRIPTION | OPTIONS HELP |
|---|---|---|
vsan cluster get | Get information about the vSAN cluster that this host is joined to. | --cluster-uuid | -uSpecify the vSAN cluster UUID of the cluster instance which will be displayed, in the form “nnnnnnnn-nnnn-nnnn-nnnn-nnnnnnnnnnnn” where n are hexadecimal digits.--helpShow the help message. |
vsan cluster join | Join the host to a vSAN cluster. | --client-mode | -cJoin vSAN client cluster with given UUID, in the form “nnnnnnnn-nnnn-nnnn-nnnn-nnnnnnnnnnnn” where n are hexadecimal digits.--cluster-uuid | -uvSAN cluster UUID of the cluster instance which the host will join, or create, in the form “nnnnnnnn-nnnn-nnnn-nnnn-nnnnnnnnnnnn” where n are hexadecimal digits. (required)--metadata-node | -mJoin the host as a metadata node to the cluster.--vsanesa | -xvSAN ESA mode allows to create a vSAN ESA cluster.--wait | -wWait until the host joins the cluster.--witness-node | -tJoin the host as a witness node to the cluster. It is required to specify “–witness-preferred-fault-domain” when this parameter is set.--witness-preferred-fault-domain | -pSpecify the fault domain that witness node prefers to respond in case of network partition. It should be either of the two fault domains for existing data sites. This parameter is useful only when “–witness-node” is set.--helpShow the help message. |
vsan cluster leave | Leave the vSAN cluster the host is currently joined to. | --cluster-uuid | -uvSAN cluster UUID of the cluster instance which the host will leave, in the form “nnnnnnnn-nnnn-nnnn-nnnn-nnnnnnnnnnnn” where n are hexadecimal digits. This host will leave all associated vSAN clusters if the host is working as a shared witness host and this parameter is not specified.--helpShow the help message. |
vsan cluster list | Get information about the vSAN clusters that this host is joined to. | --helpShow the help message. |
vsan cluster new | Create a vSAN cluster with current host joined. A random sub-cluster UUID will be generated. | --client-mode | -cvSAN client mode allows mount of vSAN datastore from the server cluster without enabling vSAN.--vsanesa | -xvSAN ESA mode allows to create a vSAN ESA cluster.--helpShow the help message. |
vsan cluster restore | Restore the persisted vSAN cluster configuration. | --helpShow the help message. |
vsan cluster preferredfaultdomain get | Get the preferred fault domain for a stretched cluster. | --cluster-uuid | -uSpecify the vSAN cluster UUID of the cluster instance, and thepreferred fault domain info of target cluster will be displayed, in the form “nnnnnnnn-nnnn-nnnn-nnnn-nnnnnnnnnnnn” where n are hexadecimal digits.--helpShow the help message. |
vsan cluster preferredfaultdomain list | List the preferred fault domain for all attached stretched clusters. | --helpShow the help message. |
vsan cluster preferredfaultdomain set | Set the preferred fault domain for a stretched cluster. | --cluster-uuid | -uvSAN cluster UUID of the cluster instance, in the form “nnnnnnnn-nnnn-nnnn-nnnn-nnnnnnnnnnnn” where n are hexadecimal digits. This field is required if this host is working as a shared witness host.--preferred-fault-domain-name | -nPreferred Fault domain name to use for a stretched cluster. (required)--helpShow the help message. |
vsan cluster unicastagent add | Add a unicast agent to the vSAN cluster configuration. | --addr | -aIP address of the unicast agent. (required)--bound-interface-name | -iName of the bound outgoing network interface.--cert-thumbprint | -TSHA-1 certificate thumbprint. Cert-thumbprint would be required to enable vSAN data-in-transit encryption.--cluster-uuid | -cCluster UUID of the remote server unicast agent (required for -t remote). Or cluster UUID for host to be added on a shared witness node.--port | -pPort the unicast agent is listening on.--supports-unicast | -UWhether the software version supports unicast (required for -t node)--type | -tType of the unicast agent (One of [witness, node, metadata, remote], default is witness).--uuid | -uUUID of the unicast agent (required for -t node).--helpShow the help message. |
vsan cluster unicastagent clear | Removes all unicast agents in the vSAN cluster configuration. | --helpShow the help message. |
vsan cluster unicastagent list | List all unicast agents in the vSAN cluster configuration. | --helpShow the help message. |
vsan cluster unicastagent remove | Remove a unicast agent from the vSAN cluster configuration. | --addr | -aIP address of the unicast agent. (required)--cluster-uuid | -cCluster UUID of the unicast agent.--port | -pPort the unicast agent is listening on.--type | -tType of the unicast agent (One of [node, witness, metadata, remote], default is node).--uuid | -uUUID of the unicast agent.--helpShow the help message. |
vsan cmmds timemachine get | Get vSAN CMMDS time machine configuration. | --helpShow the help message. |
vsan cmmds timemachine set | Configure vSAN CMMDS time machine. | --mb-per-day | -mSpecify MB per day for vSAN CMMDS time machine.--rotate | -rSpecify log file rotation for cmmdsTimeMachineDump.--size | -sSpecify log file size in KB for cmmdsTimeMachineDump.--helpShow the help message. |
vsan datastore add | Add a new datastore to the vSAN cluster. This operation may be used to add either a new local datastore or a remote datastore. Adding local datastore is only allowed if vSAN is enabled on the host. In general, add should be done at cluster level. Across a vSAN cluster vSAN datastores should be in sync. | --cluster-uuid | -cCluster UUID of the vSAN cluster which exports the vSAN datastore to mount. This should be specified only when adding a remote vSAN datastore and datastore UUID must be specified together with this field.--name | -nUser friendly name of the datastore to be added. It must be unique among all existing vSAN datastores. (required)--uuid | -uUUID of the new datastore to be added, in the form “nnnnnnnn-nnnn-nnnn-nnnn-nnnnnnnnnnnn” where n are hexadecimal digits.. If not specified, a new UUID will be generated. For remote vSAN datastore, both datastore and server cluster UUID are required. The datastore UUID must match one of the datastores in the remote server cluster.--helpShow the help message. |
vsan datastore clear | Remove all but the default datastore from the vSAN cluster. This operation is only allowed if vSAN is enabled on the host. In general, clear should be done at cluster level. Across a vSAN cluster vSAN datastores should be in sync. | --helpShow the help message. |
vsan datastore list | List datastores in the vSAN cluster. | --helpShow the help message. |
vsan datastore remove | Remove a datastore from the vSAN cluster. This operation is only allowed if vSAN is enabled on the host. In general, remove should be done at cluster level. Across a vSAN cluster vSAN datastores should be in sync. | --uuid | -uUUID of the datastore to be removed, in the form “nnnnnnnn-nnnn-nnnn-nnnn-nnnnnnnnnnnn” where n are hexadecimal digits. (required)--helpShow the help message. |
vsan datastore name get | Get vSAN datastore name. | --uuid | -uUUID of the datastore, in the form “nnnnnnnn-nnnn-nnnn-nnnn-nnnnnnnnnnnn” where n are hexadecimal digits. If not specified, the default datastore is assumed.--helpShow the help message. |
vsan datastore name set | Configure vSAN datastore name. In general, rename should always be done at cluster level. Across a vSAN cluster vSAN datastore name should be in sync. | --newname | -nNew name of the datastore. (required)--uuid | -uUUID of the datastore, in the form “nnnnnnnn-nnnn-nnnn-nnnn-nnnnnnnnnnnn” where n are hexadecimal digits. If not specified, the default datastore is assumed.--helpShow the help message. |
vsan debug advcfg list | List all advanced configuration options with non-default values. | --option | -oList only the specified options, even if their value is default. Usage example: –option=’VSAN.ClomRepairDelay’ –option=’LSOM.ssdWbSize’…--helpShow the help message. |
vsan debug controller list | Print detailed information about all vSAN disk controllers (output may change between releases) | --used-by-vsan | -vFilter the controllers used by vSAN or not--helpShow the help message. |
vsan debug disk list | Print detailed information about all vSAN disks in the cluster. | --guuid | -gFilter disks by disk group UUID.--local | -lShow only local disks.--uuid | -uFilter disks by disk UUID.--helpShow the help message. |
vsan debug disk overview | Print overview information about all vSAN disks in the cluster. | --local | -lShow only local disks.--helpShow the help message. |
vsan debug disk summary get | Print summary information about all vSAN disks in the cluster. | --local | -lCheck only local disks.--helpShow the help message. |
vsan debug evacuation precheck | Examine what it takes if an entity (disk group or host) is evacuated in various modes (Action). The result is accurate when all hosts in the vSAN cluster are of the same version and have the same disk format. | --action | -aAction filter. Only show a specific type of actions fromensureAccess: Ensure Accessibility evacAllData: Evacuate All Data noAction: No Action . --entity | -eThe name or uuid of the disk or disk group or host node. For name, it accepts ‘localhost’ or a hostname in vSAN cluster, or a device name in a diskgroup such as ‘mpx.vmhba1:C0:T1:L0’. (required)--verbose | -vShow full list of inaccessible and non-compliant (redundancy reduced) objects.--helpShow the help message. |
vsan debug limit get | Print summary information about vSAN limits (output may change between releases) | --helpShow the help message. |
vsan debug memory list | Print both userworld and kernel memory consumptions of vSAN. | --helpShow the help message. |
vsan debug mob start | Start vSAN Managed Object Browser Service. | --helpShow the help message. |
vsan debug mob status | Query vSAN Managed Object Browser Service is running or not. | --helpShow the help message. |
vsan debug mob stop | Stop vSAN Managed Object Browser Service. | --helpShow the help message. |
vsan debug object list | Print detailed information about vSAN objects in the cluster. This command would only show 100 objects at most by default. | --allIf given, query all the objects in the cluster. Please make sure the host has enough resources to run.--comp-ownerFilter objects by component owner.--disk-uuidFilter objects by disk UUID.--guuid | -gFilter objects by group UUID.--healthFilter objects by object health.--max-numberSpecify the maximum number of objects to query. Note: querying large number of objects can be very resource consuming.--policyFilter objects by disk policy. Usage example: –policy=’CSN:1′ –policy=’SCSN:1’…--sort | -aSort By. Sort the output byhealth: Object Health policy: Policy size: Size used: Used used 4k blocks: Used 4K Blocks --uuid | -uFilter objects by object UUID.--vm-nameFilter objects by VM name.--helpShow the help message. |
vsan debug object overview | Print overview information about all vSAN objects in the cluster. This command would only show 100 objects at most by default. | --allIf given, query all the objects in the cluster. (Please make sure the host has enough resource to run.)--max-numberSpecify the max number of object query. (Note: Query large number of objects can be very resource consuming.)--helpShow the help message. |
vsan debug object health summary get | Print health summary information about all vSAN objects in the cluster (output may change between releases) | --helpShow the help message. |
vsan debug resync list | Print detailed information about vSAN resyncing objects (output may change between releases) | --helpShow the help message. |
vsan debug resync summary get | Print summary information about vSAN resyncing objects (output may change between releases) | --helpShow the help message. |
vsan debug vmdk list | Print summary information about VMDKs on local vSAN datastore (output may change between releases) | --helpShow the help message. |
vsan encryption cert get | Get encryption KMS server certificate contents. | --helpShow the help message. |
vsan encryption cert path list | List encryption certificate file paths. | --helpShow the help message. |
vsan encryption hostkey get | Get host key from keycache used for vSAN encryption. | --helpShow the help message. |
vsan encryption info get | Get vSAN encryption infomation. | --helpShow the help message. |
vsan encryption kms list | List the KMS configurations used for vSAN encryption. | --helpShow the help message. |
vsan faultdomain get | Get the fault domain name for this host. | --helpShow the help message. |
vsan faultdomain reset | Reset Host fault domain to default value | --helpShow the help message. |
vsan faultdomain set | Set the fault domain for this host | --fdname | -nFault domain name to use for this host. Empty string means reset to default. (required)--helpShow the help message. |
vsan hardware vcg add | Map unidentified vSAN hardware device with VCG ID. | --device-id | -dUnidentified Device ID. It can be seen with command “esxcli storage core device list” (e.g. nqn.2014-08.org.nvmexpress_8086_Dell_Express_Flash_NVMe_P4610_1.6TB_SFF_BTLN9443030C1P6AGN). (required)--vcg-id | -vVCG ID. (required)--helpShow the help message. |
vsan hardware vcg get | Get the vSAN VCG ID for a vSAN hardware device. Output is VCG ID while “N/A” means device ID is not mapped. | --device-id | -dUnidentified Device ID. It can be seen command “esxcli storage core device list” (e.g. nqn.2014-08.org.nvmexpress_8086_Dell_Express_Flash_NVMe_P4610_1.6TB_SFF_BTLN9443030C1P6AGN). (required)--helpShow the help message. |
vsan health cluster get | Get a specific health check status and its details | --test | -tTest full name prefix or short test id of the health check. The test full names are shown in health UI and can be listed with ‘esxcli vsan health cluster list’ (Note: use the TEST NAME, not GROUP NAME). If the prefix matchs more than one test, all the matched tests will be displayed. The short test ids can be seen with ‘esxcli vsan health cluster list -w’. (required)--helpShow the help message. |
vsan health cluster list | List a cluster wide health check across all types of health checks | --with-test-id | -wSpecify output list include testId (testId can be used to get the details of a test)--helpShow the help message. |
vsan iscsi defaultconfig get | Get default values for vSAN iSCSI Target configurations. | --helpShow the help message. |
vsan iscsi defaultconfig set | Set default values for vSAN iSCSI Target configurations. | --authtype | -mProvide default authentication type. Supported authentication types are [No-Authentication, CHAP, CHAP-Mutual].--interface | -nThe name of the default network interface through which the target is accessible.--mutual-secret | -SThe secret an initiator uses to authenticate a target. Required if authentication type is CHAP-Mutual. (secret)--mutual-userid | -UThe user name an initiator uses to authenticate a target. Required if authentication type is CHAP-Mutual. (secret)--port | -pThe default network port number through which the target will be accessible.--secret | -sThe secret a target uses to authenticate an initiator. Required if authentication type is CHAP or CHAP-Mutual. (secret)--userid | -uThe user name a target uses to authenticate an initiator. Required if authentication type is CHAP or CHAP-Mutual. (secret)--helpShow the help message. |
vsan iscsi homeobject create | Create vSAN iSCSI target home object. Once created, the home object will be available for all the hosts in vSAN cluster. vSAN iSCSI target home object should be created only once for the vSAN cluster. | --authtype | -mProvide default authentication type. Supported authentication types are [No-Authentication, CHAP, CHAP-Mutual].--interface | -nThe name of the default network interface. (required)--mutual-secret | -SThe secret an initiator uses to authenticate a target. Required if authentication type is CHAP-Mutual. (secret)--mutual-userid | -UThe user name an initiator uses to authenticate a target. Required if authentication type is CHAP-Mutual. (secret)--policy | -PvSAN storage policy for vSAN iSCSI target home object, in the form of a string. Please check ‘esxcli vsan policy setdefault –help’ for details on policy options.--port | -pThe port number of the default network port. If not provided, default network port: 3260.--secret | -sThe secret a target uses to authenticate an initiator. Required if authentication type is CHAP or CHAP-Mutual. (secret)--userid | -uThe user name a target uses to authenticate an initiator. Required if authentication type is CHAP or CHAP-Mutual. (secret)--helpShow the help message. |
vsan iscsi homeobject delete | Delete vSAN iSCSI target home object. This operation will destroy all vSAN iSCSI target configuration | --helpShow the help message. |
vsan iscsi homeobject get | Get status for the vSAN iSCSI target home object | --helpShow the help message. |
vsan iscsi homeobject set | Update configuration for the vSAN iSCSI target home object | --policy | -PNew vSAN storage policy for vSAN iSCSI target home object, in the form of a string. Please check ‘esxcli vsan policy setdefault –help’ for details on policy options.--helpShow the help message. |
vsan iscsi initiatorgroup add | Add a new initiator group. An initiator group is a collection of iSCSI initiator hosts. A LUN can be exposed to multiple initiators via initiator group. | --name | -nThe name of the new initiator group. Group name must be unique within the vSAN cluster. (required)--helpShow the help message. |
vsan iscsi initiatorgroup get | Get initiator group properties. | --name | -nInitiator group name. (required)--helpShow the help message. |
vsan iscsi initiatorgroup list | Get the list of initiator groups. | --helpShow the help message. |
vsan iscsi initiatorgroup remove | Remove an initiator group. Group should be empty. If you want to remove non-empty group use –force option. | --force | -fForce deletion of the initiator group even if it is not empty.--name | -nThe name of the initiator group to remove. (required)--helpShow the help message. |
vsan iscsi initiatorgroup initiator add | Add new initiator iSCSI names to the vSAN iSCSI initiator group. | --group | -gThe name of the initiator group. (required)--names | -nSpecify initiator iSCSI names to be added to the initiator group. Multiple initiator iSCSI names can be provided using format -n initiator1 -n initiator2. (required)--helpShow the help message. |
vsan iscsi initiatorgroup initiator remove | Remove initiator iSCSI names from the vSAN iSCSI initiator group. | --group | -gThe name of the initiator group. (required)--names | -nSpecify initiator iSCSI names to be removed from the initiator group. Multiple initiator iSCSI names can be provided using format -n initiator1 -n initiator2.the initiator group. (required)--helpShow the help message. |
vsan iscsi status get | Gets current status (Enabled or Disabled). | --helpShow the help message. |
vsan iscsi status set | Enable or disable iSCSI target support, query status | --enabledSets status, enabling or disabling vSAN iSCSI target support on the way. The new status survives a reboot (required)--helpShow the help message. |
vsan iscsi target add | Add a new vSAN iSCSI target. | --alias | -aThe alias of the target. The alias has to be unique. (required)--authtype | -mProvide authentication type for target. If not provided, target can be accessed through without authentication. Supported authentication types are [No-Authentication, CHAP, CHAP-Mutual].--initiator-add | -ASpecify initiator iSCSI names or initiator groups to be added to the list of initiators that can access this target. Multiple initiator iSCSI names and initiator groups can be added using format -A initiator1 -A initiator2.--interface | -nThe name of the network interface through which the target is accessible. If not provided, the target will be accessible through default network interface.--iqn | -iThe iSCSI Qualified Name (IQN) of the target. This parameter is optional and should be unique if provided. If not provided, appropriate IQN will be generated by the system.--location | -LSpecify target affinity location to a given fault domain in stretched cluster mode, and the option is {Preferred, NonPreferred} using format -L Preferred or -L NonPreferred.--mutual-secret | -SThe secret an initiator uses to authenticate a target. Required if authentication type is CHAP-Mutual. (secret)--mutual-userid | -UThe user name an initiator uses to authenticate a target. Required if authentication type is CHAP-Mutual. (secret)--policy | -PvSAN storage policy for target namespace, in the form of a string. Please check ‘esxcli vsan policy setdefault –help’ for details on policy options.--port | -pThe name of the network port through which the target is accessible. If not provided, the target will be accessible through default network port: 3260.--secret | -sThe secret a target uses to authenticate an initiator. Required if authentication type is CHAP or CHAP-Mutual. (secret)--userid | -uThe user name a target uses to authenticate an initiator. Required if authentication type is CHAP or CHAP-Mutual. (secret)--helpShow the help message. |
vsan iscsi target get | Get configuration for vSAN iSCSI target | --alias | -aThe iSCSI Target alias. (required)--helpShow the help message. |
vsan iscsi target list | List vSAN iSCSI targets. | --helpShow the help message. |
vsan iscsi target remove | Remove a vSAN iSCSI target. | --alias | -aThe alias of the vSAN iSCSI target to be removed. (required)--helpShow the help message. |
vsan iscsi target set | Update configuration of the given iSCSI target. | --alias | -aThe alias of the target which needs to be modified. (required)--authtype | -mProvides authentication type for the target. Supported authentication types are [No-Authentication, CHAP, CHAP-Mutual]--initiator-add | -ASpecify initiator iSCSI names or initiator groups to be added to the list of initiators that can access this target. Multiple initiator iSCSI names and initiator groups can be added using format -A initiator1 -A initiator2.--initiator-remove | -RSpecify initiator iSCSI names or initiator groups to be removed from the list of initiators that can access this target. Multiple initiator iSCSI names and initiator groups can be added using format -R initiator1 -R initiator2.--interface | -nThe name of the new network interface through which the target is accessible.--location | -LSpecify target affinity location with a given fault domain in stretched cluster mode, and the option is {Preferred, NonPreferred, Default}.--mutual-secret | -SThe secret an initiator uses to authenticate a target. Required if authentication type is CHAP-Mutual. (secret)--mutual-userid | -UThe user name an initiator uses to authenticate a target. Required if authentication type is CHAP-Mutual. (secret)--new-alias | -NThe new alias of the target.--policy | -PNew vSAN storage policy for target namespace, in the form of a string. Please check ‘esxcli vsan policy setdefault –help’ for details on policy options.--port | -pThe port number of the network port through which the target is accessible--secret | -sThe secret a target uses to authenticate an initiator. Required if authentication type is CHAP or CHAP-Mutual. (secret)--userid | -uThe user name a target uses to authenticate an initiator. Required if authentication type is CHAP or CHAP-Mutual. (secret)--helpShow the help message. |
vsan iscsi target lun add | Add a new vSAN iSCSI LUN to specified target | --alias | -aAn optional alias for LUN. Can be used to indicate additional info about the LUN.--id | -iThe optional ID of the LUN [0..255]. If not provided, next free identifier will be used. If provided, ID must be unique within target.--policy | -PvSAN storage policy for LUN, in the form of a string. Please check ‘esxcli vsan policy setdefault –help’ for more detail on policy options.--size | -sSize of the LUN object. Eg: 5GB. Supported units: MB, GB, TB, MiB, GiB, TiB. (required)--target | -tName of the vSAN iSCSI target to which the LUN will be added. (required)--helpShow the help message. |
vsan iscsi target lun get | Get configuration for vSAN iSCSI LUN | --id | -iThe ID for the LUN. (required)--target | -tThe iSCSI Target alias. (required)--helpShow the help message. |
vsan iscsi target lun list | List vSAN iSCSI LUNs in specified target. | --target | -tThe alias of the vSAN iSCSI target whose LUNs should be listed. (required)--helpShow the help message. |
vsan iscsi target lun remove | Remove a vSAN iSCSI LUN from specified target. | --force | -fClean the LUN from config file forcibly regardless whether successfully deleting the backing vSAN object. Orphan objects might be left due to this option.--id | -iIdentifier of the LUN to be removed. (required)--target | -tName of the vSAN iSCSI target from which the LUN will be removed. (required)--helpShow the help message. |
vsan iscsi target lun set | Update configuration for given vSAN iSCSI target LUN. | --alias | -aThe new alias for the LUN. Can be used to indicate additional info about the LUN.--id | -iThe ID of the LUN. (required)--new-id | -nThe new ID of the LUN [0..255]. If provided, ID must be unique within this target.--new-target | -TNew target name that the LUN moved to. LUN ID might be changed after moved to the new target.--policy | -PNew policy for LUN, in the form of a string. Please check ‘esxcli vsan policy setdefault –help’ for more detail on policy options.--size | -sThe new size of the LUN object with optional units. If provided, it should be greater than existing size i.e. LUNs are only allowed to grow. Supported unit types are MB, MiB, GB, GiB and TB, TiB (case-insensitive). If not specified, default unit is MiB.--status | -SChange the LUN status to [online, offline].offline: Bring the LUN offline. Offline LUNs are inaccessible. It’s allowed to do backup and some disruptive management operations like changing LUN ID when a LUN is offline. online: Bring the LUN online. Online LUNs are accessible. --target | -tAlias of the vSAN iSCSI target for which the LUN needs to be updated. (required)--helpShow the help message. |
vsan maintenancemode cancel | Cancel an in-progress vSAN maintenance mode operation.The command is not used for exit host maintenance mode. Please run esxcli system maintenanceMode set -e 0 to exit host maintenance mode | --helpShow the help message. |
vsan network clear | Clear the vSAN network configuration. | --helpShow the help message. |
vsan network list | List the network configuration currently in use by vSAN. | --helpShow the help message. |
vsan network remove | Remove an interface from the vSAN network configuration. | --force | -fNotify vSAN subsystem of removal, even if not configured.--interface-name | -iInterface name. (required)--helpShow the help message. |
vsan network restore | Restore the persisted vSAN network configuration. | --helpShow the help message. |
vsan network ip add | Add an IP interface to the vSAN network configuration. | --agent-mc-addr | -dIPv4 multicast address for agent (also called downstream) group.--agent-mc-port | -pMulticast address port for agent (also called downstream) group.--agent-v6-mc-addr | -DIPv6 multicast address for agent (also called downstream) group.--host-uc-port | -cUnicast address port for host unicast channel.--interface-name | -iInterface name. (required)--master-mc-addr | -uIPv4 multicast address for master (also called upstream) group.--master-mc-port | -oMulticast address port for master (also called upstream) group.--master-v6-mc-addr | -UIPv6 multicast address for master (also called upstream) group.--multicast-ttl | -tTime-to-live for multicast packets.--traffic-type | -TNetwork transmission type of vSAN traffic through a virtual network adapter.Supported values are vsan, witness. Type vsan means general vSAN transmission, which is used for both data and witness transmission, if there is no virtual adapter configured with witness traffic type; Type witness indicates that, vSAN vmknic is used for vSAN witness transmission. Once a virtual adapter is configured with witness traffic type, vSAN witness data transmission will stop using virtual adpater with vsan traffic type, and use first dicovered virtual adapter with witness traffic type. Multiple traffic types can be provided in format -T type1 -T type2. Default value is vsan, if this option is not specified.--helpShow the help message. |
vsan network ip remove | Remove an IP interface from the vSAN network configuration. | --force | -fNotify vSAN subsystem of removal, even if not configured.--interface-name | -iInterface name. (required)--helpShow the help message. |
vsan network ip set | Reconfigure an IP interface in the vSAN network configuration. | --agent-mc-addr | -dIPv4 multicast address for agent (also called downstream) group.--agent-mc-port | -pMulticast address port for agent (also called downstream) group.--agent-v6-mc-addr | -DIPv6 multicast address for agent (also called downstream) group.--host-uc-port | -cUnicast address port for host unicast channel.--interface-name | -iInterface name. (required)--master-mc-addr | -uIPv4 multicast address for master (also called upstream) group.--master-mc-port | -oMulticast address port for master (also called upstream) group.--master-v6-mc-addr | -UIPv6 multicast address for master (also called upstream) group.--multicast-ttl | -tTime-to-live for multicast packets.--traffic-type | -TNetwork transmission type of vSAN traffic through a virtual network adapter.Supported values are vsan, witness. Type vsan means general vSAN transmission, which is used for both data and witness transmission, if there is no virtual adapter configured with witness traffic type; Type witness indicates that, vSAN vmknic is used for vSAN witness transmission. Once a virtual adapter is configured with witness traffic type, vSAN witness data transmission will stop using virtual adpater with vsan traffic type, and use first dicovered virtual adapter with witness traffic type. Multiple traffic types can be provided in format -T type1 -T type2. Default value is vsan, if this option is not specified.--helpShow the help message. |
vsan network ipv4 add | Add an IP interface to the vSAN network configuration. | --agent-mc-addr | -dIPv4 multicast address for agent (also called downstream) group.--agent-mc-port | -pMulticast address port for agent (also called downstream) group.--agent-v6-mc-addr | -DIPv6 multicast address for agent (also called downstream) group.--host-uc-port | -cUnicast address port for host unicast channel.--interface-name | -iInterface name. (required)--master-mc-addr | -uIPv4 multicast address for master (also called upstream) group.--master-mc-port | -oMulticast address port for master (also called upstream) group.--master-v6-mc-addr | -UIPv6 multicast address for master (also called upstream) group.--multicast-ttl | -tTime-to-live for multicast packets.--traffic-type | -TNetwork transmission type of vSAN traffic through a virtual network adapter.Supported values are vsan, witness. Type vsan means general vSAN transmission, which is used for both data and witness transmission, if there is no virtual adapter configured with witness traffic type; Type witness indicates that, vSAN vmknic is used for vSAN witness transmission. Once a virtual adapter is configured with witness traffic type, vSAN witness data transmission will stop using virtual adpater with vsan traffic type, and use first dicovered virtual adapter with witness traffic type. Multiple traffic types can be provided in format -T type1 -T type2. Default value is vsan, if this option is not specified.--helpShow the help message. |
vsan network ipv4 remove | Remove an IP interface from the vSAN network configuration. | --force | -fNotify vSAN subsystem of removal, even if not configured.--interface-name | -iInterface name. (required)--helpShow the help message. |
vsan network ipv4 set | Reconfigure an IP interface in the vSAN network configuration. | --agent-mc-addr | -dIPv4 multicast address for agent (also called downstream) group.--agent-mc-port | -pMulticast address port for agent (also called downstream) group.--agent-v6-mc-addr | -DIPv6 multicast address for agent (also called downstream) group.--host-uc-port | -cUnicast address port for host unicast channel.--interface-name | -iInterface name. (required)--master-mc-addr | -uIPv4 multicast address for master (also called upstream) group.--master-mc-port | -oMulticast address port for master (also called upstream) group.--master-v6-mc-addr | -UIPv6 multicast address for master (also called upstream) group.--multicast-ttl | -tTime-to-live for multicast packets.--traffic-type | -TNetwork transmission type of vSAN traffic through a virtual network adapter.Supported values are vsan, witness. Type vsan means general vSAN transmission, which is used for both data and witness transmission, if there is no virtual adapter configured with witness traffic type; Type witness indicates that, vSAN vmknic is used for vSAN witness transmission. Once a virtual adapter is configured with witness traffic type, vSAN witness data transmission will stop using virtual adpater with vsan traffic type, and use first dicovered virtual adapter with witness traffic type. Multiple traffic types can be provided in format -T type1 -T type2. Default value is vsan, if this option is not specified.--helpShow the help message. |
vsan network security get | Get vSAN network security configurations for a subcluster. | --cluster-uuid | -uSpecify the vSAN cluster UUID of the cluster instance which will be displayed, in the form “nnnnnnnn-nnnn-nnnn-nnnn-nnnnnnnnnnnn” where n are hexadecimal digits.--helpShow the help message. |
vsan network security list | List vSAN network security configurations. | --helpShow the help message. |
vsan network security set | Configure vSAN network security settings for a subcluster. | --cluster-uuid | -uSpecify the vSAN cluster UUID of the cluster instance which will be set, in the form “nnnnnnnn-nnnn-nnnn-nnnn-nnnnnnnnnnnn” where n are hexadecimal digits.--encryption | -eData-in-transit encryption status.--rekey-interval | -rRekey interval for data-in-transit encryption, in minutes. Default interval is 1440, i.e. 24 hours. Minimal interval is 30 minutes and maximum is 10080, i.e. 7 days.--helpShow the help message. |
vsan perf get | Gets current status (Enabled or Disabled). | --helpShow the help message. |
vsan perf set | Set vSAN performance service configuration. | --enabledSet status, enabling or disabling vSAN performance service.--intervalSet the collect interval in seconds. This parameter is unsupported and for development use only.--policySpecify the policy for enabling. Usage example: –policy='((“hostFailuresToTolerate”i0))’--use-ramdiskEnable and set the size in MB of RAM disk. This parameter is unsupported and for development use only.--verboseSet the verbose mode value.--helpShow the help message. |
vsan perf diagnostic get | Gets current status about diagnostic mode. | --helpShow the help message. |
vsan perf diagnostic set | Set vSAN diagnostic mode configuration. | --enabledSet status, enabling or disabling diagnostic mode. (required)--intervalSet the collect interval in seconds for diagnostic mode.--use-ramdiskEnable and set the size in MB of RAM disk for diagnostic mode.--helpShow the help message. |
vsan policy cleardefault | Clear default vSAN storage policy values. | --helpShow the help message. |
vsan policy getdefault | Get default vSAN storage policy values. | --policy-class | -cvSAN policy class whose default value to get. If not provided, defaults for all classes will be retrieved. Options are: [cluster, vdisk, vmnamespace, vmswap, vmem].--helpShow the help message. |
vsan policy setdefault | Set default vSAN storage policy values. | --policy | -pvSAN policy to set as default, in the form of a string. Options are:1)cacheReservation – Flash capacity reserved as read cache for the storage object. Specified as a percentage of the logical size of the object. To be used only for addressing read performance issues. Reserved flash capacity cannot be used by other objects. Unreserved flash is shared fairly among all objects. It is specified in parts per million. Default value: 0, Maximum value: 1000000. 2)forceProvisioning – If this option is “1” the object will be provisioned even if the policy specified in the storage policy is not satisfiable with the resources currently available in the cluster. vSAN will try to bring the object into compliance if and when resources become available. Default value: 0. 3)hostFailuresToTolerate – Defines the number of host, disk, or network failures a storage object can tolerate. When the fault tolerance method is mirroring: to tolerate “n” failures, “n+1” copies of the object are created and “2n+1” hosts contributing storage are required (if fault domains are configured, “2n+1” fault domains with hosts contributing storage are required). When the fault tolerance method is erasure coding: to tolerate 1 failure, 4 hosts (or fault domains) are required; and to tolerate 2 failures, 6 hosts (or fault domains) are required. Note: A host which is not part of a fault domain is counted as its own single-host fault domain. Default value: 1, Maximum value: 3. 4)stripeWidth – The number of HDDs across which each replica of storage object is striped. A value higher than 1 may result in better performance (for e.g when flash read cache misses need to get serviced from HDD), but also results in higher used of system resources. Default value: 1, Maximum value: 12. 5)proportionalCapacity – Percentage of the logical size of the storage object that will be reserved (thick provisioning) upon VM provisioning. The rest of the storage object is thin provisioned. Default value: 0%, Maximum value: 100%. 6)iopsLimit – Defines upper IOPS limit for a disk. IO rate that has been serviced on a disk will be measured and if the rate exceeds the IOPS limit, IO will be delayed to keep it under the limit. Zero value means no limit. Default value: 0. 7)replicaPreference – Defines the method used to tolerate failures. RAID-1 achieves failure tolerance using mirrors, which provides better performance. RAID-5/6 achieves failure tolerance using parity blocks, which provides better space efficiency. RAID-5/6 is only available on All-flash and when the number of failures to tolerate is set to 1 or 2: a value of 1 implies a RAID-5 configuration, and a value of 2 implies a RAID-6 configuration. Default value: RAID-1. (required) --policy-class | -cvSAN policy class whose default value to set. Options are: [cluster, vdisk, vmnamespace, vmswap, vmem]. (required)--helpShow the help message. |
vsan resync bandwidth get | Get information about vSAN resync bandwidth in Mbps for the disk group with the heaviest resync workload. | --helpShow the help message. |
vsan resync throttle get | Get information about vSAN resync throttling | --helpShow the help message. |
vsan resync throttle set | Configure vSAN resync throttling | --levelSet vSAN resync throttle level in Mbps (integer in the range 0-512, 0 means no throttling) (required)--helpShow the help message. |
vsan storage add | Add physical disk for vSAN usage. | --disks | -dName of disk devices to be added to a vSAN disk-group as vSAN capacity tier devices. Expects an empty device with no partitions as the device will be partitioned and formatted. Otherwise this operation will fail. The command expects the device name for the disk to be provided, e.g.: mpx.vmhba2:C0:T1:L0.Multiple capacity device can be provided using format -d device1 -d device2 -d device3 (required)--ssd | -sSpecify a caching device to be added to a vSAN disk-group as vSAN caching tier device. Expects an empty cache device with no partitions in which case the device will be partitioned and formatted. Otherwise this operation will fail. If a cache device which is already added for use by vSAN, is provided along with ‘-d/–disks’, then the disk mentioned with ‘-d’ will be added to the existing disk-group created under this cache device and in which case, the cache device won’t be partitioned and formatted. The command expects the device name for the drive to be provided, e.g.: mpx.vmhba2:C0:T1:L0 using format -s device (required)--helpShow the help message. |
vsan storage list | List vSAN storage configuration. | --device | -dFilter the output of this command to only show a single device with specified device name.--uuid | -uFilter the output of this command to only show a single device with specified uuid.--helpShow the help message. |
vsan storage remove | Remove physical disks from vSAN disk groups. | --disk | -dSpecify individual hdd to remove from vSAN usage.e.g.: mpx.vmhba2:C0:T1:L0--evacuation-mode | -mAction the vSAN service must take before the host can enter maintenance mode (default noAction). Allowed values are:ensureObjectAccessibility: Evacuate data from the disk to ensure object accessibility in the vSAN cluster, before removing the disk. evacuateAllData: Evacuate all data from the disk before removing it. noAction: Do not move vSAN data out of the disk before removing it. --ssd | -sSpecify a disk group’s fronting ssd to remove the ssd and each backing hdd from vSAN usage.e.g.: mpx.vmhba2:C0:T1:L0--uuid | -uSpecify UUID of vSAN disk.e.g.: 52afa1de-4240-d5d6-17f9-8af1ec8509e5--helpShow the help message. |
vsan storage automode get | Get status of storage auto claim mode. | --helpShow the help message. |
vsan storage automode set | Configure storage auto claim mode | --enabledChanging 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)--helpShow the help message. |
vsan storage diskgroup mount | Mount a vSAN disk or disk group. | --disk | -dSpecify the disk to mount for use by vSAN.e.g.: mpx.vmhba0:C0:T1:L0.--ssd | -sSpecify a disk group’s fronting ssd to mount the ssd and each backing hdd for use by vSAN.e.g.: mpx.vmhba2:C0:T1:L0.--uuid | -uSpecify a vSAN UUID of the disk or fronting ssd to mount for use by vSAN.e.g.: 5291022a-ad03-df90-dd0f-b9f980cc005e.--helpShow the help message. |
vsan storage diskgroup rebuild | Rebuild vSAN diskgroup. | --evacuation-mode | -mSpecify an action to take upon removing the disk group from VSAN (default noAction).ensureObjectAccessibility: Evacuate data from the disk to ensure object accessibility in the VSAN cluster, before removing the disk. evacuateAllData: Evacuate all data from the disk before removing it. noAction: Do not move VSAN data out of the disk before removing it. --forceSkip unhealthy disks.--ssd | -sSpecify a disk group’s fronting SSD to rebuild the SSD and each backing HDD for use by vSAN. E.g.: mpx.vmhba2:C0:T1:L0.--trim | -tSpecify a trim region for all disks in the diskgroup (default is metaDataOnly). Allowed values are:fullDisk: Trim the full disks. metaDataOnly: Only trim the metadata region in the disks. noTrim: Skip the trim operation. --uuid | -uSpecify a vSAN UUID of the fronting SSD to rebuild for use by vSAN. E.g.: 5291022a-ad03-df90-dd0f-b9f980cc005e.--helpShow the help message. |
vsan storage diskgroup unmount | Unmount vSAN disk or disk group. | --disk | -dSpecify the hdd to unmount from vSAN usage.e.g.: mpx.vmhba0:C0:T1:L0.--evacuation-mode | -mSpecify an action to take upon unmounting the disk group from vSAN (default NoAction).EnsureObjectAccessibility: Evacuate data from the disk to ensure object accessibility in the vSAN cluster, before unmount the disk. EvacuateAllData: Evacuate all data from the disk before unmounting it. NoAction: Do not move vSAN data out of the disk before unmount it. --ssd | -sSpecify a disk group’s fronting ssd to unmount the ssd and each backing hdd from vSAN usage.e.g.: mpx.vmhba2:C0:T1:L0.--uuid | -uSpecify a vSAN UUID of the disk or fronting ssd to unmount for use by vSAN.e.g.: 5291022a-ad03-df90-dd0f-b9f980cc005e.--helpShow the help message. |
vsan storage tag add | Add a vSAN storage tag. | --disk | -dName of the disk to which the tag should be added. (required)--tag | -tTag to be added to disk. Supported tags are [capacityFlash, vsanDirect]. (required)--helpShow the help message. |
vsan storage tag remove | Remove a vSAN storage tag. | --disk | -dName of the disk from which the tag should be removed. (required)--tag | -tTag to be removed from disk. Supported tags are [capacityFlash, vsanDirect]. (required)--helpShow the help message. |
vsan storagepool add | Add physical disk for vSAN usage. | --disk | -dName of disk devices to be added to single tier storage pool. Expects an empty device with no partitions as the device will be partitioned and formatted. Otherwise this operation will fail. The command expects the device name for the disk to be provided, e.g.: mpx.vmhba2:C0:T1:L0. Multiple devices can be provided using format -d device1 -d device2 -d device3. (required)--helpShow the help message. |
vsan storagepool list | List vSAN storage pool configuration. | --device | -dFilter the output of this command to only show a single device with specified device name.--uuid | -uFilter the output of this command to only show a single device with specified UUID.--helpShow the help message. |
vsan storagepool mount | Mount vSAN disk from storage pool. | --disk | -dName of disk to mount from storage pool. e.g.: mpx.vmhba2:C0:T1:L0. Multiple devices can be provided using format -d device1 -d device2 -d device3.--uuid | -uThe vSAN UUID of disk to mount from storage pool. e.g.: 52afa1de-4240-d5d6-17f9-8af1ec8509e5. Multiple UUIDs can be provided using format -u uuid1 -u uuid2 -u uuid3.--helpShow the help message. |
vsan storagepool rebuild | Rebuild vSAN storage pool disks. | --disk | -dName of disk to rebuild for use by vSAN storage pool. E.g.: mpx.vmhba2:C0:T1:L0.--evacuation-mode | -mAction to take upon removing storage pool from vSAN (default noAction). Available modes areEnsureObjectAccessibility: Evacuate data from the disk to ensure object accessibility in the vSAN cluster, before removing the disk. EvacuateAllData: Evacuate all data from the disk before removing it. NoAction: Do not move vSAN data out of the disk before removing it. --uuid | -uThe vSAN UUID of the disk to rebuild for use by vSAN storage pool. E.g.: 5291022a-ad03-df90-dd0f-b9f980cc005e.--helpShow the help message. |
vsan storagepool remove | Remove physical disk from storage pool usage. Exactly one of –disk or –uuid param is required. | --disk | -dSpecify individual vSAN disk to remove from storage pool. e.g.: mpx.vmhba2:C0:T1:L0.--evacuation-mode | -mAction the vSAN service must take before the disk can be removed (default noAction). Allowed values are:ensureObjectAccessibility: Evacuate data from the disk to ensure object accessibility in the vSAN cluster, before removing the disk. evacuateAllData: Evacuate all data from the disk before removing it. noAction: Do not move vSAN data out of the disk before removing it. --force | -fForcefully remove unhealthy disk that has run into permanent metadata read/write errors.Use -f|–force option only if remove disk operation failed repeatedly without force option. Only ‘noAction’ evacuation mode is supported with -f|–force option. --uuid | -uSpecify UUID of vSAN disk to remove from storage pool. e.g.: 52afa1de-4240-d5d6-17f9-8af1ec8509e5.--helpShow the help message. |
vsan storagepool unmount | Unmount vSAN disk from storage pool. | --disk | -dName of disk to unmount from storage pool. e.g.: mpx.vmhba2:C0:T1:L0.--evacuation-mode | -mAction to take upon unmounting storage pool from vSAN (default noAction). Available modes areEnsureObjectAccessibility: Evacuate data from the disk to ensure object accessibility in the vSAN cluster, before unmounting the disk. EvacuateAllData: Evacuate all data from the disk before unmounting it. NoAction: Do not move vSAN data out of the disk before unmounting it. --force | -fForcefully unmount unhealthy disk that has run into permanent metadata read/write errors.Use -f|–force option only if unmount disk operation failed repeatedly without force option. Only ‘noAction’ evacuation mode is supported with -f|–force option. --uuid | -uThe vSAN UUID of disk to unmount from storage pool. e.g.: 52afa1de-4240-d5d6-17f9-8af1ec8509e5.--helpShow the help message. |
vsan trace get | Get the vSAN tracing configuration. | --helpShow the help message. |
vsan trace set | Configure vSAN trace. Please note: This command is not thread safe. | --domobjnumfiles | -dLog file rotation for vSAN trace DOM object files.--domobjsizeMaximum size of vSAN DOM object trace files in MB.--logtosyslog | -lBoolean value to enable or disable logging urgent traces to syslog.--lsom-num-filesLog file rotation for vSAN trace LSOM files.--lsom-sizeMaximum size of vSAN LSOM trace files in MB.--lsom-verbose-num-filesLog file rotation for vSAN trace LSOM Verbose files.--lsom-verbose-sizeMaximum size of vSAN LSOM trace verbose files in MB.--numfiles | -fLog file rotation for vSAN trace files.--path | -pPath to store vSAN trace files.--reset | -rWhen set to true, reset defaults for vSAN trace files.--size | -sMaximum size of vSAN trace files in MB.--urgentnumfiles | -uLog file rotation for vSAN trace urgent files.--urgentsizeMaximum size of vSAN urgent trace files in MB.--helpShow the help message. |
