vSphere Command-Line Interface Reference

The vSphere CLI command set allows you to run common system administration commands against vSphere systems from an administration server of your choice.

Linux Installation: If you accepted the defaults during installation, you can find the installed software in the following locations:

Windows Installation: vSphere CLI commands are installed in C:\Program Files\VMware\VMware vSphere CLI\bin by default.

The vSphere CLI includes the commands listed below, as well as the resxtop and esxcli commands.

To display usage information, click the command name in the Documentation column of Table 1.

Table 1: vSphere CLI commands

esxcli esxcliLists descriptions of esxcli commands.
esxcli fcoeFCOE (Fibre Channel over Ethernet) comands
esxcli hardwareHardware namespace. Used primarily for extracting information about the current system setup.
esxcli iscsiiSCSI namespace for minitoring and managing hardware and software iSCSI.
esxcli networkNetwork namespace for managing virtual networking including virtual switches and VMkernel network interfaces.
esxcli schedManage the shared system-wide swap space.
esxcli softwareSoftware namespace. Includes commands for managing and installing image profiles and VIBs.
esxcli storageIncludes core storage commands and other storage management commands.
esxcli systemSystem monitoring and management command.
esxcli vmNamespace for listing virtual machines and shutting them down forcefully.
svmotionMoves a virtual machine's configuration file and optionally its disks while the virtual machine is running. Must run against a vCenter Server system.
vicfg-advcfgPerforms advanced configuration including enabling and disabling CIM providers. Use this command as instructed by VMware.
vicfg-authconfigManages Active Directory authentication.
vicfg-cfgbackupBacks up the configuration data of an ESXi system and restores previously saved configuration data.
vicfg-dns.plSpecifies an ESX/ESXi host's DNS (Domain Name Server) configuration.
vicfg-dumppartManages diagnostic partitions.
vicfg-hostopsAllows you to start, stop, and examine ESX/ESXi hosts and to instruct them to enter maintenance mode and exit from maintenance mode.
vicfg-ipsecSupports setup of IPSec.
vicfg-iscsiManages iSCSI storage.
vicfg-moduleEnables VMkernel options. Use this command with the options listed, or as instructed by VMware.
vicfg-mpathDisplays information about storage array paths and allows you to change a path's state.
vicfg-mpath35Configures multipath settings for Fibre Channel or iSCSI LUNs.
vicfg-nasManages NAS file systems.
vicfg-nicsManages the ESX/ESXi host's NICs (uplink adapters).
vicfg-ntpSpecifies the NTP (Network Time Protocol) server.
vicfg-rescanRescans the storage configuration.
vicfg-routeLists or changes the ESX/ESXi host's route entry (IP gateway).
vicfg-scsidevsFinds available LUNs.
vicfg-snmpManages the Simple Network Management Protocol (SNMP) agent.
vicfg-syslogSpecifies the syslog server and the port to connect to that server for ESXi hosts.
vicfg-userCreates, modifies, deletes, and lists local direct access users and groups of users.
vicfg-vmknicAdds, deletes, and modifies virtual network adapters (VMkernel NICs).
vicfg-volumeSupports resignaturing a VMFS snapshot volume and mounting and unmounting the snapshot volume.
vicfg-vswitchAdds or removes virtual switches or vNetwork Distributed Switches, or modifies switch settings.
vifs.plPerforms file system operations such as retrieving and uploading files on the remote server.
vihostupdateManages updates of ESX/ESXi hosts. Use vihostupdate35 for ESXi 3.5 hosts.
vihostupdate35Manages updates of ESX/ESXi version 3.5 hosts.
vmkfstools Creates and manipulates virtual disks, file systems, logical volumes, and physical storage devices on ESX/ESXi hosts.
vmware-cmdPerforms virtual machine operations remotely. This includes, for example, creating a snapshot, powering the virtual machine on or off, and getting information about the virtual machine.

VMware welcomes your suggestions for improving technical publications. Email your feedback to docfeedback@vmware.com

Copyright © 2008-2012 VMware, Inc. All rights reserved.