This chapter introduces the command set, presents supported commands for different versions of vSphere, lists connection options, and discusses vCLI and lockdown mode.
What to read next
Introduction The commands in the vSphere CLI package allow you to perform vSphere configuration tasks using commands from vCLI package installed on supported platforms, or using commands from vMA. The package consists of several command sets.
List of Available Host Management Commands vCLI host management commands from earlier versions have been replaced with commands that have equivalent functionality.
Targets and Protocols for vCLI Host Management Commands Most vCLI commands are used to manage or retrieve information about one or more ESXi hosts. They can target an ESXi host or a vCenter Server system.
Supported Platforms for vCLI Commands Platform support for vCLI commands differs depending on the vCenter Server and ESXi version.
Commands with an esxcfg Prefix To facilitate easy migration if shell scripts that use esxcfg- commands, the vCLI package includes a copy of each vicfg- command that uses an esxcfg prefix.
ESXCLI Commands Available on Different ESXi Hosts The available ESXCLI commands depend on the ESXi host version.
Trust Relationship Requirement for ESXCLI Commands Starting with vSphere 6.0, ESXCLI checks whether a trust relationship exists between the machine where you run the ESXCLI command and the ESXi host. An error results if the trust relationship does not exist.
Using ESXCLI Output Many ESXCLI commands generate output you might want to use in your application. You can run esxcli with the --formatter dispatcher option and send the resulting output as input to a parser.
Connection Options for vCLI Host Management Commands You can run host management commands such as ESXCLI commands, vicfg- commands, and other commands with several different connection options.
Connection Options for DCLI Commands DCLI is a CLI client to the vSphere Automation SDK interface for managing VMware SDDC services. A DCLI command talks to a vSphere Automation SDK endpoint to get the vSphere Automation SDK command information, executes the command, and displays result to the user.
vCLI Host Management Commands and Lockdown Mode For additional security, an administrator can place one or more hosts managed by a vCenter Server system in lockdown mode. Lockdown mode affects login privileges for the ESXi host.