6.0
Table Of Contents
- vSphere Command-Line Interface Concepts and Examples
- Contents
- About This Book
- vSphere CLI Command Overviews
- Introduction
- List of Available Host Management Commands
- Targets and Protocols for vCLI Host Management Commands
- Supported Platforms for vCLI Commands
- Commands with an esxcfg Prefix
- ESXCLI Overview
- Connection Options for vCLI Host Management Commands
- Connection Options for DCLI Commands
- vCLI Host Management Commands and Lockdown Mode
- Managing Hosts
- Managing Files
- Managing Storage
- Introduction to Storage
- Examining LUNs
- Detaching Devices and Removing a LUN
- Working with Permanent Device Loss
- Managing Paths
- Managing Path Policies
- Scheduling Queues for Virtual Machine I/O
- Managing NFS/NAS Datastores
- Monitoring and Managing SAN Storage
- Monitoring and Managing Virtual SAN Storage
- Monitoring vSphere Flash Read Cache
- Monitoring and Managing Virtual Volumes
- Migrating Virtual Machines with svmotion
- Configuring FCoE Adapters
- Scanning Storage Adapters
- Retrieving SMART Information
- Managing iSCSI Storage
- iSCSI Storage Overview
- Protecting an iSCSI SAN
- Command Syntax for esxcli iscsi and vicfg-iscsi
- iSCSI Storage Setup with ESXCLI
- iSCSI Storage Setup with vicfg-iscsi
- Listing and Setting iSCSI Options
- Listing and Setting iSCSI Parameters
- Enabling iSCSI Authentication
- Setting Up Ports for iSCSI Multipathing
- Managing iSCSI Sessions
- Managing Third-Party Storage Arrays
- Managing NMP with esxcli storage nmp
- Path Claiming with esxcli storage core claiming
- Managing Claim Rules
- Managing Users
- Managing Virtual Machines
- vmware-cmd Overview
- Listing and Registering Virtual Machines
- Retrieving Virtual Machine Attributes
- Managing Virtual Machine Snapshots with vmware-cmd
- Powering Virtual Machines On and Off
- Connecting and Disconnecting Virtual Devices
- Working with the AnswerVM API
- Forcibly Stopping Virtual Machines with EXCLI
- Managing vSphere Networking
- Introduction to vSphere Networking
- Retrieving Basic Networking Information
- Network Troubleshooting
- Setting Up vSphere Networking with vSphere Standard Switches
- Setting Up Virtual Switches and Associating a Switch with a Network Interface
- Retrieving Information About Virtual Switches
- Adding and Deleting Virtual Switches
- Checking, Adding, and Removing Port Groups
- Managing Uplinks and Port Groups
- Setting the Port Group VLAN ID
- Managing Uplink Adapters
- Adding and Modifying VMkernel Network Interfaces
- Setting Up vSphere Networking with vSphere Distributed Switch
- Managing Standard Networking Services in the vSphere Environment
- Setting the DNS Configuration
- Adding and Starting an NTP Server
- Managing the IP Gateway
- Setting Up IPsec
- Managing the ESXi Firewall
- Monitoring VXLAN
- Monitoring ESXi Hosts
- Index
Getting Started with vSphere Command-Line Interfaces
14 VMware, Inc.
Targets and Protocols for vCLI Host Management Commands
MostvCLIcommandsareusedtomanageorretrieveinformationaboutoneormoreESXihosts.Theycan
targetanESXihostoravCenterServersystem.WhenyoutargetavCenterServersystem,youcanuse
--vihosttospecifytheESXihosttorunthecommandagainst.Theonlyexception
issvmotion,whichyou
canrunagainstvCenterServersystems,butnotagainstESXisystems.
ThefollowingcommandsmusthaveanESXisystem,notavCenterServersystemasatarget.
vifs
vicfg-user
vicfg-cfgbackup
vihostupdate
vmkfstools
TheresxtopcommandrequiresanHTTPSconnection.AllothercommandssupportHTTPandHTTPS.
vicfg-scsidevs esxcli storage core
device
FindsandexaminesavailableLUNs.See“ExaminingLUNs”onpage 40.
vicfg-snmp esxcli system snmp ManagestheSNMPagent.“ManagingESXiSNMPAgents”onpage 143.
UsingSNMPinavSphereenvironmentisdiscussedindetailinthevSphere
MonitoringandPerformancedocumentation.
NewoptionsaddedinvCLI5.0.
ExpandedSNMPsupportaddedinvCLI5.1.
vicfg-syslog esxcli system
syslog
SpecifieslogsettingsforESXihostsincludinglocalstoragepoliciesandserver
andportinformationfornetworklogging.See“ConfiguringESXiSyslog
Services”onpage 142.
ThevCenterServerandHostManagementdocumentationexplainshowtosetup
systemlogsusingthevSphereWebClient.
vicfg-user vicfg-user(No
ESXCLIequivalent)
Creates,modifies,deletes,
andlistslocaldirectaccessusersandgroupsof
users.See“ManagingUsers”onpage 101.
ThevSphereSecuritydocumentationdiscussessecurityimplicationsofuser
managementandcustomroles.
vicfg-vmknic esxcli network ip
interface.
Adds,deletes,andmodifiesVMkernelnetworkinterfaces.See“Addingand
ModifyingVMkernelNetworkInterfaces”onpage 125.
vicfg-volume esxcli storage
filesystem
Supportsresignaturingthecopy
ofaVMFSvolume,andmountingand
unmountingthecopy.See“ManagingDuplicateVMFSDatastores”on
page 29.
vicfg-vswitch esxcli network
vswitch
Addsorremovesvirtualswitchesormodifiesvirtualswitchsettings.See
“SettingUpVirtualSwitchesandAssociatingaSwitchwithaNetwork
Interface”onpage 117.
vifs vifs(NoESXCLI
equivalent)
Performsfilesystemoperationssuch
asretrievinganduploadingfilesonthe
ESXisystem.See“ManagingtheVirtualMachineFileSystemwith
vmkfstools”onpage 28.
vihostupdate esxclisoftware vib UpdateslegacyESXihoststoadifferentversionofthesamemajorrelease.
YoucannotrunvihostupdateagainstESXi5.0andlaterhosts.
See“ManagingVMkernelModules”onpage 24.
vmkfstools vmkfstools
(No
ESXCLIequivalent)
Createsandmanipulatesvirtualdisks,filesystems, logicalvolumes,and
physicalstoragedevicesonanESXihost.See“ManagingtheVirtualMachine
FileSystemwithvmkfstools”onpage 28.
vmware-cmd vmware-cmd(No
ESXCLIequivalent)
Performsvirtualmachineoperationsremotely.Thisincludes,forexample,
creatingasnapshot,poweringthevirtualmachineon
oroff,andgetting
informationaboutthevirtualmachine.See“ManagingVirtualMachines”on
page 105.
Table 1-2. vCLI and ESXCLI Commands (Continued)
vCLI 4.1 Command
vCLI 5.1 and later
Command Comment