Getting Started with vSphere Command-Line Interfaces gives an overview of command-line interfaces in vSphere 5.0 and vSphere 5.1 and gets you started with ESXi Shell commands and vCLI (VMware® vSphere Command-Line Interface) commands. This book also includes instructions for installing vCLI and a reference to connection parameters.
Intended Audience
This book is for experienced Windows or Linux system administrators who are familiar with vSphere administration tasks and datacenter operations.
VMware Technical Publications Glossary
VMware Technical Publications provides a glossary of terms that might be unfamiliar to you. For definitions of terms as they are used in VMware technical documentation, go to
Document Feedback
VMware welcomes your suggestions for improving our documentation. If you have comments, send your feedback to
Related Documentation
The documentation for vCLI is available in the vSphere Documentation Center and on the vCLI documentation page. Go to, select VMware Administration Products, and select vSphere Command-Line Interface.
Command-Line Management in vSphere 5 for Service Console Users is a technical note for users who are currently using ESX service console commands, scripts, agents, or logs. You learn how to transition to an off-host implementation or to use the ESXi Shell in special cases.
vSphere Command-Line Interface Concepts and Examples presents usage examples for many commands, such as setting up software and hardware iSCSI, adding virtual switches, setting up Active Directory authentication, and so on. The document includes the same example with the ESXCLI command and with the vicfg- command.
vSphere Command-Line Interface Reference is a reference to both ESXCLI commands and vicfg- commands. The vicfg- command help is generated from the POD available for each command, run pod2html for any vicfg- command to generate individual HTML files interactively. The ESXCLI reference information is generated from the ESXCLI help.
The documentation for PowerCLI is available in the vSphere Documentation Center and on the PowerCLI documentation page. Go to, select VMware Administration Products, and select vSphere PowerCLI documentation.
The vSphere SDK for Perl documentation explains how you can use the vSphere SDK for Perl and related utility applications to manage your vSphere environment. The documentation includes information about the vSphere SDK for Perl Utility Applications.
The vSphere Management Assistant Guide explains how to install and use the vSphere Management Assistant (vMA). vMA is a virtual machine that includes vCLI and other prepackaged software. See Deploying vMA.
Background information for the tasks discussed in this book is available in the vSphere documentation set. The vSphere documentation consists of the combined VMware vCenter Server and ESXi documentation.
Technical Support and Education Resources
The following sections describe the technical support resources available to you. To access the current version of this book and other books, go to
Online and Telephone Support
To use online support to submit technical support requests, view your product and contract information, and register your products, go to
Customers with appropriate support contracts should use telephone support for the fastest response on priority 1 issues. Go to
Support Offerings
To find out how VMware support offerings can help meet your business needs, go to
VMware Professional Services
VMware Education Services courses offer extensive hands-on labs, case study examples, and course materials designed to be used as on-the-job reference tools. Courses are available onsite, in the classroom, and live online. For onsite pilot programs and implementation best practices, VMware Consulting Services provides offerings to help you assess, plan, build, and manage your virtual environment. To access information about education classes, certification programs, and consulting services, go to