VMware ESXi 5.

1 Reference

ESXCFG/VICFG PowerCLI Cmdlet ESXCLI 5.1 ESXCLI 5.1 Name Spaces Boot Options ESXi ESXi Upgrade Path
Command CIM broker HA NTP syslog VM
esxcfg-advcfg Get-VMHostAdvancedConfiguration esxcli system settings advanced
vicfg-advcfg Set-VMHostAdvancedConfiguration esxcli CIM
Stateless providers hostd DCUI vpxa SNMP VMX vSphere Client Incompatible Replace Server
esxcfg-dns Get-VMHostNetwork esxcli network ip dns
vicfg-dns Set-VMHostNetwork PXE Hardware
esxcfg-dumpart Get-EsxCLI esxcli system coredump fcoe hardware iscsi network sched software storage system vm VMM
vicfg-dumppart
User mode API (fuller POSIX subset) Running Host Running
esxcfg-fcoe Get-EsxCLI esxcli fcoe adapter cpu adapter fence swap sources core boot process Upgrade to 4.x
nic ipmi networkportal firewall acceptance nmp coredump PowerCLI vCenter 5.1 ESX/ESXi 3.5
vicfg-fcoe
bootdevice physicalnetwork ip profile san module USB
esxcfg-ipsec Get-EsxCLI esxcli network ip ipsec
clock portal nic vib vmfs process Distributed Virtual NIC
vicfg-ipsec
memory session port filesystem secpolicy Resource VM le system & Switch Compatible Non-Upgradable
esxcfg-module Get-EsxCLI esxcli system module pci ibftboot sriovnic nfs settings New 5.1 Install
vicfg-module platform logicalnetwork vm stats
VMkernel Scheduling Hardware Boot Disk (ESX only)
vMA/ESXCLI/
esxcfg-mpath Get-ScsiLun esxcli storage core path trustedboot portal vswitch syslog SAN Storage Stack Network Stack vCLI
vicfg-mpath Set-ScsiLun plugin diag visorfs Host Running Upgrade to 5.1
software hostname
esxcfg-nas Get-Datastore esxcli storage nfs
maintenanceMode ESX/ESXi 4.x/5.0 Using Update
vicfg-nas New-Datastore Device Drivers Manager
Set-Datastore shutdown
snmp
Upgradable
esxcfg-nics
vicfg-nics
Get-VMHostNetworkAdapter
Set-VMHostNetworkAdapter
esxcli network nic
time Local Disk Boot Disk Upgrade to 5.1
uuid Using ESXi
esxcfg-rescan Get-VMHostStorage - esxcli storage core adapter
version
vicfg-rescan RescanAllHBA
welcomemsg
Installer
esxcfg-route Set-VMHostNetwork esxcli network ip route
vicfg-route
esxcfg-scsidevs Get-ScsiLun esxcli storage core device
vicfg-scsidevs Set-ScsiLun esxcli storage filesystem
esxcfg-swiscsi
esxcfg-hwiscsi
Get-iScsiHBATarget
New-iScsiHBATarget
esxcli iscsi Host Commands Virtual Machine Commands Network Commands Storage Commands VMware Tools Upgrade Paths
vicfg-iscsi Set-iSciHBATarget
Remove-iScsiHBATarget Host Information List Registered VMs (vCLI only) vSwitch Storage Device
esxcfg-vmknic Get-VMHostNetworkAdapter esxcli network ip interface Display ESXi Version and Build # vmware-cmd -l List Standard Virtual Switches List All Storage Devices VMware Tools Incompatible with Must
vicfg-vmknic Set-VMHostNetworkAdapter # esxcli system version get # esxcli network vswitch standard list # esxcli storage core device list 3.x vSphere 5.0 Upgrade
esxcfg-volume Get-View needed to call APIs esxcli storage filesystem
Register a VM (vCLI)
Display ESXi Hardware Platform # vmware-cmd -s register /vmfs/volumes/<volume List Distributed Virtual Switches Get VAAI Status for all Devices
vicfg-volume
# esxcli hardware platform get name>/<vm>/<vm>.vmx <datacenter> <resource pool> # esxcli network vswitch dvs vmware list # esxcli storage core device vaai status get
esxcfg-vswitch Get-VirtualSwitch esxcli network vswitch
VMware
vicfg-vswitch Set-VirtualSwitch Storage Adapter Tools VMware Tools Compatible with Upgrade
List CPU Processors Unregister a VM (vCLI only) Add/Remove Virtual Switch Upgrade Optional
Get-VirtualPortGroup
# esxcli hardware cpu list # esxcli network vswitch standard [ add | remove ] List All Storage Adapters 4.x vSphere 5.0
# vmware-cmd -s unregister /vmfs/volumes/<volume
Set-VirtualPortGroup
name>/<vm>/<vm>.vmx --vswitch-name <name> # esxcli storage core adapter list Path
esxtop Get-EsxTop No equivalent List Memory
resxtop # esxcli hardware memory get List All Physical Network Adapters Rescan Storage Adapter
Get VM Power State (vCLI only) # esxcli storage core adapter rescan --adapter=<vmhba> Backward
# esxcli network nic list VMware Tools Compatible with
esxupdate Get-VMHostPatch esxcli software vib
List VMkernel Modules # vmware-cmd /vmfs/volumes/<volume name>/<vm>/<vm>.vmx 5.0 vSphere 5.0
Compatible with
Install-VMHostPatch getstate VMFS vSphere 4.x
# esxcli system module list Add/Remove Uplink to Virtual Switch
svmotion Move-VM -Datastore No equivalent # esxcli network vswitch standard [ add | remove ] List all VMFS volumes
vicfg-authconfig No equivalent No equivalent List Advanced Settings Power on a VM (vCLI only) --uplink-name=<vmnic> --vswitch-name <name> # esxcli storage filesystem list
# esxcli system settings advanced list # vmware-cmd /vmfs/volumes/<volume name>/<vm>/<vm>.vmx start
vicfg-cfgbackup Get-VMHostFirmware No equivalent Set MTU for Virtual Switch Check for VMFS snapshots
Set-VMHostFirmware Shut Down a VM (vCLI only) # esxcli network vswitch stanard set --mtu=[9000] # esxcli storage vmfs snapshot list
Host Congurations
# vmware-cmd /vmfs/volumes/<volume name>/<vm>/<vm>.vmx stop --vswitch-name <name>
vicfg-hostops Get-VMHost
Set-VMHost
esxcli system maintenanceMode
esxcli system shutdown
Manage and Congure Firewall Rules
# esxcli network firewall
[ soft | hard ]
Mount VMFS snapshot volume
# esxcli storage vmfs snapshot mount --volume-label=<label>
Virtual Hardware Upgrade Paths
Restart-VMHost List Network Policy Settings
Power o a VM (vCLI only) # esxcli network vswitch standard policy [ failover | Resignature VMFS snapshot volume
vicfg-mpath35 Get-ScsiLun No equivalent Congure Remote Syslog Host security | shapping ] get
Set-ScsiLun # esxcli system syslog config set # vmware-cmd /vmfs/volumes/<volume name>/<vm>/<vm>.vmx stop # esxcli storage vmfs snapshot resignature --volume-
[ soft | hard ] Virtual Hardware Incompatible with Must
--loghost=<ipaddress1>,<ipaddress2> label=<label>
vicfg-ntp Get-VMHostNTPServer No equivalent Portgroup Version 3 vSphere 5.0 Upgrade
Set-VMHostNTPServer
# esxcli network firewall ruleset set --enabled=true --ruleset- Reset a VM (vCLI only) List Portgroups NAS
vicfg-snmp Get-VMHostSNMP esxcli system snmp id=syslog # vmware-cmd /vmfs/volumes/<volume name>/<vm>/<vm>.vmx reset # esxcli network vswitch standard portgroup list List all NAS volumes
Set-VMHOstSNMP [soft | hard ] # esxcli storage nfs list
# esxcli system syslog reload Add/Remove Portgroup Virtual Hardware Compatible with Upgrade
vicfg-syslog Get-VMSysLogServer esxcli system syslog
Set-VMSysLogServer Suspend a VM (vCLI only) # esxcli network vswitch standard portgroup [ add | remove Add NAS volume Virtual Version 4, 7 vSphere 5.0 Optional
Congure Remote Core Dump # esxcli storage nfs add --host=<ipaddress>
# esxcli system coredump network set --interface-name=<vmk> # vmware-cmd /vmfs/volumes/<volume name>/<vm>/<vm>.vmx suspend ] --portgroup-name <portgroup> --vswitch-name <name> Hardware
vicfg-user Get-VMHostAccount No equivalent --share=</path/to/share> --volume-name=<share name>
Set-VMHostAccount --server-ipv4=<ipaddress> --server-port=<port> [soft | hard ] Upgrade
Set Portgroup VLAN ID
New-VMHostAccount
# esxcli network vswitch standard portgroup set Remove NS volume Path Upgrade Optional
Remove-VMHostAccount # esxcli system coredump network set --enabled=true Resume a VM (vCLI only) # esxcli storage nfs remove --volume-name=<share name>
Virtual Hardware Compatible with
--portgroup-name <portgroup> --vlan-id=<vlan> Version 8 vSphere 5.0 Not Backward
# vmware-cmd /vmfs/volumes/<volume name>/<vm>/<vm>.vmx resume Compatible
vifs Copy-DatastoreItem PSDrives No equivalent Verify and Check Core Dump Server [soft | hard ] iSCSI
vihostupdate Install-VMHostPatch esxcli software vib # esxcli system coredump get VMkernel Interface Enable Software iSCSI
vihostupdate35 Install-VMHostPatch No equivalent # esxcli system coredump check Get ESXi Host Platform Information (vCLI only) Add VMkernel Interface # esxcli iscsi software set --enabled=true Upgrade Optional
# vmware-cmd /vmfs/volumes/<volume name>/<vm>/<vm>.vmx # esxcli network ip interface add --interface-name=<vmk> Virtual Hardware Compatible with
vm-support Get-Log No equivalent Not Backward
Congure SNMP getproductinfo [ product | platform | build | majorversion| --portgroup-name=<portgroup> --mtu=<mtu> Get iSCSI Status Version 9 vSphere 5.1
vmkfstools No equivalent No equivalent # esxcli system snmp set --enabled=true minorversion ] # esxcli iscsi software get Compatible
vmkping No equivalent esxcli network diag ping --communities=<community> Set IP Address for VMkernel Interface
# esxcli network ip interface [ ipv4 | ipv6 ] set List iSCSI Adapters
--targets=<ipaddress1>@<port>,<ipaddress2>@<port> Get VM Uptime (vCLI only)
vmware-cmd Various cmdlets including: No equivalent --interface-name=<vmk> --ipv4=<ipaddress> # esxcli iscsi adapter list
# esxcli system snmp get # vmware-cmd /vmfs/volumes/<volume name>/<vm>/<vm>.vmx
Get-VM
getuptime --netmask=<netmask> --type=[ static | dhcp ] Add iSCSI Adapter
Set-VM
Get-Snapshot # esxcli system snmp test Tag VMkernel Interface Trac Type # esxcli iscsi networkportal add --adapter=<adapter>
Set-Snapshot Get VMware Tools Status (vCLI only)
# vmware-cmd /vmfs/volumes/<volume name>/<vm>/<vm>.vmx
# esxcli network ip interface tag add --interface- --nic=<vmkX> Performance and Troubleshooting
Start-VM Join Host to Active Directory name=vmk1 --tagname=[ Management | VMotion | faultToler-
Restart-VM gettoolslastactive Add/Remove iSCSI Target (Dynamic Discovery)
Join host to AD Domain (vCLI only) anceLogging | vSphereReplication ] # esxcli iscsi adapter discovery sendtarget [ add | remove
Stop-VM VMDK I/O Statistics
Get-VMGuestInfo # vicfg-authconfig --authscheme AD --joindomain <domainname> 0 = Not installed/Not running ] --adapter=<adapter> --address=<ip:port> # vscsiStats
--adusername <aduser> List all VMkernel Interfaces
1 = Normal # esxcli network ip interface list Add iSCSI Target (Static Discovery)
Virtual Hardware Support Show Open Ports on Remote Host (ESXi Shell only)
Verify AD Domain (vCLI only)
5 = Intermittent Heartbeat # esxcli iscsi adapter discovery statictarget [ add | # nc -z <ipaddress> [1-1024]
# vicfg-authconfig --authscheme AD --currentdomain Other Network Congurations remove ] --adapter=<adapter> --address=<ip:port>
vSphere 4.0 vSphere 4.1 vSphere 5.0 vSphere 5.1
100 = No heartbeat. Guest operating system might have Add/Remove DNS Servers --name=<target> Show Active TCP/IP Connections on Host
Remove host from AD Domain (vCLI) stopped responding
Virtual Hardware 4 Virtual Hardware 4 Virtual Hardware 4 Compatibility 3.x (Virtual Hardware 4) # esxcli network ip dns server [ add | remove ] # esxcli network ip connection list
# vicfg-authconfig --authscheme AD --leavecurrentdomain Rediscover iSCSI Targets
Virtual Hardware 7 Virtual Hardware 7 Compatibility 4.x (Virtual Hardware 7) --server=<ipaddress>
Virtual Hardware 8 Compatibility 5.0 (Virtual Hardware 8) Create VM Snapshot (vCLI only) # esxcli iscsi adapter discovery rediscover Show ARP Table on Host:
Compatibility 5.1 (Virtual Hardware 9) Host Operations # vmware-cmd /vmfs/volumes/<volume name>/<vm>/<vm>.vmx List DNS Servers --adapter=<adapter>
# esxcli network ip neighbor list
Enter/Exit Maintenance Mode createsnapshot <name> <desc> <quiesce> <memory> # esxcli network ip dns server list List all iSCSI Targets
VMware Tools Support # esxcli system maintenanceMode set --enabled=[ true | false ] quiesce = Quiesce filesystem w/VMware Tools [ 0 | 1 ] # esxcli iscsi adapter target list Capture Network Trac (ESXi Shell only)
memory = Include memory state in snapshot [ 0 | 1 ] Add/Remove Network Routes # tcpdump-uw -c 5 -n -i vmk0 host <ipaddress> and port [443]
vSphere 4.0 vSphere 4.1 vSphere 5.0 vSphere 5.1 Shutdown/Reboot Host # esxcli network ip route [ ipv4 | ipv6 ] [ add | remove ] Set iSCSI Name and Alia
# esxcli system shutdown reboot --delay=[60] Check if VM Has a Snapshot (vCLI only) --network=<network/CIDR> --gateway=<gateway> # esxcli iscsi adapter set --adapter=<adapter> Test Network Connectivity
Tools 4.0 Tools 4.1 Tools 4.x Tools 4.x
--reason=[installing new vib] # vmware-cmd /vmfs/volumes/<volume name>/<vm>/<vm>.vmx --name=<name> # esxcli network diag ping -s [9000] -H <ipaddress>
Tools 5.0 Tools 5.0
hassnapshot Add/Remove NTP Servers (vCLI only)
Tools 5.1 # vicfg-ntp [ --add | --delete ] <ipaddress> # esxcli iscsi adapter set --adapter=<adapter> Trace Network routes
Host Conguration Backup/Restore
Revert to VM Snapshot (vCLI only) --alias=<name> # traceroute <ipaddress>
Backup Host Conguration List NTP Servers (vCLI only)
Virtual Machine Capabilities # vmware-cmd /vmfs/volumes/<volume name>/<vm>/<vm>.vmx # vicfg-ntp --list
# vicfg-cfgbackup --save </path/to/filename> revertsnapshot
Congure iSCSI CHAP Authentication Host Performance Monitoring
vSphere 4.0 vSphere 4.1 vSphere 5.0 vSphere 5.1 # esxcli iscsi adapter auth chap set --direction=[ unit | # esxtop (ESXi Shell)
(ESX & ESXi) (ESX & ESXi) (ESXi) (ESXi) Restore Host Conguration Start NTP Service (vCLI only) mutal ] --authname=<name> --level=[ prohibited | discour-
# vicfg-cfgbackup --load </path/to/filename> Commit VM Snapshot (vCLI) # vicfg-ntp --start # resxtop (vCLI)
aged | preferred | required ] --secret=<secret>
8 vCPU 8 vCPU 32 vCPU 64 vCPU # vmware-cmd /vmfs/volumes/<volume name>/<vm>/<vm>.vmx
255GB RAM 255GB RAM 1TB RAM 1TB RAM
Patching removesnapshot Network Statistics Storage Statistics & Troubleshooting
10 NICs 10 NICs 10 NICs 10 NICs
128MB Video Ram 128MB Video Ram 128MB Video Ram 256MB Video Ram NIC Statistics Storage Statistics
Upload VIB to ESXi Datastore Forcibly Stop a VM with ESXCLI
# esxcli network nic list # esxcli storage san [ fc | fcoe | iscsi | sas ] stats get
# vifs --put /path/to/patch.zip "[datastore1] patch.zip" # esxcli vm process list
vHW4 vHW7 vHW8 vHW9
(Compatibility 3.x) (Compatibility 4.x (Compatibility 5.0) (Compatibility 5.1) Install VIB # esxcli vm process kill --type [ soft | hard | force ] -w # esxcli network nic stats get --nic-name=<vmnic> Get events for Fibre Channel
# esxcli storage san events get Resource Links
# esxcli software vib install <worldId>
4 vCPU 8 vCPU 32 vCPU 64 vCPU VLAN Statistics
--depot=/vmfs/volumes/datastore1/patch.zip soft = similiar to kill or kill -SIGTERM # esxcli network nic vlan stats set --enabled=true --nic- Clear events for Fibre Channel adapter
64GB RAM 255GB RAM 1TB RAM 1TB RAM ESXi Info Center:
4 NICs 10 NICs 10 NICs 10 NICs name=<vmnic> # # esxcli storage san events clear --adapter=<adapter>
128MB Video Ram 128MB Video Ram 128MB Video Ram 512MB Video Ram Verify VIB installation hard = similiar to kill -9 or kill -SIGKILL http://www.vmware.com/products/vsphere/esxi-and-esx/index.html
IPv6 Support VMCI E1000e Virtual GPU (vGPU)** # esxcli software vib list # esxcli network nic vlan stats get --nic-name=<vmnic> LIP reset for FC adapter
Paravirtualzied SAS virtual device for SVGA 3D Hardware Guest OS Storage force = use as a last resort # esxcli storage san fc reset --adapter=<adapter> ESXi Ocial Blog: http://blogs.vmware.com/vsphere/esxi/
Guest OS* MSCS Acceleration Reclamation** VM Port Statistics Automation Ocial Blog: http://blogs.vmware.com/vsphere/automation/
Enhanced VMXNET IDE virtual devices USB 3.0 Nested Hardware # esxcli network vm list LIP reset for FCoE adapter
VMXNET3 Generation 3 EFI BIOS Virtualization (HV) # esxcli storage san fcoe reset --adapter=<adapter> vSphere Ocial Blog: http://blogs.vmware.com/vsphere/
Virtual Machine UI for multi-core CPUs CPU Performance # esxcli network vm port list --world-id=<worldId>
Reset SAS adapter VMware Hands-on Labs Online: http://hol.vmware.com
Hot Plug Support Mac OS X Counters
# esxcli network port stats get --portid=<portId> # esxcli storage san sas reset --adapter=<adapter>
MDirectPath
Paravirtual Controllers Follow us on Twitter: @VMwarevSphere @VMwareESXi @VMWAutomation
* Dropped in vHW 8 USB 1 & 2 ** View Only Feature

ESXCLI and vCLI remote connection options Connection options when connecting through vCenter Server: --server <vcenter ipadddress> --vihost <ESXi hostname or ipaddress> Connection options when connecting directly to ESXi host: --server <ESXi hostname or ipaddress>