Difference between revisions of "ESXi - 6.7 esxcli Command List"

From Da Nerd Mage Wiki
Jump to navigation Jump to search
(Created page with "The '''esxcli''' command set is based in a "namespace" model. It's kinda weird & convoluted. = Usage = Usage: esxcli [options] {namespace}+ {cmd} [cmd options] Options: --formatter=FORMATTER Override the formatter to use for a given command. Available formatter: keyvalue, csv, xml --debug Enable debug or internal use options --version Display version information for the script -?...")
 
 
(11 intermediate revisions by the same user not shown)
Line 1: Line 1:
The '''esxcli''' command set is based in a "namespace" model. It's kinda weird & convoluted.
The '''esxcli''' command set is based in a "namespace" model. It's kinda weird & convoluted.


The good news:  This command set seems to cover nearly everything the WebUI does.  Which means that you can do these things without hunting through a GUI. (You just get to hunt through this documentation instead... :{{!}} )
= Usage =
= Usage =
  Usage: esxcli [options] {namespace}+ {cmd} [cmd options]
  Usage: esxcli [options] {namespace}+ {cmd} [cmd options]
Line 13: Line 14:


= The NameSpaces =
= The NameSpaces =
== device ==
Device manager commands


* device '''add'''
* [[ESXi - 6.7 esxcli device{{!}}device]]
*: Add a device to enable a software device driver.
::Device manager commands
:*: <code>esxcli device add '''-d IDENTIFIER [-i ADDRESS]'''</code>
* [[ESXi - 6.7 esxcli esxcli{{!}}esxcli]]
:* alias '''get'''
::Commands that operate on the esxcli system itself allowing users to get additional information.
:*: Display hardware location info for a device alias.
* [[ESXi - 6.7 esxcli fcoe{{!}}fcoe]]
::*: <code>esxcli device alias get '''-n ALIAS'''</code>
::VMware Fibre Channel over Ethernet (FCoE) commands.
:* alias '''list'''
* [[ESXi - 6.7 esxcli graphics{{!}}graphics]]
:*: List device aliases.
::VMware graphics commands.
::*: <code>esxcli device alias list</code>
* [[ESXi - 6.7 esxcli hardware{{!}}hardware]]
:* driver '''list'''
::VMKernel hardware properties and commands for configuring hardware.
:*: Show driver status for specific devices.
* [[ESXi - 6.7 iscsi{{!}}iscsi]]
::*: <code>esxcli device driver list</code>
::VMware Internet Small Computer Systems Interface (iSCSI) commands.
:* software '''add'''
* [[ESXi - 6.7 network{{!}}network]]
:*: Add a device to enable a software device driver.
::Operations that pertain to the maintenance of networking on an ESX host. This includes a wide variety of commands to manipulate virtual networking components (vswitch, portgroup, etc) as well as local host IP, DNS and general host networking settings.
::*: <code>esxcli device software add '''-d IDENTIFIER [-i ADDRESS]'''</code>
* [[ESXi - 6.7 nvme{{!}}nvme]]
:* software '''list'''
::VMware NVMe driver esxcli extensions
:*: List software devices.
* [[ESXi - 6.7 rdma{{!}}rdma]]
::*: <code>esxcli device software list</code>
::Operations that pertain to remote direct memory access (RDMA) protocol stack on an ESX host.
:* software '''remove'''
* [[ESXi - 6.7 sched{{!}}sched]]
:*: Remove a software device.
::VMKernel system properties and commands for configuring scheduling related functionality.
::*: <code>esxcli device software remove '''-d IDENTIFIER [-i ADDRESS]'''</code>
::(Really...  If you say so...  Don't look like that to me...)
'''IDENTIFIER'''
* [[ESXi - 6.7 software{{!}}software]]
: Device identifier from the device specification for the software device driver. Valid input is in reverse domain name format (e.g. com.company.device...). (required)
::Manage the ESXi software image and packages
'''ADDRESS'''
* [[ESXi - 6.7 storage{{!}}storage]]
: Unique number to address this instance of the device.
::VMware storage commands.
'''ALIAS'''
* [[ESXi - 6.7 system{{!}}system]]
: Alias to lookup (required)
::VMKernel system properties and commands for configuring properties of the kernel core system and related system services.
 
* [[ESXi - 6.7 vm{{!}}vm]]
== esxcli ==
::A small number of operations that allow a user to Control Virtual Machine operations.
Commands that operate on the esxcli system itself allowing users to get additional information.
* [[ESXi - 6.7 vsan{{!}}vsan]]
* esxcli
::VMware vSAN commands
** command '''list'''
[[Category:ESXi]]
**: List all of the esxcli commands.
[[Category:WIP]]
:**: <code>esxcli esxcli command list</code>
 
== fcoe ==
VMware FCOE commands.
== graphics ==
VMware graphics commands.
== hardware ==
VMKernel hardware properties and commands for configuring hardware.
== iscsi ==
VMware iSCSI commands.
== network ==
Operations that pertain to the maintenance of networking on an ESX host. This includes a wide variety of commands to manipulate virtual networking components (vswitch, portgroup, etc) as well as local host IP, DNS and general host networking settings.
== nvme ==
VMware NVMe driver esxcli extensions
== rdma ==
Operations that pertain to remote direct memory access (RDMA) protocol stack on an ESX host.
== sched ==
VMKernel system properties and commands for configuring scheduling related functionality.
== software ==
Manage the ESXi software image and packages
== storage ==
VMware storage commands.
== system ==
VMKernel system properties and commands for configuring properties of the kernel core system and related system services.
== vm ==
A small number of operations that allow a user to Control Virtual Machine operations.
== vsan ==
VMware vSAN commands

Latest revision as of 19:11, 10 February 2022

The esxcli command set is based in a "namespace" model. It's kinda weird & convoluted.

The good news:  This command set seems to cover nearly everything the WebUI does.  Which means that you can do these things without hunting through a GUI. (You just get to hunt through this documentation instead... :| )

Usage

Usage: esxcli [options] {namespace}+ {cmd} [cmd options]

Options:
  --formatter=FORMATTER
                        Override the formatter to use for a given command. Available formatter:
                        keyvalue, csv, xml
  --debug               Enable debug or internal use options
  --version             Display version information for the script
  -?, --help            Display usage information for the script

The NameSpaces

Device manager commands
Commands that operate on the esxcli system itself allowing users to get additional information.
VMware Fibre Channel over Ethernet (FCoE) commands.
VMware graphics commands.
VMKernel hardware properties and commands for configuring hardware.
VMware Internet Small Computer Systems Interface (iSCSI) commands.
Operations that pertain to the maintenance of networking on an ESX host. This includes a wide variety of commands to manipulate virtual networking components (vswitch, portgroup, etc) as well as local host IP, DNS and general host networking settings.
VMware NVMe driver esxcli extensions
Operations that pertain to remote direct memory access (RDMA) protocol stack on an ESX host.
VMKernel system properties and commands for configuring scheduling related functionality.
(Really... If you say so... Don't look like that to me...)
Manage the ESXi software image and packages
VMware storage commands.
VMKernel system properties and commands for configuring properties of the kernel core system and related system services.
A small number of operations that allow a user to Control Virtual Machine operations.
VMware vSAN commands
Retrieved from ‘https://wiki.nerdmage.ca/index.php?title=ESXi_-_6.7_esxcli_Command_List&oldid=944’