Documente Academic
Documente Profesional
Documente Cultură
This document supports the version of each product listed and supports all subsequent versions until the document is replaced by a new edition. To check for more recent editions of this document, see http://www.vmware.com/support/pubs.
EN-000887-00
You can find the most up-to-date technical documentation on the VMware Web site at: http://www.vmware.com/support/ The VMware Web site also provides the latest product updates. If you have comments about this documentation, submit your feedback to: docfeedback@vmware.com
Copyright 20082012 VMware, Inc. All rights reserved. This product is protected by U.S. and international copyright and intellectual property laws. VMware products are covered by one or more patents listed at http://www.vmware.com/go/patents. VMware is a registered trademark or trademark of VMware, Inc. in the United States and/or other jurisdictions. All other marks and names mentioned herein may be trademarks of their respective companies.
VMware, Inc.
Contents
AboutThisBook
1 vSphereCLICommandOverviews 11
Introduction 11 Documentation 12 CommandLineHelp 12 ListofAvailableCommands 12 SupportedProtocolsandPlatformsforCommands 14 RunningESXCLICommandsAgainstESXi4.xHosts 16 CommandswithanesxcfgPrefix 16 UsingESXCLIOutput 17 ConnectionOptions 17 vCLIandLockdownMode 19
2 ManagingHosts 21
Stopping,Rebooting,andExaminingHosts 21 StoppingandRebootingHostswithESXCLI 21 Stopping,Rebooting,andExaminingHostswithvicfghostops 21 EnteringandExitingMaintenanceMode 22 EnteringandExitingMaintenanceModewithESXCLI 22 EnteringandExitingMaintenanceModewithvicfghostops 23 BackingUpConfigurationInformationwithvicfgcfgbackup 23 BackupTasks 23 BackingUpConfigurationData 24 RestoringConfigurationData 24 UsingvicfgcfgbackupfromvMA 24 ManagingVMkernelModules 24 ManagingModuleswithesxclisystemmodule 25 ManagingModuleswithvicfgmodule 25 UsingvicfgauthconfigforActiveDirectoryConfiguration 25 UpdatingHosts 26
3 ManagingFiles 27
IntroductiontoVirtualMachineFileManagement 27 ManagingtheVirtualMachineFileSystemwithvmkfstools 28 UpgradingVMFS3VolumestoVMFS5 29 ManagingVMFSVolumes 29 ManagingDuplicateVMFSDatastores 29 MountingDatastoreswithExistingSignatures 29 MountingandUnmountingwithESXCLI 30 MountingandUnmountingwithvicfgvolume 30 ResignaturingVMFSCopies 30 ResignaturingaVMFSCopywithESXCLI 31 ResignaturingaVMFSCopywithvicfgvolume 31 DetachingDevicesandRemovingaLUN 32 WorkingwithPermanentDeviceLoss 33
VMware, Inc.
33
4 ManagingStorage 39
IntroductiontoStorage 39 HowVirtualMachinesAccessStorage 40 Datastores 41 StorageDeviceNaming 41 ExaminingLUNs 42 TargetandDeviceRepresentation 42 ExaminingLUNswithesxclistoragecore 42 ExaminingLUNswithvicfgscsidevs 43 ManagingPaths 44 MultipathingwithLocalStorageandFCSANs 44 ListingPathInformation 45 ListingPathInformationwithESXCLI 45 ListingPathInformationwithvicfgmpath 46 ChangingtheStateofaPath 47 ChangingPathStatewithESXCLI 47 ChangingPathStatewithvicfgmpath 47 ManagingPathPolicies 47 MultipathingConsiderations 48 ChangingPathPolicies 49 ChangingPathPolicieswithESXCLI 49 ChangingPathPolicieswithvicfgmpath 49 SettingPolicyDetailsforDevicesthatUseRoundRobin 50 ManagingNFS/NASDatastores 50 CapabilitiesSupportedbyNFS/NAS 51 AddingandDeletingNASFileSystems 51 ManagingNASFileSystemswithESXCLI 51 ManagingNASFileSystemswithvicfgnas 51 MonitoringandManagingSANStorage 52 MigratingVirtualMachineswithsvmotion 52 StoragevMotionUses 52 StoragevMotionRequirementsandLimitations 53 RunningsvmotioninInteractiveMode 53 RunningsvmotioninNoninteractiveMode 53 ConfiguringFCoEAdapters 54 ScanningStorageAdapters 55 RetrievingSMARTInformation 55
5 ManagingiSCSIStorage 57
iSCSIStorageOverview 57 DiscoverySessions 58 DiscoveryTargetNames 59 ProtectinganiSCSISAN 59 ProtectingTransmittedData 59 SecuringiSCSIPorts 60 SettingiSCSICHAP 60 CommandSyntaxforesxcliiscsiandvicfgiscsi esxcliiscsiCommandSyntax 61 KeytoesxcliiscsiShortOptions 62 vicfgiscsiCommandSyntax 63
61
VMware, Inc.
Contents
iSCSIStorageSetupwithESXCLI 66 SettingUpSoftwareiSCSIwithESXCLI 66 SettingUpDependentHardwareiSCSIwithESXCLI 68 SettingUpIndependentHardwareiSCSIwithESXCLI 70 iSCSIStorageSetupwithvicfgiscsi 71 SettingUpSoftwareiSCSIwithvicfgiscsi 71 SettingUpDependentHardwareiSCSIwithvicfgiscsi 73 SettingUpIndependentHardwareiSCSIwithvicfgiscsi 74 ListingandSettingiSCSIOptions 75 ListingiSCSIOptionswithESXCLI 75 SettingMTUwithESXCLI 75 ListingandSettingiSCSIOptionswithvicfgiscsi 76 ListingandSettingiSCSIParameters 76 ListingandSettingiSCSIParameterswithESXCLI 77 ReturningParameterstoDefaultInheritance 78 ListingandSettingiSCSIParameterswithvicfgiscsi 78 ReturningParameterstoDefaultInheritance 79 EnablingiSCSIAuthentication 80 EnablingiSCSIAuthenticationwithESXCLI 80 EnablingiSCSIAuthenticationwithvicfgiscsi 81 SettingUpPortsforiSCSIMultipathing 81 ManagingiSCSISessions 82 IntroductiontoiSCSISessionManagement 82 ListingiSCSISessions 83 LoggingintoiSCSISessions 83 RemovingiSCSISessions 83
6 ManagingThirdPartyStorageArrays 85
ManagingNMPwithesxclistoragenmp 85 DeviceManagementwithesxclistoragenmpdevice 86 esxclistoragenmpdevicelist 86 esxclistoragenmpdeviceset 86 ListingPathswithesxclistoragenmppath 86 ManagingPathSelectionPolicyPluginswithesxclistoragenmppsp 86 RetrievingPSPInformation 87 SettingConfigurationParametersforThirdPartyExtensions 87 FixedPathSelectionPolicyOperations 88 RetrievingthePreferredPath 88 SettingthePreferredPath 88 CustomizingRoundRobinSetup 88 RetrievingPathSelectionSettings 89 SpecifyingConditionsforPathChanges 89 ManagingSATPs 89 RetrievingInformationAboutSATPs 89 AddingSATPRules 90 RemovingSATPRules 91 RetrievingandSettingSATPConfigurationParameters 91 PathClaimingwithesxclistoragecoreclaiming 92 UsingtheReclaimTroubleshootingCommand 92 UnclaimingPathsorSetsofPaths 92 ManagingClaimRules 93 AddingClaimRules 93 ConvertingESX3.5LUNMaskstoClaimRuleFormat 95 RemovingClaimRules 96 ListingClaimRules 96
VMware, Inc. 5
7 ManagingUsers 99
UsersinthevSphereEnvironment 99 vicfguserCommandSyntax 99 ManagingUserswithvicfguser 100 102
8 ManagingVirtualMachines 103
vmwarecmdOverview 103 ConnectionOptionsforvmwarecmd 104 GeneralOptionsforvmwarecmd 104 FormatforSpecifyingVirtualMachines 104 ListingandRegisteringVirtualMachines 104 RetrievingVirtualMachineAttributes 105 ManagingVirtualMachineSnapshotswithvmwarecmd 106 TakingVirtualMachineSnapshots 107 RevertingandRemovingSnapshots 107 PoweringVirtualMachinesOnandOff 107 ConnectingandDisconnectingVirtualDevices 108 WorkingwiththeAnswerVMAPI 109 ForciblyStoppingVirtualMachineswithEXCLI 109
9 ManagingvSphereNetworking 111
IntroductiontovSphereNetworking 111 NetworkingUsingvSphereStandardSwitches 112 NetworkingUsingvSphereDistributedSwitches 113 RetrievingBasicNetworkingInformation 113 NetworkTroubleshooting 114 SettingUpvSphereNetworkingwithvSphereStandardSwitches 115 SettingUpVirtualSwitchesandAssociatingaSwitchwithaNetworkInterface 115 RetrievingInformationAboutVirtualSwitches 116 RetrievingInformationaboutVirtualSwitcheswithESXCLI 116 RetrievingInformationaboutVirtualSwitcheswithvicfgvswitch 116 AddingandDeletingVirtualSwitches 117 AddingandDeletingVirtualSwitcheswithESXCLI 117 AddingandDeletingVirtualSwitcheswithvicfgvswitch 117 SettingSwitchAttributeswithesxclinetworkvswitchstandard 117 SettingSwitchAttributeswithvicfgvswitch 118 Checking,Adding,andRemovingPortGroups 118 ManagingPortGroupswithESXCLI 118 ManagingPortGroupswithvicfgvswitch 118 ManagingUplinksandPortGroups 119 ConnectingandDisconnectingUplinkAdaptersandPortGroupswithESXCLI 119 ConnectingandDisconnectingUplinksandPortGroupswithvicfgvswitch 119 SettingthePortGroupVLANID 119 SettingthePortGroupVLANIDwithESXCLI 119 SettingthePortGroupVLANIDwithvicfgvswitch 120 ManagingUplinkAdapters 120 ManagingUplinkAdapterswithesxclinetworknic 120 SpecifyingMultipleUplinkswithESXCLI 121
VMware, Inc.
Contents
ManagingUplinkAdapterswithvicfgnics 122 LinkingandUnlinkingUplinkAdapterswithESXCLI 122 LinkingandUnlinkingUplinkAdapterswithvicfgvswitch 122 AddingandModifyingVMkernelNetworkInterfaces 123 ManagingVMkernelNetworkInterfaceswithESXCLI 123 ManagingVMkernelNetworkInterfaceswithvicfgvmknic 124 SettingUpvSphereNetworkingwithvSphereDistributedSwitch 126 ManagingStandardNetworkingServicesinthevSphereEnvironment 126 SettingtheDNSConfiguration 126 SettingtheDNSConfigurationwithESXCLI 126 SettingtheDNSConfigurationwithvicfgdns 128 AddingandStartinganNTPServer 129 ManagingtheIPGateway 129 SettingUpIPsec 130 UsingIPsecwithESXi 130 ManagingSecurityAssociations 131 ManagingSecurityPolicies 132 ManagingtheESXiFirewall 133
10 MonitoringESXiHosts 135
UsingresxtopforPerformanceMonitoring 135 ManagingDiagnosticPartitions 135 DiagnosticPartitionCreation 136 DiagnosticPartitionManagement 136 ManagingCoreDumps 136 ManagingLocalCoreDumpswithESXCLI 136 ManagingCoreDumpswithESXiDumpCollector 137 ManagingCoreDumpswithvicfgdumppart 137 ConfiguringESXiSyslogServices 138 ManagingESXiSNMPAgents 139 ConfiguringSNMPCommunities 140 ConfiguringtheSNMPAgenttoSendTraps 140 ConfiguringtheSNMPAgentforPolling 141 RetrievingHardwareInformation 141 ESX,ESXi,andVirtualMachineLogs 142
Index 143
VMware, Inc.
Contents
VMware, Inc.
ThevSphereCommandLineInterfaceConceptsandExamplesdocumentationexplainshowtousetheVMware vSphereCommandLineInterface(vCLI)andincludescommandoverviewsandexamples.
Intended Audience
ThisbookisforexperiencedWindowsorLinuxsystemadministratorswhoarefamiliarwithvSphere administrationtasksanddatacenteroperationsandknowhowtousecommandsinscripts.
Document Feedback
VMwarewelcomesyoursuggestionsforimprovingourdocumentation.Ifyouhavecomments,sendyour feedbacktodocfeedback@vmware.com.
Related Documentation
ThevSphereCommandLineInterfaceReference,availableinthevSphereDocumentationCenter,includes referenceinformationforvicfg-commandsandESXCLIcommands. GettingStartedwithvSphereCommandLineInterfacesincludesinformationaboutavailableCLIs,enablingthe ESXiShell,andinstallingandrunningvCLIcommands.AnappendixsuppliestheESXCLInamespaceand commandhierarchies. CommandLineManagementinvSphere5forServiceConsoleUsersisforcustomerswhocurrentlyusethe ESX ServiceConsole. ThevSphereSDKforPerldocumentationexplainshowyoucanusethevSphereSDKforPerlandrelated utilityapplicationstomanageyourvSphereenvironment.ThedocumentationincludesanInstallationGuide,a ProgrammingGuide,andareferencetothevSphereSDKforPerlUtilityApplications. BackgroundinformationforthetasksdiscussedinthismanualisavailableinthevSpheredocumentationset. ThevSpheredocumentationconsistsofthecombinedvCenterServerandESXidocumentationandincludes informationaboutmanagingstorage,networkingvirtualmachines,andmore.
VMware, Inc.
Support Offerings
TofindouthowVMwaresupportofferingscanhelpmeetyourbusinessneeds,goto http://www.vmware.com/support/services.
10
VMware, Inc.
Introduction
ThevSphereCLIcommandset,availablesinceESX/ESXi3.5,allowsyoutoperformvSphereconfiguration tasksusingavCLIpackageinstalledonsupportedplatforms,orusingvMA.Thesetconsistsofseveral commandsets. Table 1-1. Components of the vSphere CLI Command Set
vCLI Commands ESXCLIcommands Description ComprehensivesetofcommandsformanagingmostaspectsofvSphere.InvSphere5.0,this commandsethasbeenunified.Eventually,ESXCLIcommandswillreplaceothercommands inthevCLIset. CompletelyequivalentESXCLIcommandsareavailableintheESXiShell.UsevCLIESXCLI commandsforasaferenvironment. vicfg- commands SetofcommandsformanyaspectsofvSphere.InvSphere5.0,onlyminorchangesweremade tothiscommandset.Eventually,thesecommandswillbereplacedbyESXCLIcommands. Asetofesxcfg-commandsthatpreciselymirrorsthevicfg-commandsisalsoincludedin thevCLIpackage. Othercommands (vmware-cmd,vifs, vmkfstools) CommandsimplementedinPerlthatdonothaveavicfg-prefix.AllvCLIcommandsare scheduledtobereplacedbyESXCLIcommands.
Documentation
GettingStartedwithvSphereCommandLineInterfacesincludesinformationaboutavailableCLIs,enablingthe ESXiShell,andinstallingandrunningvCLIcommands.Anappendixsuppliesthenamespaceandcommand hierarchiesforESXCLI. ReferenceinformationforvCLIcommandsisavailableonthevCLIdocumentationpage http://www.vmware.com/support/developer/vcli/.
Command-Line Help
Availablecommandlinehelpdiffersforthedifferentcommands.
Command set vicfgcommands Available Command-Line Help Run<vicfg-cmd> --helpforanoverviewofeachoptions. RunPod2Htmlwithavicfgcommandasinputandpipetheoutputtoafileformoredetailed helpinformation. pod2html vicfg-authconfig.pl > vicfg-authconfig.html ThisoutputcorrespondstotheinformationavailableinthevSphereCommandLineInterface Reference. ESXCLIcommands Run--helpatanylevelofthehierarchyforinformationaboutbothcommandsand namespacesavailablefromthatlevel.
resxtop
svmotion
vicfg-advcfg
vicfg-cfgbackup
12
VMware, Inc.
13
vifs
vihostupdate vihostupdate35
vmware-cmd
14
VMware, Inc.
IMPORTANTIfyourunvCLI4.xcommandsagainstESX/ESXi3.5systems,youcanuseonlytheoptions supportedbythosesystems. SeetheVMwareInfrastructureRemoteCommandLineInterfaceInstallationandReferenceGuideforESX/ESXi3.5 Update2foralistofsupportedoptions.Toaccessthatdocument,selectResources>Documentationfromthe VMwarewebsite.FindthevSpheredocumentationsetandopenthearchive.AfewvCLI4.xoptionsare supportedagainsthostsrunningESX/ESXi3.5Update2orlatereventhoughtheywerenotsupportedinRCLI version3.5. RunavCLI4.xcommandwith--helpforinformationaboutoptionsupportwithESX/ESXi3.5Update 2,or seetheVMwareknowledgebasearticleathttp://kb.vmware.com/kb/1008940formoredetail. Table 13listsplatformsupportforthedifferentvCLI5.xcommands.Thesecommandshavenotbeentested againstVirtualCenter2.5Update2systems.Youcan,however,connecttoavCenterServer4.xsystemand targetESX/ESXi3.5Update2hosts. Table 1-3. Platform Support for vCLI 5.x Commands
Command esxcli resxtop svmotion vicfg-advcfg vicfg-authconfig vicfg-cfgbackup vicfg-dns vicfg-dumppart vicfg-hostops vicfg-ipsec vicfg-iscsi vicfg-module vicfg-mpath vicfg-nas vicfg-nics vicfg-ntp vicfg-rescan vicfg-route vicfg-scsidevs vicfg-snmp vicfg-syslog vicfg-user vicfg-vmhbadevs vicfg-vmknic vicfg-volume vicfg-vswitch vifs ESXi 5.x Yes Yes(from Linux) No Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes No Yes VC 5.x Yes Yes(from Linux) Yes Yes Yes No Yes Yes Yes No Yes Yes Yes Yes Yes Yes Yes Yes Yes No Nofor5.0 target No ESXi 4.x Yes Yes(from Linux) No Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes ESX 4.x Yes Yes(from Linux) No Yes Yes No Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes No Yes VC 4.x No Yes(from Linux) Yes Yes Yes No Yes Yes Yes No Yes Yes Yes Yes Yes Yes Yes Yes Yes No Yes No ESXi 3.5 U2+ No Yes(from Linux) No Yes No Yes Yes Yes No No No Yes ESX 3.5 U2+ No Yes(from Linux) No Yes No No Yes Yes No No No Yes
Usevicfg-mpath35instead. Yes Yes Yes Yes Yes No Yes Yes Yes Yes Yes No Yes Yes Yes Yes Yes Yes Yes No Yes No Yes Yes Yes No Yes Yes
NotincludedinvCLI4.xandvCLI5.0.Usevicfg-scsidevsinstead. Yes Yes Yes Yes Yes Yes Yes No Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes No
VMware, Inc.
15
Yes Yes No No
Yes Yes No No
No Yes No No
IfyouruncommandsagainstESXi4.xhosts,ESXCLI4.xcommandsaresupported. IfyouruncommandsagainstESXi5.0hosts,ESXCLI5.0commandsaresupported.
Youspecifythetargethostwith--serverorsetupavMAtarget. Somecommandsorcommandoutputsaredeterminedbythehosttype.Inaddition,VMwarepartnersmight developcustomESXCLIcommandsthatyoucanrunonhostswherethepartnerVIBhasbeeninstalled. Runesxcli --server <target> --helpforalistofnamespacessupportedonthetarget.Youcandrill downintothenamespacesforadditionalhelp. IMPORTANTESXCLIonESX4.xhostsdoesnotsupporttargetingavCenterServersystem.Youcantherefore notrunESXCLIcommandswith--serverpointingtoavCenterServersystemevenifyouinstallvCLI5.0.
16
VMware, Inc.
ListsallfilesysteminformationinCSVformat. Youcanpipetheoutputtoafile.
esxcli --formatter=keyvalue storage filesystem list > myfilesystemlist.txt
IMPORTANTAlwaysuseaformatterforconsistentoutput.
Connection Options
Table 15listsoptionsthatareavailableforallvCLIcommandsinalphabeticalorder.Examplesinthisbook use<conn_options>toindicatethepositionofconnectionoptions. Forexample,esxcli <conn_options> filesystem nfs listmeansthatyoucoulduseaconfiguration file,asessionfile,orjustspecifyatargetserverandrespondwithausernameandpasswordwhenprompted. Thetableincludesoptionsforuseonthecommandlineandvariablesforuseinconfigurationfiles. IMPORTANTForconnections,vCLIsupportsonlytheIPv4protocol,nottheIPv6protocol.Youcan,however, configureIPv6onthetargethostwithseveralofthenetworkingcommands. SeetheGettingStartedwithvSphereCommandLineInterfacesdocumentationforadditionalinformationand examples. Table 1-5. vCLI Connection Options
Option and Environment Variable --cacertsfile <certsfile> -t <certs_file> VI_CACERTFILE=<cert_file_path> --config <cfg_file_full_path> VI_CONFIG=<cfg_file_full_path> Description ESXCLIcommandsonly. UsedtospecifytheCA(CertificateAuthority)certificatefile,inPEMformat, toverifytheidentityofthevCenterServersystemorESXisystemtorunthe commandon.Canbeused,forexample,topreventmaninthemiddleattack. Usestheconfigurationfileatthespecifiedlocation. Specifyapaththatisreadablefromthecurrentdirectory.
VMware, Inc.
17
Youcanuse--encodingtospecifytheencodingvCLIshouldmaptowhenit isrunonaforeignlanguagesystem. --passthroughauth VI_PASSTHROUGHAUTH Ifyouspecifythisoption,thesystemusestheMicrosoftWindowsSecurity SupportProviderInterface(SSPI)forauthentication.Trustedusersarenot promptedforausernameandpassword.SeetheMicrosoftWebsitefora detaileddiscussionofSSPI. ThisoptionissupportedonlyifyouarerunningvCLIonaWindowssystem andareconnectingtoavCenterServersystem. --passthroughauthpackage <package> VI_PASSTHROUGHAUTHPACKAGE= <package> Usethisoptionwith--passthroughauthtospecifyadomainlevel authenticationprotocoltobeusedbyWindows.Bydefault,SSPIusesthe Negotiateprotocol,whichmeansthatclientandservertrytonegotiatea protocolthatbothsupport. IfthevCenterServersystemtowhichyouareconnectingisconfiguredtouse aspecificprotocol,youcanspecifythatprotocolusingthisoption. ThisoptionissupportedonlyifyouarerunningvCLIonaWindowssystem andconnectingtoavCenterServersystem. --password <passwd> VI_PASSWORD=<passwd> Usesthespecifiedpassword(usedwith--username)tologintotheserver.
Usetheemptystring(' 'onLinuxand onWindows)toindicateno password. Ifyoudonotspecifyausernameandpasswordonthecommandline,the systempromptsyouanddoesnotechoyourinputtothescreen. --portnumber <number> VI_PORTNUMBER=<number> --protocol <HTTP|HTTPS> VI_PROTOCOL=<HTTP|HTTPS> --savesessionfile <file> VI_SAVESESSIONFILE=<file> --server <server> VI_SERVER=<server> Usesthespecifiedporttoconnecttothesystemspecifiedby--server. Defaultis443. Usesthespecifiedprotocoltoconnecttothesystemspecifiedby--server. DefaultisHTTPS. Savesasessiontothespecifiedfile.Thesessionexpiresifitisnotusedfor30 minutes. UsesthespecifiedESXiorvCenterServersystem.Defaultislocalhost. If--serverpointstoavCenterServersystem,youusethe--vihostoption tospecifytheESXihostonwhichyouwanttorunthecommand.Acommand issupportedforvCenterServerifthe--vihostoptionisdefined. UsesthespecifiedservicepathtoconnecttotheESXihost.Defaultis /sdk/webService. Usesthespecifiedsessionfiletoloadapreviouslysavedsession.Thesession mustbeunexpired. ConnectstothespecifiedvSphereWebServicesSDKURL.
18
VMware, Inc.
Ifyoudonotspecifyausernameandpasswordonthecommandline,the systempromptsyouanddoesnotechoyourinputtothescreen. --vihost <host> -h <host WhenyourunavSphereCLIcommandwiththe--serveroptionpointing toavCenterServersystem,use--vihosttospecifytheESXihosttorunthe commandagainst. NOTE:Thisoptionisnotsupportedforeachcommand.Ifsupported,the optionisincludedintheindividualcommandoptionlist.
Youcandisablelockdownmodeasfollows.
TomakechangestoESXisystemsinlockdownmode,youmustgothroughavCenterServersystemthat managestheESXisystemastheuservpxuser. esxcli --server MyVC --vihost MyESXi storage filesystem list ThecommandpromptsforthevCenterServersystemusernameandpassword. YoucanusethevSphereWebClientorvCLIcommandsthatsupportthe--vihostoption.Thefollowing commandscannotrunagainstvCenterServersystemsandarethereforenotavailableinlockdownmode:
VMware, Inc.
19
20
VMware, Inc.
Managing Hosts
VMware, Inc.
21
Singlehost.Runvicfg-hostopswith--operationshutdown.
Ifthehostisinmaintenancemode,runthecommandwithoutthe--forceoption.
vicfg-hostops <conn_options> --operation shutdown
Ifthehostisnotinmaintenancemode,use--forcetoshutdownthehostandallrunningvirtual machines.
vicfg-hostops <conn_options> --operation shutdown --force
Allhostsindatacenterorcluster.Toshutdownallhostsinaclusterordatacenter,specify--clusteror --datacenter.
vicfg-hostops <conn_options> --operation shutdown --cluster <my_cluster> vicfg-hostops <conn_options> --operation shutdown --datacenter <my_datacenter>
Youcanrebootasinglehostorallhostsinadatacenterorcluster.
Singlehost.Runvicfg-hostopswith--operationreboot.
Ifthehostisinmaintenancemode,runthecommandwithoutthe--forceoption.
vicfg-hostops <conn_options> --operation reboot
Ifthehostisnotinmaintenancemode,use--forcetoshutdownthehostandallrunningvirtual machines.
vicfg-hostops <conn_options> --operation reboot --force
Allhostsindatacenterorcluster.Youcanspecify--clusteror--datacentertorebootallhostsina clusterordatacenter.
vicfg-hostops <conn_options> --operation reboot --cluster <my_cluster> vicfg-hostops <conn_options> --operation reboot --datacenter <my_datacenter>
Youcandisplayinformationaboutahostbyrunningvicfg-hostopswith--operationinfo.
vicfg-hostops <conn_options> --operation info
22
VMware, Inc.
Ifyouattempttoexitmaintenancemodewhenthehostisnolongerinmaintenancemode,anerrorinforms youthatmaintenancemodeisalreadydisabled.
Backup Tasks
Duringaconfigurationbackup,theserialnumberisbackedupwiththeconfiguration.Thenumberisrestored whenyourestoretheconfiguration.ThenumberisnotpreservedwhenyouruntheRecoveryCD(ESXi Embedded)orperformarepairoperation(ESXiInstallable). Youcanbackupandrestoreconfigurationinformationasfollows. 1 2 3 Backuptheconfigurationbyusingthevicfg-cfgbackupcommand. RuntheRecoveryCDorrepairoperation Restoretheconfigurationbyusingthevicfg-cfgbackupcommand.
Whenyourestoreaconfiguration,youmustmakesurethatallvirtualmachinesonthehostarestopped.
VMware, Inc.
23
Ifyourunthefollowingcommand,youarepromptedforconfirmation.
vicfg-cfgbackup <conn_options> -l /tmp/ESXi_181842_backup.tgz
Ifyourunthefollowingcommand,youarenotpromptedforconfirmation.
vicfg-cfgbackup <conn_options> -l /tmp/ESXi_181842_backup.tgz -q
Torestorethehosttofactorysettings,runvicfg-cfgbackupwiththe-roption:
vicfg-cfgbackup <conn_options> -r
24
VMware, Inc.
Thesystemreturnsthename,type,value,anddescriptionofthemodule. 2 (Optional)Listallenabledorloadedmodules.
esxcli <conn_options> system module list --enabled=true esxcli <conn_options> system module list --loaded=true
Enablethemodel.
esxcli <conn_options> system module set --module=module_name --enabled=true
Settheparameter.
esxcli system module parameters set --module module_name --parameter-string="parameter_string"
Verifythatthemoduleisconfigured.
esxcli <conn_options> system module parameters list --module=module_name
Verifiesthatamoduleisconfigured.
VMware, Inc.
25
vicfg-authconfigallowsyoutoremotelyconfigureActiveDirectorysettingsonESXihosts.Youcanlist supportedandactiveauthenticationmechanisms,listthecurrentdomain,andjoinorpartfromanActive Directorydomain.BeforeyourunthecommandonanESXihost,youmustpreparethehost. IMPORTANTAllhoststhatjoinActiveDirectorymustalsobemanagedbyanNTPServertoavoidissueswith clockskewsandKerberostickets. To prepare ESXi hosts for Active Directory Integration 1 MakesuretheESXisystemandtheActiveDirectoryserverareusingthesametimezonebyconfiguring ESXiandADtousesameNTPserver. TheESXisystemstimezoneisalwayssettoUTC. 2 ConfiguretheESXisystemsDNStobeintheActiveDirectorydomain.
Youcanrunvicfg-authconfigtoaddthehosttothedomain.Auserwhorunsvicfg-authconfigto configureActiveDirectorysettingsmusthavetheappropriateActiveDirectorypermissions,andmusthave administrativeprivilegesontheESXihost.Youcanrunthecommanddirectlyagainstthehostoragainsta vCenterServersystem,specifyingthehostwith--vihost. To set up Active Directory 1 2 3 4 InstalltheESXihost,asexplainedinthevSphereInstallationandSetupdocumentation. InstallWindowsActiveDirectoryonaWindowsServerthatrunsWindows2000,Windows2003,or Windows2008.SeetheMicrosoftWebsiteforinstructionsandbestpractices. SynchronizetimebetweentheESXisystemandWindowsActiveDirectory(AD). TestthattheWindowsADServercanpingtheESXihostbyusingthehostname.
ping <ESX_hostname>
Runvicfg-authcofigtoaddthehosttotheActiveDirectorydomain.
vicfg-authconfig --server=<ESXi Server IP Address> --username=<ESXi Server Admin Username> --password=<ESXi Server Admin User's Password> --authscheme AD --joindomain <AD Domain Name> --adusername=<Active Directory Administrator User Name> --adpassword=<Active Directory Administrator User's Password>
YouarepromptedforausernameandpasswordfortheESXisystem.
Updating Hosts
Whenyouaddcustomdriversorpatchestoahost,theprocessiscalledanupdate.
26
VMware, Inc.
Managing Files
VMware, Inc.
27
local ethernet SCSI bre channel HBA SAN iSCSI hardware initiator LAN software initiator ethernet NIC LAN ethernet NIC LAN
VMFS
Key
physical disk
datastore VMFS fibre array VMFS iSCSI array NFS NAS appliance
virtual disk
--breaklock -B --chainConsistent -e --eagerzero -k --fix -x --lock -L --migratevirtualdisk -M --parseimage -Y --punchzero -K --snapshotdisk -I --verbose -v
28
VMware, Inc.
ManagingVMFSvolumes esxcli storage filesystem listshowsallvolumes,mountedandunmounted,thatareresolved, thatis,thatarenotsnapshotvolumes. esxcli storage filesystem unmountunmountsacurrentlymountedfilesystem.Usethiscommand forsnapshotvolumesorresolvedvolumes.
VMware, Inc.
29
Datastoreresignaturingisirreversible. TheLUNcopythatcontainstheVMFSdatastorethatyouresignatureisnolongertreatedasaLUNcopy.
30
VMware, Inc.
(Optional)Unmountthecopy.
esxcli <conn_options> storage filesystem unmount
Runtheresignaturecommand.
esxcli <conn_options> storage vmfs snapshot resignature --volume-label=<label>|--volume-uuid=<id>
Thecommandreturnstothepromptorsignalsanerror. Afterresignaturing,youmighthavetodothefollowing:
Thecommandreturnstothepromptorsignalsanerror.
VMware, Inc.
31
Detachispersistentacrossrebootsanddeviceunregistration.Anydevicethatisdetachedremains detacheduntilamanualattachoperation.Rescandoesnotbringpersistentlydetacheddevicesback online.Apersistentlydetacheddevicecomesbackintheoffstate. ESXimaintainsthepersistentinformationaboutthedevicesofflinestateevenifthedeviceis unregistered.Youcanremovethedeviceinformationbyrunningesxcli storage core device detached remove -d naa.12. 5 (Optional)Totroubleshootthedetachoperation,listalldevicesthatweredetachedmanually.
esxcli storage core device detached list
Performarescan.
esxcli <conn_options> storage core adapter rescan
Attachthedevice.
esxcli storage core device set -d naa.XXX --state=on
32
VMware, Inc.
YoucanviewdatacenteranddatastoredirectoriesfromthisrootURL.Forexample:
http://<ESXi_addr>/folder?dcPath=ha-datacenter http://<ESXi_host_name>/folder?dcPath=ha-datacente
VMware, Inc.
33
Datastorefilesanddirectories.Youhavetwochoicesforspecifyingadatastore:
Toavoidproblemswithdirectorynamesthatusespecialcharactersorspaces,enclosethepathinquotesfor bothoperatingsystems. Whenyourunvifs,youcanspecifytheoperationnameandargumentandoneofthestandardconnection options.Usealiases,symboliclinks,orwrapperscriptstosimplifytheinvocationsyntax. IMPORTANTTheconceptsofworkingdirectoryandlastdirectoryorfileoperatedonarenotsupportedwith vifs. Options vifscommandspecificoptionsallowyoutoretrieveanduploadfilesfromtheremotehostandperforma numberofotheroperations.Allvifsoptionsworkondatastorefilesordirectories.Someoptionsalsowork onhostfilesandfilesinthetempdirectory.Youmustalsospecifyconnectionoptions.
Command --copy -c <source> <target> Description Copiesafileinadatastoretoanotherlocation inadatastore.The<source>mustbearemote sourcepath,the<target>aremotetarget pathordirectory. The--forceoptionreplacesexisting destinationfiles. --dir -D <remote_dir> --force -F --get -g <remote_path> <local_path> Liststhecontentsofadatastoredirectory. Overwritesthedestinationfile.Usedwith --moveand--copy. DownloadsafilefromtheESXihosttothe machineonwhichyourunvCLI.This operationusesHTTP GET. ListsthedatacenterpathsavailableonanESXi system. Datastore Temp Datastore Temp Datastore Host Target Datastore Temp Syntax copy src_file_path dst_directory_path [force] copy src_file_path dst_file_path [force]
dir datastore_directory_path copy src_file_path dst_file_path [force] get src_dstore_file_path dst_local_file_path get src_d store_dir_path dst_local_file_path
--listdc -C
Datastore Host
34
VMware, Inc.
Command --listds -S
Description ListsthedatastorenamesontheESXisystem. Whenmultipledatacentersareavailable,use the--dc (-Z)argumenttospecifythename ofthedatacenterfromwhichyouwanttolist thedatastore. Createsadirectoryinadatastore.This operationfailsiftheparentdirectoryof dst_datastore_file_pathdoesnotexist. Movesafileinadatastoretoanotherlocation inadatastore.The<source>mustbearemote sourcepath,the<target>aremotetarget pathordirectory. The--forceoptionreplacesexisting destinationfiles.
mkdir dst_directory_path
Examples
YoucanusevifstointeractwiththeremoteESXiorvCenterServersysteminavarietyofways.Specifyone oftheconnectionoptionslistedinConnectionOptionsonpage 17inplaceof<conn_options>.The examplesillustrateuseonaLinuxsystem,usedoublequotesinsteadofsinglequoteswhenonaWindows system. Listing Remote Information
ListalldatacentersonavCenterServersystemwith--listdc,using--servertopointtothevCenter Serversystem.
vifs --server <my_vc>--username administrator --password <pswd> --listdc
ListalldatastoresonavCenterServersystemwith--listds.
vifs --server <my_vc> --username administrator --password <pswd> --dc kw-dev --listds
ListalldatastoresonanESXihostwith--listds.
vifs --server <my_ESXi> --username root --password <pswd> --listds
Listthecontentofadirectoryinadatastore.
vifs --server <my_ESXi> --username root --password <pswd>--dir '[Storage1]' vifs --server <my_ESXi> --username root --password <pswd> --dir '[Storage1] WindowsXP'
Thecommandliststhedirectorycontent.Inthisexample,thecommandliststhecontentsofavirtual machinedirectory.
Content Listing _________________ vmware-37.log
VMware, Inc.
35
Listthecontentsofoneofthedatastores.
vifs <conn_options> --dir '[osdc-cx700-02]'
Createanewdirectoryinadatastorewith--mkdir <remote_dir>.
vifs --server <my_ESXi> --username root --password <pswd> --mkdir '[Storage1] test'
Removeadirectorywith--rmdir <remote_dir>.
vifs --server <my_ESXi> --username root --password <pswd> --rmdir '[Storage1] test'.
Deleteafileontheremoteserverwith-rm <remote_path>.
vifs --server <my_ESXi> --username root --password <pswd> --rm '[Storage1] test2/testfile'
Ifthetargetfilealreadyexistsontheremoteserver,thecommandfailsunlessyouuse--force.
vifs --server <my_ESXi> --username root --password <pswd> --move '[Storage1] test/tfile2' '[Storage1] test2/tfile' --force
Createacopyofafileontheremoteserveratadifferentlocationontheremoteserver.
vifs --server <my_ESXi> --username root --password <pswd> --copy '[Storage1] test/tfile' '[Storage1] test/tfile2'
Ifthetargetfilealreadyexistsontheremoteserver,thecommandfailsunlessyouuse--force.
vifs --server <my_ESXi> --username root --password <pswd> --copy '[Storage1] test/tfile' '[Storage1] test/tfile2' --force
36
VMware, Inc.
Example Scenario
Thefollowingexamplescenarioillustratesotherusesofvifs.Specifyoneoftheconnectionoptionslistedin ConnectionOptionsonpage 17inplaceof<conn_options>. To manage files and directories on the remote ESXi system 1 Createadirectoryinthedatastore.
vifs <conn_options> --mkdir '[osdc-cx700-03] vcli_test'
Moveafileintoavirtualmachinedirectory.
vifs <conn_options> --move '[osdc-cx700-03] vcli_test/test_doc' '[osdc-cx700-03] winxpPro-sp2/test_doc
Cleanupbyremovingthefileanddirectoryyoucreatedearlier.
vifs <conn_options> --rm '[osdc-cx700-03] vcli_test/test_doc' vifs <conn_options> --rmdir '[osdc-cx700-03] vcli_test'
VMware, Inc.
37
38
VMware, Inc.
Managing Storage
IntroductiontoStorageonpage 39 ExaminingLUNsonpage 42 ManagingPathsonpage 44 ManagingPathPoliciesonpage 47 ManagingNFS/NASDatastoresonpage 50 MonitoringandManagingSANStorageonpage 52 MigratingVirtualMachineswithsvmotiononpage 52 ConfiguringFCoEAdaptersonpage 54 ScanningStorageAdaptersonpage 55 RetrievingSMARTInformationonpage 55
Introduction to Storage
FibreChannelSANarrays,iSCSISANarrays,andNASarraysarewidelyusedstoragetechnologiessupported byVMwarevSpheretomeetdifferentdatacenterstorageneeds.Thestoragearraysareconnectedtoand sharedbetweengroupsofserversthroughstorageareanetworks.Thisarrangementallowsaggregationofthe storageresourcesandprovidesmoreflexibilityinprovisioningthemtovirtualmachines.
VMware, Inc.
39
server group 1
server group 2
server group 3
ESX/ESXi
local ethernet SCSI bre channel HBA SAN iSCSI hardware initiator LAN software initiator ethernet NIC LAN ethernet NIC LAN
VMFS
Key
physical disk
datastore VMFS fibre array VMFS iSCSI array NFS NAS appliance
virtual disk
40
VMware, Inc.
YoucanusevCLIcommandstomanagethevirtualmachinefilesystemandstoragedevices.
LUNs.Useesxcli storage coreorvicfg-scsidevscommandstodisplayavailableLUNsand mappingsforeachVMFSvolumetoitscorrespondingpartition.SeeExaminingLUNsonpage 42. Pathmanagement.Useesxcli storage coreorvicfg-mpathcommandstolistinformationabout FibreChanneloriSCSILUNsandtochangeapathsstate.SeeManagingPathsonpage 44.Usethe ESXCLIcommandtoviewandmodifypathpolicies.SeeManagingPathPoliciesonpage 47. Rescan.Useesxcli storage coreorvicfg-rescanadapter rescantoperformarescan operationeachtimeyoureconfigureyourstoragesetup.SeeScanningStorageAdapterson page 55.
Storagedevices.Severalcommandsmanageonlyspecificstoragedevices.
Datastores
ESXihostsusestoragespaceonavarietyofphysicalstoragesystems,includinginternalandexternaldevices andnetworkedstorage.Ahostcandiscoverstoragedevicestowhichithasaccessandformatthemas datastores.Eachdatastoreisaspeciallogicalcontainer,analogoustoafilesystemonalogicalvolume,where thehostplacesvirtualdiskfilesandothervirtualmachinefiles.Datastoreshidespecificsofeachstorage productandprovideauniformmodelforstoringvirtualmachinefiles. Dependingonthetypeofstorageyouuse,datastorescanbebackedbythefollowingfilesystemformats:
VMware, Inc.
41
Examining LUNs
ALUN(LogicalUnitNumber)isanidentifierforadiskvolumeinastoragearraytarget.
storage array
storage array
Listalllogicaldevicesknownonthissystemwithdetailedinformation.
esxcli <conn_options> storage core device list
... Attached Filters: VAAI Status: unsupported VAAI Plugin Name: Other UIDs: vml.0005000000766d686261303a303a30
Listaspecificlogicaldevicewithitsdetailedinformation.
esxcli <conn_options> storage core device list -d mpx.vmhba32:C0:T1:L0
Listalldeviceuniqueidentifiers.
esxcli <conn_options> storage core device list
ThecommandliststheprimaryUIDforeachdevice(naa.xxxorotherprimaryname)andanyotherUIDs foreachUID(VMLname).Youcanspecify--devicetoonlylistinformationforaspecificdevice.
PrintmappingsforVMFSvolumestothecorrespondingpartition,pathtothatpartition,VMFSUUID, extentnumber,andvolumenames.
esxcli <conn_option> storage filesystem list
PrintHBAdeviceswithidentifyinginformation.
esxcli <conn_options> storage core adapter list
ThereturnvalueincludesadapterandUIDinformation.
PrintamappingbetweenHBAsandthedevicesitprovidespathsto.
esxcli <conn_options> storage core path list
Listalllogicaldevicesknownonthissystemwithdetailedinformation.
vicfg-scsidevs <conn_options> --list
VMware, Inc.
43
Listalllogicaldeviceswithabbreviatedinformation.
vicfg-scsidevs <conn_options> --compact-list
TheinformationincludesthedeviceID,devicetype,size,plugin,anddevicedisplayname.
Listalldeviceuniqueidentifiers.
vicfg-scsidevs <conn_options> --uids
ThecommandliststheprimaryUIDforeachdevice(naa.xxxorotherprimaryname)andanyotherUIDs foreachUID(VMLname).Youcanspecify--devicetoonlylistinformationforaspecificdevice.
Listaspecificlogicaldevicewithitsdetailedinformation.
vicfg-scsidevs <conn_options> -l -d mpx.vmhba32:C0:T1:L0
PrintmappingsforVMFSvolumestothecorrespondingpartition,pathtothatpartition,VMFSuuid, extentnumber,andvolumenames.
vicfg-scsidevs <conn_options> --vmfs
PrintHBAdeviceswithidentifyinginformation.
vicfg-scsidevs <conn_options> --hbas
ThereturnvalueincludestheadapterID,driverID,adapterUID,PCI,vendor,andmodel.
PrintamappingbetweenHBAsandthedevicesitprovidespathsto.
vicfg-scsidevs <conn_options> --hba-device-list
Managing Paths
TomaintainaconstantconnectionbetweenanESXihostanditsstorage,ESXisupportsmultipathing.With multipathingyoucanusemorethanonephysicalpathfortransferringdatabetweentheESXihostandthe externalstoragedevice. IncaseoffailureofanelementintheSANnetwork,suchasanHBA,switch,orcable,theESXihostcanfail overtoanotherphysicalpath.Onsomedevices,multipathingalsooffersloadbalancing,whichredistributes I/Oloadsbetweenmultiplepathstoreduceoreliminatepotentialbottlenecks. ThestoragearchitectureinvSphere4.0andlatersupportsaspecialVMkernellayer,PluggableStorage Architecture(PSA).ThePSAisanopenmodularframeworkthatcoordinatesthesimultaneousoperationof multiplemultipathingplugins(MPPs).YoucanmanagePSAusingESXCLIcommands.SeeManaging ThirdPartyStorageArraysonpage 85.ThissectionassumesyouareusingonlyPSApluginsincludedin vSpherebydefault.
44
VMware, Inc.
HBA2
HBA1
HBA3
HBA4
switch
switch
SP1
SP2
storage array
Listpathinformationwithvicfg-mpathoresxcli storage core path.SeeListingPathInformation onpage 45. Changepathstatewithvicfg-mpathoresxcli storage core path.SeeChangingtheStateofaPath onpage 47. IMPORTANTUseESXCLIforESXi5.0.Usevicfg-mpathforESX/ESXi4.0orlater.Usevicfg-mpath35 forESX/ESXi3.5.
ChangepathpolicieswithESXCLI.SeeSettingPolicyDetailsforDevicesthatUseRoundRobinon page 50. MaskpathswithESXCLI.SeethevSphereStoragedocumentation. Manipulatetherulesthatmatchpathstomultipathingpluginstonewlydiscovereddeviceswithesxcli claimrule.SeeManagingClaimRulesonpage 93. Runorrerunclaimrulesorunclaimpaths.SeeManagingClaimRulesonpage 93. Rescanwithvicfg-rescan.SeeScanningStorageAdaptersonpage 55.
VMware, Inc.
45
Listalldeviceswiththeircorrespondingpaths,stateofthepath,adaptertype,andotherinformation.
esxcli <conn_options> storage core path list
Limitthedisplaytoonlyaspecifiedpathordevice.
esxcli <conn_options> storage core path list --path <path> esxcli <conn_options> storage core path list --device <device>
ListthestatisticsfortheSCSIpathsinthesystem.Youcanlistallpathsorlimitthedisplaytoaspecific path.
esxcli <conn_options> storage core path stats get esxcli <conn_options> storage core path stats get --path <path
Listdetailedinformationforthepathsforthedevicespecifiedwith--device.
esxcli <conn_options> storage core path list -d <naa.xxxxxx>
Listalladapters.
esxcli <conn_options> storage core adapter list
Rescanalladapters.
esxcli <conn_options> storage core adapter rescan
Listalldeviceswiththeircorrespondingpaths,stateofthepath,adaptertype,andotherinformation.
vicfg-mpath <conn_options> --list-paths
Displayashortlistingofallpaths.
vicfg-mpath <conn_options> --list-compact
Listallpathswithadapteranddevicemappings.
vicfg-mpath <conn_options> --list-map
Listpathsanddetailedinformationbyspecifyingthepathruntimename.
vicfg-mpath <conn_options> -l -P vmhba32:C0:T0:L0
Thereturninformationincludestheruntimename,device,devicedisplayname,adapter,adapter identifier,targetidentifier,plugin,state,transport,andadapterandtargettransportdetails.
Listdetailedinformationforthepathsforthedevicespecifiedwith--device.
vicfg-mpath <conn_options> -l -d mpx.vmhba32:C0:T1:L0 vicfg-mpath <conn_options> --list --device naa.60060...
46
VMware, Inc.
Thedisplayincludesinformationabouteachpathsstate. 2 SetthestateofaLUNpathtooff.
esxcli <conn_options> storage core path set --state off --path vmhba32:C0:T1:L0
Whenyouareready,setthepathstatetoactiveagain.
esxcli <conn_options> storage core path set --state active --path vmhba32:C0:T1:L0
Thedisplayincludesinformationabouteachpathsstate. 2 SetthestateofaLUNpathtooff.
vicfg-mpath <conn_options> --state off --path vmhba32:C0:T1:L0
Whenyouareready,setthepathstatetoactiveagain.
vicfg-mpath <conn_options> --state active --path vmhba32:C0:T1:L0
VMware, Inc.
47
VMW_PSP_RR
RoundRobin
Nofailback.
Multipathing Considerations
Thefollowingconsiderationshelpyouwithmultipathing:
IfnoSATPisassignedtothedevicebytheclaimrules,thedefaultSATPforiSCSIorFCdevicesis VMW_SATP_DEFAULT_AA.ThedefaultPSPisVMW_PSP_FIXED. WhenthesystemsearchestheSATPrulestolocateaSATPforagivendevice,itsearchesthedriverrules first.Ifthereisnomatch,thevendor/modelrulesaresearched,andfinallythetransportrulesare searched.Ifnomatchoccurs,NMPselectsadefaultSATPforthedevice. IfVMW_SATP_ALUAisassignedtoaspecificstoragedevice,butthedeviceisnotALUAaware,noclaim rulematchoccursforthisdevice.ThedeviceisclaimedbythedefaultSATPbasedonthedevices transporttype. ThedefaultPSPforalldevicesclaimedbyVMW_SATP_ALUAisVMW_PSP_MRU.TheVMW_PSP_MRUselectsan active/optimizedpathasreportedbytheVMW_SATP_ALUA,oranactive/unoptimizedpathifthereis noactive/optimizedpath.Thispathisuseduntilabetterpathisavailable(MRU).Forexample,ifthe VMW_PSP_MRUiscurrentlyusinganactive/unoptimizedpathandanactive/optimizedpathbecomes available,theVMW_PSP_MRUwillswitchthecurrentpathtotheactive/optimizedone.
48
VMware, Inc.
Retrievethelistofpathselectionpoliciesonthesystemtoseewhichvaluesarevalidforthe--pspoption whenyousetthepathpolicy.
esxcli storage core plugin registration list --plugin-class="PSP"
Setthepathpolicyusingesxcli.
esxcli <conn_options> storage nmp device set --device naa.xxx --psp VMW_PSP_RR
Ifnecessary,changethepreferredpath.
esxcli <conn_options> storage nmp psp fixed deviceconfig set --device naa.xxx --path vmhba3:C0:T5:L3
Thecommandsetsthepreferredpathtovmhba3:C0:T5:L3.Runthecommandwith--defaultto clearthepreferredpathselection.
VMware, Inc.
49
Ifnecessary,changethepreferredpath.
esxcli <conn_options> storage nmp psp fixed deviceconfig set --device naa.xxx --path vmhba3:C0:T5:L3
Thecommandsetsthepreferredpathtovmhba3:C0:T5:L3
Setthepathselection.Youcanspecifywhenthepathshouldchange,andwhetherunoptimizedpaths shouldbeincluded.
Use--bytesor--iopstospecifywhenthepathshouldchange,asinthefollowingexamples:
esxcli <conn_options> storage nmp psp roundrobin deviceconfig set --type "bytes" -B 12345 --device naa.xxx
Setsthedevicespecifiedby--devicetoswitchtothenextpatheachtime12345byteshavebeensent alongthecurrentpath.
esxcli <conn_options> storage nmp psp roundrobin deviceconfig set --type=iops --iops 4200 --device naa.xxx
Setsthedevicespecifiedby--devicetoswitchafter4200I/Ooperationshavebeenperformedona path.
50
VMware, Inc.
DeleteoneoftheNASfilesystems.
esxcli <conn_options> storage nfs remove --volume-name=FileServerHome2
ThiscommandunmountstheNASfilesystemandremovesitfromthelistofknownfilesystems.
VMware, Inc.
51
ForeachNASfilesystem,thecommandliststhemountname,sharename,andhostnameandwhether thefilesystemismounted.IfnoNASfilesystemsareavailable,thesystemreturnsthefollowingmessage:
No NAS datastore found
AddanewNASfilesystemtotheESXihost.
vicfg-nas <conn_options --add nfsstore-dir42
DeleteoneoftheNASfilesystems.
vicfg-nas <conn_options> -d FileServerHome1
ThiscommandunmountstheNASfilesystemandremovesitfromthelistofknownfilesystems.
ClearallI/ODeviceManagementeventsforthespecifiedadapter.
esxcli storage san fc events clear --adapter adapter
UpgradeESXiwithoutvirtualmachinedowntimeinsituationswherevirtualmachinedisksmustbe movedtosharedstoragetoallowmigrationwithvMotion.
VMware, Inc.
52
ForESXi5.0hosts,youcanmigratevirtualmachinesthathavesnapshots.ForearlierversionsofESXi,you cannotmigratevirtualmachinesthathavesnapshots. Virtualmachinedisksmustbeinpersistentmodeorberawdevicemappings(RDMs).Forphysicaland virtualcompatibilitymodeRDMs,youcanmigratethemappingfileonly.Forvirtualcompatibilitymode RDMs,youcanusethevSphereWebClienttoconverttothickprovisionedorthinprovisioneddisks duringmigrationaslongasthedestinationisnotanNFSdatastore.Youcannotusethesvmotion commandtoperformthisconversion. ThehostonwhichthevirtualmachineisrunningmusthavealicensethatincludesStoragevMotion. ESX/ESXi3.5hostsmustbelicensedandconfiguredforvMotion.ESX/ESXi4.0andlaterhostsdonot requirevMotionconfigurationtoperformmigrationwithStoragevMotion. Thehostthevirtualmachineisrunningonmusthaveaccesstoboththesourceandtargetdatastores. AparticularhostcanbeinvolvedinuptofourmigrationswithvMotionorStoragevMotionatonetime. SeeLimitsonSimultaneousMigrationsinthevCenterServerandHostManagementdocumentationfor details.
IfyouusethevSphereWebClientformigrationwithsvmotion,thesystemperformsseveralcompatibility checks.ThesechecksarenotsupportedbythesvmotionvCLIcommand.
Whenyouuse--interactive,allotheroptionsareignored. IMPORTANTWhenrespondingtotheprompts,usequotesaroundinputstringswithspecialcharacters.
VMware, Inc.
53
The--disksoptionrelocatesindividualvirtualdiskstodifferentdatastores.The--disksoptionrequiresthe currentvirtualdiskdatastorepathasanoption.SeeTodeterminethepathtothevirtualmachine configurationfileanddiskfileonpage 54. To determine the path to the virtual machine configuration file and disk file 1 Runvmware-cmd -ltolistallvirtualmachineconfigurationfiles(VMXfiles).
vmware-cmd -H <vc_server> -U <login_user> -P <login_password> -h <esx_host> -l
ChoosetheVMXfileforthevirtualmachineofinterest. Bydefault,thevirtualdiskfilehasthesamenameastheVMXfilebuthasa.vmdkextension.
(Optional)UsevifstoverifythatyouareusingthecorrectVMDKfile.
TheexampleisforWindows.UsesinglequotesonLinux. To relocate a virtual machines configuration file, but leave virtual disks 1 2 Determinethepathtothevirtualdiskfilesandthevirtualmachineconfigurationfile. Runsvmotion,forexample:
svmotion <conn_options> --datacenter='My DC' --vm='[old_datastore] myvm/myvm.vmx:new_datastore' --disks='[old_datastore] myvm/myvm_1.vmdk:old_datastore, [old_datastore] myvm/myvm_2.vmdk: old_datastore'
54
VMware, Inc.
vicfg-rescansupportsonlyasimplerescanoperationonaspecifiedadapter.
Thecommandreturnsanindicationofsuccessorfailure,butnodetailedinformation.
WhatthecommandreturnsdependsonthelevelofSMARTinformationthatthedevicesupports.Ifno informationisavailableforaparameter,theoutputdisplaysN/A,asinthefollowingsampleoutput.
Parameter Value Threshold Worst ----------------------------------------------------Health Status OK N/A N/A Media Wearout Indicator N/A N/A N/A Write Error Count N/A N/A N/A Read Error Count 119 6 74 Power-on Hours 57 0 57 Power Cycle Count 100 20 100 Reallocated Sector Count 100 36 100 Raw Read Error Rate 119 6 74 Drive Temperature 38 0 49 Driver Rated Max Temperature 62 45 51 Write Sectors TOT Count 200 0 200 Read Sectors TOT Count 100 0 253 Initial Bad Block Count N/A N/A N/A
VMware, Inc.
55
56
VMware, Inc.
53
iSCSIStorageOverviewonpage 57 ProtectinganiSCSISANonpage 59 CommandSyntaxforesxcliiscsiandvicfgiscsionpage 61 iSCSIStorageSetupwithESXCLIonpage 66 iSCSIStorageSetupwithvicfgiscsionpage 71 ListingandSettingiSCSIOptionsonpage 75 ListingandSettingiSCSIParametersonpage 76 EnablingiSCSIAuthenticationonpage 80 SettingUpPortsforiSCSIMultipathingonpage 81 ManagingiSCSISessionsonpage 82
SeethevSphereStoragedocumentationforadditionalinformation.
SeethevSphereStoragedocumentationfordetailsonsetupandfailoverscenarios.
VMware, Inc.
57
ThehostontheleftusesanindependenthardwareiSCSIadaptertoconnecttotheiSCSIstoragesystem. ThehostontherightusessoftwareiSCSI.
IP network
SP
iSCSI storage
Discovery Sessions
AdiscoverysessionispartoftheiSCSIprotocol.Thediscoverysessionreturnsthesetoftargetsthatyoucan accessonaniSCSIstoragesystem.ESXisystemssupportdynamicandstaticdiscovery.
Dynamicdiscovery.AlsoknownasSendTargetsdiscovery.EachtimetheESXihostcontactsaspecified iSCSIstorageserver,itsendsaSendTargetsrequesttotheserver.Inresponse,theiSCSIstorageserver suppliesalistofavailabletargetstotheESXihost.Monitorandmanagewithesxcli iscsi adapter discovery sendtargetorvicfg-iscsicommands. Staticdiscovery.TheESXihostdoesnothavetoperformdiscovery.Instead,theESXihostusestheIP addressesordomainnamesandiSCSItargetnames(IQNorEUIformatnames)tocommunicatewiththe iSCSItarget.Monitorandmanagewithesxcli iscsi adapter discovery statictargetor vicfg-iscsicommands.
58
VMware, Inc.
TheIQNnameusesthefollowingformat:
iqn.yyyy-mm.{reversed domain name}:id_string
VMware, Inc.
59
chapPreferred
60
VMware, Inc.
esxcli iscsi adapter auth chap [get|set] esxcli iscsi adapter discovery sendtarget auth chap [get|set] esxcli iscsi adapter target portal auth chap [get|set]
Inheritanceisrelevantonlyifyouwanttoreturnadynamicdiscoveryaddressorastaticdiscoverytargetto itsinheritedvalue.Inthatcase,useoneofthefollowingcommands:
Dynamicdiscovery:esxcli iscsi adapter discovery sendtarget auth chap set --inherit Staticdiscovery:esxcli iscsi adapter target portal auth chap set --inherit.
VMware, Inc.
61
62
VMware, Inc.
-A --authentication -c <level> -m <auth_method> -b -v <ma_username> -x <ma_password> [-i <stor_ip_addr|stor_hostname> [:<portnum>] [-n <iscsi_name>]] <adapter_name> --level <level> --method <auth_method> --mutual --mchap_username <ma_username> --mchap_password <ma_password> [--ip <stor_ip_addr|stor_hostname> [:<portnum>] [--name <iscsi_name>]] <adapter_name> -A --authentication -c <level> -m <auth_method> -u <auth_u_name> -w <a_password> [-i <stor_ip_addr|stor_hostname> [:<portnum>] [-n <iscsi_name>]] <adapter_name> --level <level> --method <auth_method> --chap_password <auth_u_name> --chap_username <chap_password> [--ip <stor_ip_addr|stor_hostname> [:<portnum>] [--name <iscsi_name>]] <adapter_name> -A --authentication -l <adapter_name> --list <adapter_name> -D --discovery -a -i <stor_ip_addr|stor_hostname[:<portnum>] <adapter_name> --add --ip <stor_ip_addr|stor_hostname> [:<portnum>] <adapter_name> -D --discovery -l <adapter_name> --list <adapter_name> -D --discovery -r -i <stor_ip_addr|stor_hostname>[:<portnum>] <adapter_name> --remove --ip <stor_ip_addr|stor_hostname> [:<portnum>] <adapter_name> -H -l [<adapter_name>] --list [<adapter_name>] -L --lun -l <adapter_name> --list <adapter_name> ListsLUNinformation. ListsalliSCSIadaptersora specifiedadapter. Removesadynamicdiscovery address. Listsdynamicdiscovery addresses. Addsadynamicdiscovery address. Listssupportedauthentication methods. Enablesauthenticationusingthe specifiedoptions. Enablesmutualauthentication. Youmustenableauthentication beforeyoucanenablemutual authentication.
VMware, Inc.
63
64
VMware, Inc.
-S --static -a -i <stor_ip_addr|stor_hostname> [:<portnum>] -n <target_name> <adapter_name> --add --ip <stor_ip_addr|stor_hostname> [:<portnum>] -name <target_name> <adapter_name> -P --phba -l <adapter_name> --list <adapter_name> -T --target -l <adapter_name> --list <adapter_name> -W parameter -l [-i <stor_ip_addr|stor_hostname> [:<portnum>] [-n <iscsi_name]] <adapter_name> --list [--ip <stor_ip_addr|stor_hostname> [:<portnum>] [--name <iscsi_name]] <adapter_name> -W parameter -l -k [-i <stor_ip_addr|stor_hostname> [:<portnum>] [-n <iscsi_name]] <adapter_name> --list --detail [--ip <stor_ip_addr|stor_hostname> [:<portnum>] [--name <iscsi_name]] <adapter_name> -W parameter -W -j <name>=<value> -i <stor_ip_addr|stor_hostname> [:port_num>] [-n <iscsi_name>]] <adapter_name> --parameter --set <name>=<value> --ip <stor_ip_addr|stor_hostname> [:port_num>] [--name <iscsi_name>]] <adapter_name> -W parameter -W -o <param_name> -i <stor_ip_addr|stor_hostname> [:port_num>] [-n <iscsi_name>]] <adapter_name> -parameter --reset <param_name> -ip <stor_ip_addr|stor_hostname> [:port_num>] [-name <iscsi_name>]] <adapter_name> -z --reset_auth -a -z -m <auth_method> -b [-i <stor_ip_addr|stor_hostname> [:<portnum>] [-n <iscsi_name>]] <adapter_name> --authentication --reset_auth --method <auth_method> [--ip <stor_ip_addr|stor_hostname> [:<portnum>] [--name <iscsi_name>]] <adapter_name> Resetstargetlevelauthentication propertiestobeinheritedfrom adapterlevel.Usedwiththe --authenticationoption. Returnsparametersindiscovery targetorsendtargettodefault inheritancebehavior. SetsiSCSIparameters. ListsiSCSIparameterdetails. ListsiSCSIparameter information. Liststargetinformation. Listsexternal,vendorspecific propertiesofaniSCSIadapter. Addsastaticdiscoveryaddress.
VMware, Inc.
65
Checkwhetheranetworkportal,thatis,aboundport,existsforiSCSItraffic.
esxcli <conn_options> iscsi adapter list
Ifnoadapterexists,addone.SoftwareiSCSIdoesnotrequireportbinding,butrequiresthatatleastone VMkernelNICisavailableandcanbeusedasaniSCSINIC.Youcannametheadapterasyouaddit.
esxcli <conn_options> iscsi networkportal add -n <portal_name> -A <vmhba>
(Optional)Checkthestatus.
esxcli <conn_options> iscsi software get
ThesystemprintstrueifsoftwareiSCSIisenabled,orfalseifitisnotenabled. 5 (Optional)SettheiSCSInameandalias.
esxcli <conn_options> iscsi adapter set --adapter=<iscsi adapter> --name=<name> esxcli <conn_options> iscsi adapter set --adapter=<iscsi adapter> --alias=<alias>
Addadynamicdiscoveryaddressorastaticdiscoveryaddress. Thetwotypesoftargetdifferasfollows:
Withdynamicdiscovery,allstoragetargetsassociatedwithahostnameorIPaddressarediscovered. Yourunthefollowingcommand.
esxcli <conn_options> iscsi adapter discovery sendtarget add --address=<ip/dns[:port]> --adapter=<adapter_name>
Withstaticdiscovery,youmustspecifythehostnameorIPaddressandtheiSCSInameofthestorage target.Yourunthefollowingcommand.
esxcli <conn_options> iscsi adapter discovery statictarget add --address=<ip/dns[:port]> --adapter=<adapter_name> --name=<target_name>
66
VMware, Inc.
Adapterlevel CHAP
esxcli iscsi adapter auth chap set --direction=uni --chap_username=<name> --chap_password=<pwd> --level=[prohibited, discouraged, preferred, required] --secret=<string> --adapter=<vmhba> esxcli iscsi adapter discovery sendtarget auth chap set --direction=uni --chap_username=<name> --chap_password=<pwd> --level=[prohibited, discouraged, preferred, required] --secret=<string> --adapter=<vmhba> --address<sendtarget_address> esxcli iscsi adapter target portal auth chap set --direction=uni --chap_username=<name> --chap_password=<pwd> --level=[prohibited, discouraged, preferred, required] --secret=<string> --adapter=<vmhba> --name<iscsi_iqn_name>
Discoverylevel CHAP
Targetlevel CHAP
(Optional)SettheauthenticationinformationformutualCHAPbyrunningesxcli iscsi adapter auth chap set againwith--directionsettomutualandadifferentauthenticationusernameand secret. Adapterlevel CHAP
esxcli iscsi adapter auth chap set --direction=mutual --mchap_username=<name2> --mchap_password=<pwd2> --level=[prohibited required] --secret=<string2> --adapter=<vmhba> esxcli iscsi adapter discovery sendtarget auth chap set --direction=mutual --mchap_username=<name2> --mchap_password=<pwd2> --level=[prohibited, required] --secret=<string2> --adapter=<vmhba> --address=<sendtarget_address> eesxcli iscsi adapter target portal auth chap set --direction=mutual --mchap_username=<nam2e> --mchap_password=<pwd2> --level=[prohibited required] --secret=<string2> --adapter=<vmhba> --name=<iscsi_iqn_name>
Discoverylevel CHAP
Targetlevel CHAP
SeeListingandSettingiSCSIParametersonpage 76 10 Aftersetupiscomplete,performrediscoveryandrescanallstoragedevices.Forexample:
esxcli <conn_options> iscsi adapter discovery rediscover esxcli <conn_options> storage core adapter rescan --adapter=vmhba36
VMware, Inc.
67
11
(Optional)IfyouwanttomakeadditionaliSCSIloginparameterchanges(seeListingandSettingiSCSI Parametersonpage 76),youmustlogoutofthecorrespondingiSCSIsessionandlogbackin. a b Runesxcli iscsi session removetologout. Runesxcli iscsi session addorrescantheadaptertoaddthesessionback.
(Optional)SettheiSCSInameandalias.
esxcli <conn_options> iscsi adapter set --adapter <adapter_name> --name=<name> esxcli <conn_options> iscsi adapter set --adapter <adapter_name> --alias=<alias>
Setupportbindingbyfollowingthesesteps: a IdentifytheVMkernelportofthedependenthardwareiSCSIadapter.
esxcli <conn_options> iscsi logicalnetworkportal list --adapter=<adapter_name>
ConnectthedependenthardwareiSCSIinitiatortotheiSCSIVMkernelportsbyrunningthe followingcommandforeachport.
esxcli <conn_options> iscsi networkportal add --nic=<bound_vmknic> --adapter=<iscsi_adapter>
VerifythattheportswereaddedtothedependenthardwareiSCSIinitiator.
esxcli <conn_options> iscsi physicalnetworkportal list --adapter=<adapter_name>
Addadynamicdiscoveryaddressorastaticdiscoveryaddress. Thetwotypesoftargetdifferasfollows:
Withdynamicdiscovery,allstoragetargetsassociatedwithahostnameorIPaddressarediscovered. Yourunthefollowingcommand.
esxcli <conn_options> iscsi adapter discovery sendtarget add --address=<ip/dns[:port]> --adapter=<adapter_name>
Withstaticdiscovery,youmustspecifythehostnameorIPaddressandtheiSCSInameofthestorage target.Yourunthefollowingcommand.
esxcli <conn_options> iscsi adapter discovery statictarget add --address=<ip/dns[:port]> --adapter=<adapter_name> --name=<target_name>
68
VMware, Inc.
Adapterlevel CHAP
esxcli iscsi adapter auth chap set --direction=uni --chap_username=<name> --chap_password=<pwd> --level=[prohibited, discouraged, preferred, required] --secret=<string> --adapter=<vmhba> esxcli iscsi adapter discovery sendtarget auth chap set --direction=uni --chap_username=<name> --chap_password=<pwd> --level=[prohibited, discouraged, preferred, required] --secret=<string> --adapter=<vmhba> --address<sendtarget_address> esxcli iscsi adapter target portal auth chap set --direction=uni --chap_username=<name> --chap_password=<pwd> --level=[prohibited, discouraged, preferred, required] --secret=<string> --adapter=<vmhba> --name<iscsi_iqn_name>
Discoverylevel CHAP
Targetlevel CHAP
(Optional)SettheauthenticationinformationformutualCHAPbyrunningesxcli iscsi adapter auth chap set againwith--directionsettomutualandadifferentauthenticationusernameand secret. Adapterlevel CHAP
esxcli iscsi adapter auth chap set --direction=mutual --mchap_username=<name> --mchap_password=<pwd> --level=[prohibited required] --secret=<string2> --adapter=<vmhba> esxcli iscsi adapter discovery sendtarget auth chap set --direction=mutual --mchap_username=<name> --mchap_password=<pwd> --level=[prohibited, required] --secret=<string2> --adapter=<vmhba> --address=<sendtarget_address> esxcli iscsi adapter target portal auth chap set --direction=mutual --mchap_username=<name> --mchap_password=<pwd> --level=[prohibited required] --secret=<string2> --adapter=<vmhba> --name=<iscsi_iqn_name>
Discoverylevel CHAP
Targetlevel CHAP
SeeListingandSettingiSCSIParametersonpage 76 8 Aftersetupiscomplete,performrediscoveryandrescanallstoragedevices.Forexample:
esxcli <conn_options> iscsi adapter discovery rediscover esxcli <conn_options> storage core adapter rescan --adapter=vmhba36
VMware, Inc.
69
(Optional)IfyouwanttomakeadditionaliSCSIloginparameterchanges(seeListingandSettingiSCSI Parametersonpage 76),youmustlogoutofthecorrespondingiSCSIsessionandlogbackin. a b Runesxcli iscsi session removetologout. Runesxcli iscsi session addorrescantheadaptertoaddthesessionback.
(Optional)SettheiSCSInameandalias.
esxcli <conn_options> iscsi adapter set --adapter <adapter_name> --name=<name> esxcli <conn_options> iscsi adapter set --adapter <adapter_name> --alias=<alias>
Addadynamicdiscoveryaddressorastaticdiscoveryaddress. Thetwotypesoftargetdifferasfollows:
Withdynamicdiscovery,allstoragetargetsassociatedwithahostnameorIPaddressarediscovered. Yourunthefollowingcommand.
esxcli <conn_options> iscsi adapter discovery sendtarget add --address=<ip/dns[:port]> --adapter=<adapter_name>
Withstaticdiscovery,youmustspecifythehostnameorIPaddressandtheiSCSInameofthestorage target.Yourunthefollowingcommand.
esxcli <conn_options> iscsi adapter discovery statictarget add --address=<ip/dns[:port]>
70
VMware, Inc.
Adapterlevel CHAP
esxcli iscsi adapter auth chap set --direction=uni --chap_username=<name> --chap_password=<pwd> --level=[prohibited, discouraged, preferred, required] --secret=<string> --adapter=<vmhba> esxcli iscsi adapter discovery sendtarget auth chap set --direction=uni --chap_username=<name> --chap_password=<pwd> --level=[prohibited, discouraged, preferred, required] --secret=<string> --adapter=<vmhba> --address<sendtarget_address> esxcli iscsi adapter target portal auth chap set --direction=uni --chap_username=<name> --chap_password=<pwd> --level=[prohibited, discouraged, preferred, required] --secret=<string> --adapter=<vmhba> --name<iscsi_iqn_name>
Discoverylevel CHAP
Targetlevel CHAP
EnablesoftwareiSCSIfortheHBA.
vicfg-iscsi <conn_options> --swiscsi --enable
VMware, Inc.
71
(Optional)Checkthestatus.
vicfg-iscsi <conn_options> --swiscsi --list
Addadynamicdiscoveryaddressorastaticdiscoveryaddress. Thetwotypesoftargetdifferasfollows:
Withdynamicdiscovery,allstoragetargetsassociatedwithahostnameorIPaddressarediscovered. Yourunthefollowingcommand:
vicfg-iscsi <conn_options> --discovery --add --ip <ip_addr | domain_name> <adapter_name>
Withstaticdiscovery,youmustspecifythehostnameorIPaddressandtheiSCSInameofthestorage target.Yourunthefollowingcommand:
vicfg-iscsi <conn_options> --static --add --ip <ip_addr | domain_name> --name <iscsi_name> <adapter_name>
Thetarget(-i)andname(-n)optiondeterminewhatthecommandappliesto.
Option -iandn Onlyi Neither-inorn Result CommandappliestopertargetCHAPforstatictargets. Commandappliestothediscoveryaddress. CommandappliestoperadapterCHAP.
72
VMware, Inc.
(Optional)SettheiSCSInameandalias.
vicfg-iscsi vicfg-iscsi vicfg-iscsi vicfg-iscsi <conn_options> <conn_options> <conn_options> <conn_options> -I -n <iscsi_name> <adapter_name> --iscsiname --name <iscsi_name> <adapter_name> -I -a <alias_name> <adapter_name> --iscsiname --alias <alias_name> <adapter_name>
Setupportbindingbyfollowingthesesteps: a IdentifytheVMkernelportofthedependenthardwareiSCSIadapter.
esxcli <conn_options> swiscsi vmknic list -d <vmhba>
ConnectthedependenthardwareiSCSIinitiatortotheiSCSIVMkernelportsbyrunningthe followingcommandforeachport.
esxcli <conn_options> swiscsi nic add -n <port_name> -d <vmhba>
VerifythattheportswereaddedtothedependenthardwareiSCSIinitiator.
esxcli <conn_options> swiscsi nic list -d <vmhba>
RescanthedependenthardwareSCSIinitiator.
vicfg-rescan <conn_options> <vmhba>
Addadynamicdiscoveryaddressorastaticdiscoveryaddress. Thetwotypesoftargetdifferasfollows:
Withdynamicdiscovery,allstoragetargetsassociatedwithahostnameorIPaddressarediscovered. Yourunthefollowingcommand:
vicfg-iscsi <conn_options> --discovery --add --ip <ip_addr | domain_name> <adapter_name>
Withstaticdiscovery,youmustspecifythehostnameorIPaddressandtheiSCSInameofthestorage target.Yourunthefollowingcommand:
vicfg-iscsi <conn_options> --static --add --ip <ip_addr | domain_name> --name <iscsi_name> <adapter_name>
Thetarget(-i)andname(-n)optiondeterminewhatthecommandappliesto.
Option -iandn Onlyi Neither-inorn Result CommandappliestopertargetCHAPforstatictargets. Commandappliestothediscoveryaddress. CommandappliestoperadapterCHAP.
VMware, Inc.
73
YoucanalsosettheHBAIPv4addressandnetworkmaskandgatewayinonecommand.
vicfg-iscsi <conn_options> --ip <ip_addr> --subnetmask <subnet_mask> --gateway <default_gateway>
(Optional)SettheiSCSInameandalias.
vicfg-iscsi vicfg-iscsi vicfg-iscsi vicfg-iscsi <conn_options> <conn_options> <conn_options> <conn_options> -I -n <iscsi_name> <adapter_name> --iscsiname --name <iscsi_name> <adapter_name> -I -a <alias_name> <adapter_name> --iscsiname --alias <alias_name> <adapter_name>
Addadynamicdiscoveryaddressorastaticdiscoveryaddress. Thetwotypesoftargetdifferasfollows:
Withdynamicdiscovery,allstoragetargetsassociatedwithanIPaddressarediscovered.Runthe followingcommand:
vicfg-iscsi <conn_options> --discovery --add --ip <ip_addr> <adapter_name>
74
VMware, Inc.
Withstaticdiscovery,youmustspecifytheIPaddressandtheiSCSInameofthestoragetargettobe added.Runthefollowingcommand:
vicfg-iscsi <conn_options> --static --add --ip <ip_addr> --name <iscsi_name> <adapter_name>
Thetarget(-i)andname(-n)optiondeterminewhatthecommandappliesto.
Option -iandn Onlyi Neither-inorn Result CommandappliestopertargetCHAPforstatictargets. Commandappliestothediscoveryaddress. CommandappliestoperadapterCHAP.
Thesystemreturnsinformationaboutthevendor,model,description,andserialnumberoftheHBA.
esxcli iscsi adapter target portallistsandsetsauthenticationandportalparameters. esxcli iscsi adapter target listlistsLUNinformation.
VMware, Inc.
75
Runvicfg-iscsi -P|--phbatolistexternal(vendorspecific)propertiesofaniSCSIadapter.
vicfg-iscsi <conn_options> -P -l <adapter_name> vicfg-iscsi <conn_options> --phba --list <adapter_name>
Thesystemreturnsinformationaboutthevendor,model,description,andserialnumberoftheHBA.
Runvicfg-iscsi -L|--luntolistLUNinformation.
vicfg-iscsi <conn_options> -L -l <adapter_name> vicfg-iscsi <conn_options> --lun --list <adapter_name>
Thecommandreturnstheoperatingsystemdevicename,busnumber,targetID,LUNID,andLUNsize fortheLUN.
Runvicfg-iscsi -Lwith-ttolistonlyLUNsonaspecifiedtarget.
vicfg-iscsi <conn_options> -L -l -t <target_ID> <adapter_name> vicfg-iscsi <conn_options> --lun --list --target_id <target_id> <adapter_name>
ThesystemreturnstheLUNsonthespecifiedtargetandthecorrespondingdevicename,devicenumber, LUNID,andLUNsize.
ThesystemreturnsinformationabouttheMACaddress,MTU,andcurrenttransferrate.
Runvicfg-iscsi -p -MtosettheMTUfortheadapter.Youspecifythesizeandadaptername.
vicfg-iscsi <conn_options> -p -M <mtu_size> <adapter_name> vicfg-iscsi <conn_options> --pnp --mtu <mtu-size> <adapter_name>
76
VMware, Inc.
esxcli iscsi adapter target portal param set --adapter=<vmhba> --key=<key> --value=<value> --address=<address> --name=<iqn.name> esxcli iscsi adapter discovery sendtarget param set --adapter=<vmhba> --key=<key> --value=<value> --address=<address>
Table 56listsallsettableparameters.TheseparametersarealsodescribedintheIETFrfc3720.Youcanrun esxcli iscsi adapter param gettodeterminewhetheraparameterissettableornot. TheparametersinTable 56applytosoftwareiSCSIanddependenthardwareiSCSI. Table 5-5. Settable iSCSI Parameters
Parameter DataDigestType Description Increasesdataintegrity.Whendatadigestisenabled,thesystemperformsachecksumover eachPDUsdatapartandverifiesusingtheCRC32Calgorithm. Note:SystemsthatuseIntelNehalemprocessorsoffloadtheiSCSIdigestcalculationsfor softwareiSCSI,thusreducingtheimpactonperformance. ValidvaluesaredigestProhibited,digestDiscouraged,digestPreferred,or digestRequired. HeaderDigest Increasesdataintegrity.Whenheaderdigestisenabled,thesystemperformsachecksumover theheaderpartofeachiSCSIProtocolDataUnit(PDU)andverifiesusingtheCRC32C algorithm. MaxOutstandingR2TdefinestheReadytoTransfer(R2T)PDUsthatcanbeintransitionbefore anacknowledgementPDUisreceived. MaximumamountofunsoliciteddataaniSCSIinitiatorcansendtothetargetduringthe executionofasingleSCSIcommand,inbytes. MaximumSCSIdatapayloadinaDataInorasolicitedDataOutiSCSIsequence,inbytes. Maximumdatasegmentlength,inbytes,thatcanbereceivedinaniSCSIPDU. Timeinterval,inseconds,betweenNOPOutrequestssentfromyouriSCSIinitiatortoaniSCSI target.TheNOPOutrequestsserveasthepingmechanismtoverifythataconnectionbetween theiSCSIinitiatorandtheiSCSItargetisactive. Supportedonlyattheinitiatorlevel. NoopTimeout Amountoftime,inseconds,thatcanlapsebeforeyourhostreceivesaNOPInmessage.The messageissentbytheiSCSItargetinresponsetotheNOPOutrequest.Whenthe NoopTimeoutlimitisexceeded,theinitiatorterminatesthecurrentsessionandstartsanew one. Supportedonlyattheinitiatorlevel. RecoveryTimeout DelayedAck Amountoftime,inseconds,thatcanlapsewhileasessionrecoveryisperformed.Ifthetimeout exceedsitslimit,theiSCSIinitiatorterminatesthesession. Allowssystemstodelayacknowledgmentofreceiveddatapackets.
YoucanusethefollowingESXCLIcommandstolistparameteroptions.
Runesxcli iscsi adapter param gettolistparameteroptionsfortheiSCSIadapter. Runesxcli iscsi adapter discovery sendtarget param getoresxcli iscsi adapter target portal param settoretrieveinformationaboutiSCSIparametersandwhethertheyaresettable. Runesxcli iscsi adapter discovery sendtarget param getoresxcli iscsi adapter target portal param settosetiSCSIparameteroptions.
Dynamictarget:esxcli iscsi adapter discovery sendtarget param set Statictarget:esxcli iscsi adapter target portal param set
78
VMware, Inc.
Runvicfg-iscsi -W -ltolistparameteroptionsfortheHBA.
vicfg-iscsi <conn_options> -W -l [-i <stor_ip_addr|stor_hostname> [:<portnum>] [-n <iscsi_name>]] <adapter_name> vicfg-iscsi <conn_options> --parameter --list [--ip <stor_ip_addr|stor_hostname> [:<portnum>] [--name <iscsi_name>]] <adapter_name>
Thetarget(-i)andname(-n)optiondeterminewhatthecommandappliesto.
Option -iandn Onlyi Neither-inorn Result Commandappliestostatictargets. Commandappliestothediscoveryaddress. Commandappliestoperadapterparameters.
Runvicfg-iscsi -W -l -k tolistiSCSIparametersandwhethertheyaresettable.
vicfg-iscsi <conn_options> -W -l -k [-i <stor_ip_addr|stor_hostname>[:<port_num>] [-n <iscsi_name>]] <adapter_name>
Runvicfg-iscsi -W -jtosetiSCSIparameteroptions.
vicfg-iscsi <conn_options> -W -j <name>=<value> -i <stor_ip_addr|stor_hostname>[:port_num>][-n <iscsi_name>]] <adapter_name> vicfg-iscsi <conn_options> --parameter --set <name>=<value> --ip <stor_ip_addr|stor_hostname>[:port_num>][--name <iscsi_name>]] <adapter_name>
Thetarget(-i)andname(-n)optiondeterminewhatthecommandappliesto.
Option -iandn Onlyi Neither-inorn Result CommandappliestopertargetCHAPforstatictargets. Commandappliestothediscoveryaddress. CommandappliestoperadapterCHAP.
VMware, Inc.
79
YoucansetpertargetCHAPforstatictargets,peradapterCHAP,orapplythecommandtothediscovery address.
peradapterCHAP:esxcli iscsi adapter auth chap set perdiscoveryCHAP:esxcli iscsi adapter discovery sendtarget auth chap set pertargetCHAP:esxcli iscsi adapter target portal auth chap set
Forexample:
esxcli <conn_options> iscsi adapter auth chap set --direction=uni --chap_username=User1 --chap_password=MySpecialPwd --level=preferred --secret=uni_secret --adapter=vmhba33
For<level>,specifyprohibitedorrequired.
Thespecifiedchap_usernameandsecretmustbesupportedonthestorageside. 2 ListpossibleVMkernelNICstobind.
esxcli <conn_options> iscsi logicalnetworkportal list
80
VMware, Inc.
Enablemutualauthentication.
esxcli <conn_options> iscsi adapter auth chap set --direction=mutual --mchap_username=<m_name> --mchap_password=<m_pwd> --level=[prohibited, required] --secret=<string> --adapter=<adapter_name>
Thespecifiedmchap_usernameandsecretmustbesupportedonthestorageside. Makesurethefollowingrequirementsaremet.
Aftersetupiscomplete,performrediscoveryandrescanallstoragedevices.Forexample:
esxcli <conn_options> iscsi adapter discovery rediscover esxcli <conn_options> storage core adapter rescan --adapter=vmhba36
Thespecifiedusernameandpasswordmustbesupportedonthestorageside. 2 EnablemutualauthenticationontheESXihost.
vicfg-iscsi <conn_options> -A -c <level> -m <auth_method> -b -u <ma_username> -w <ma_password> [-i <stor_ip_addr|stor_hostname> [:<portnum>] [-n <iscsi_name]] <adapter_name>
Makesurethefollowingrequirementsaremet.
Aftersetupiscomplete,performrediscoveryandrescanallstoragedevices.
VMware, Inc.
81
ConnectthesoftwareiSCSIordependenthardwareiSCSIinitiatortotheiSCSIVMkernelportsby runningthefollowingcommandforeachport.
esxcli <conn_options> iscsi networkportal nic add --adapter=<adapter_name> --nic=<bound_nic>
VerifythattheportswereaddedtotheiSCSIinitiatorbyrunningthefollowingcommand:
esxcli <conn_options> iscsi networkportal list --adapter=<adapter_name>
4 5
TodisconnecttheiSCSIinitiatorfromtheports,runthefollowingcommand.
esxcli <conn_options> iscsi networkportal remove --adapter=<adapter_name> --nic=<bound_nic>
Cloningsessions.SomeiSCSIarrayssupportmultiplesessionsbetweentheiSCSIadapterandtarget ports.Ifyoucloneanexistingsessionononeofthesearrays,thearraypresentsmoredatapathsforyour adapter.Duplicatesessionsdonotpersistacrossreboot.Additionalsessionstothetargetmighthave performancebenefits,buttheresultofcloningdependsentirelyonthearray.Youmustlogoutfroman iSCSIsessionifyouwanttocloneasession.Youcanusetheesxcli iscsi session addcommandto cloneasession. EnablingHeaderandDataDigest.IfyouareloggedintoasessionandwanttoenabletheHeaderand DataDigestparameters,youmustsettheparameter,removethesession,andaddthesessionbackforthe parameterchangetotakeeffect.YoumustlogoutfromaniSCSIsessionifyouwanttocloneasession. Establishingtargetspecificsessions.Youcanestablishasessiontoaspecifictargetport.Thiscanbe usefulifyourhostconnectstoasingleportstoragesystemthat,bydefault,presentsonlyonetargetport toyourinitiator,butcanredirectadditionalsessionstoadifferenttargetport.Establishinganewsession betweenyouriSCSIinitiatorandanothertargetportcreatesanadditionalpathtothestoragesystem.
CAUTIONSomestoragesystemsdonotsupportmultiplesessionsfromthesameinitiatornameorendpoint. AttemptstocreatemultiplesessionstosuchtargetscanresultinunpredictablebehaviorofyouriSCSI environment. Thefollowingexamplescenariousestheavailablecommands.Runesxcli iscsi session --helpandeach commandwith--helpforreferenceinformation.Theexampleusesaconfigurationfiletologintothehost. SpecifyoneoftheoptionslistedinConnectionOptionsonpage 17inplaceof<conn_options>. IMPORTANTTheESX/ESXi4.xESXCLIcommandsformanagingiSCSIsessionsarenotsupportedagainst ESXi5.0hosts.
82 VMware, Inc.
ListasoftwareiSCSIsessionattheadapterlevel.
esxcli <conn_options> iscsi session list --adapter=<iscsi_adapter>
ListasoftwareiSCSIsessionatthetargetlevel.
esxcli <conn_options> iscsi session list --name=<target> --adapter=<iscsi_adapter>
LogintoasessiononthecurrentsoftwareiSCSIordependenthardwareiSCSIconfigurationatthe adapterlevel.
esxcli <conn_options> iscsi session add --adapter=<adapter_name>
Forexample:
esxcli --config /host-config-file iscsi session add --adapter=vmhba36
LogintoasessiononthecurrentsoftwareiSCSIordependenthardwareiSCSIconfigurationatthetarget level.
esxcli <conn_options> iscsi session add --name=<target> --adapter=<adapter_name>
Forexample:
esxcli --config /host-config-file iscsi session add -name=iqn.xxx --adapter=vmhba36
AddduplicatesessionswithtargetandsessionIDsincurrentsoftwareiSCSIordependenthardware iSCSIconfiguration.
esxcli <conn_options> iscsi session add --name=<iqn.xxxx> --isid=<session_id> --adapter=<iscsi_adapter>
iqn.xxxxisthetargetIQN,whichyoucandeterminebylistingallsessions.session_idisthesessions iSCSIID.Forexample:
esxcli --config /host-config-file iscsi session add -name=iqn.xxx --isid='00:02:3d:00:00:01' --adapter=vmhba36
RemovesessionsfromthecurrentsoftwareiSCSIordependenthardwareiSCSIconfigurationatthe adapterlevel.
esxcli <conn_options> iscsi session remove --adapter=<iscsi_adapter>
Forexample:
esxcli iscsi session remove --adapter=vmhba36
RemovesessionsfromthecurrentsoftwareiSCSIordependenthardwareiSCSIconfigurationatthetarget level.
esxcli <conn_options> iscsi session remove --name=<iqn> --adapter=<iscsi_adapter>
Forexample:
esxcli <conn_options> iscsi session remove --name=iqn.xxx --adapter=vmhba38
VMware, Inc.
83
RemovesessionsfromthecurrentsoftwareiSCSIordependenthardwareiSCSIconfigurationwithtarget andsessionID.
esxcli <conn_options> iscsi session remove --name=<iqn.xxxx> --isid=<session id> --adapter=<iscsi_adapter>
84
VMware, Inc.
VMwarepartnersandcustomerscanoptimizeperformanceoftheirstoragearraysinconjunctionwith VMwarevSphereusingVMwarePSA(pluggablestoragearchitecture).Theesxcli storage core namespacemanagesVMwarePSAandtheesxcli storage nmpnamespacemanagestheVMwareNMP plugin. ThevSphereStoragedocumentationdiscussesPSAfunctionalityindetailandexplainshowtousethevSphere ClientorthevSphereWebClienttomanagethePSA,theassociatednativemultipathingplugin(NMP)and thirdpartyplugins. Thischapterusesthefollowingacronyms.
Acronym PSA NMP PSP SATP Meaning PluggableStorageArchitecture. NativeMultipathingPlugin.GenericVMwaremultipathingmodule. PathSelectionPlugin.Handlespathselectionforagivendevice. StorageArrayTypePlugin.Handlespathfailoverforagivenstoragearray.
Thischapterincludesthesetopics:
VMware, Inc.
85
IfadevicedoesnothaveaspecificPSPset,italwaysusesthePSPassignedtotheSATP.IfthedefaultPSP fortheSATPchanges,thePSPassignedtothedevicechangesonlyafterrebootorafteradeviceis reclaimed.Adeviceisreclaimedwhenyouunclaimallpathsforthedeviceandreclaimthepaths. Ifyouuseesxcli storage nmp device settooverridetheSATPsdefaultPSPwithaspecificPSP,the PSPchangesimmediatelyandremainstheuserdefinedPSPacrossreboots.AchangeintheSATPsPSP hasnoeffect.
Usethe--defaultoptiontoreturnthedevicetousingtheSATPsPSP.
Options --default -E --device <device> -d <device> --psp <PSP> -P <PSP> Description SetsthePSPbacktothedefaultfortheSATPassignedtothisdevice. DevicetosetthePSPfor. PSPtoassigntothespecifieddevice.Callesxcli storage nmp psp listtodisplayall currentlyavailablePSPs.SeeTable 41,SupportedPathPolicies,onpage 48. SeevSphereStorageforadiscussionofpathpolicies.
TosetthepathpolicyforthespecifieddevicetoVMW_PSP_FIXED,runthefollowingcommand:
esxcli <conn_options> storage nmp device set --device naa.xxx --psp VMW_PSP_FIXED
Onlyshowpathstoasingedevice(esxcli storage nmp path list --device <device>). Onlyshowinformationforasinglepath(esxcli storage nmp path list --path=<path>.
Managing Path Selection Policy Plugins with esxcli storage nmp psp
Useesxcli storage nmp psptomanageVMwarepathselectionpolicypluginsincludedwiththeVMware NMPpluginandtomanagethirdpartyPSPs. IMPORTANTWhenusedwiththirdpartyPSPs,thesyntaxdependsonthethirdpartyPSPimplementation.
86
VMware, Inc.
Usenmp pspgeneric deviceconfig getforPSPsthataresettoVMW_PSP_RR,VMW_PSP_FIXEDor VMW_PSP_MRU. Usenmp pspgeneric pathconfig getforPSPsthataresettoVMW_PSP_FIXEDorVMW_PSP_MRU.No pathconfigurationinformationisavailableforVMW_PSP_RR.
ToretrievePSPconfigurationparameters,usetheappropriatecommandforthePSP.
Deviceconfigurationinformation.
esxcli <conn_options> storage nmp psp generic deviceconfig get --device=<device> esxcli <conn_options> storage nmp psp fixed deviceconfig get --device=<device> esxcli <conn_options> storage nmp psp roundrobin deviceconfig get --device=<device>
Pathconfigurationinformation.
esxcli <conn_options> storage nmp psp generic pathconfig get --path=<path>
RetrievethePSPconfigurationforthespecifiedpath.
esxcli <conn_options> nmp psp pathconfig generic get --path vmhba4:C1:T2:L23
VMware, Inc.
87
Specifywhentoswitchpaths. YoucanchoosethenumberofI/Ooperations,numberofbytes,andsoon.Forexample:
esxcli <conn_options> storage nmp psp roundrobin deviceconfig set --type "bytes" -B 12345 --device naa.xxx
Setsthedevicespecifiedby--devicetoswitchtothenextpatheachtime12345byteshavebeensent alongthecurrentpath.
esxcli <conn_options> storage nmp psp roundrobin deviceconfig set --type=iops --iops 4200 --device naa.xxx
Setsthedevicespecifiedby--devicetoswitchafter4200I/Ooperationshavebeenperformedonapath.
88
VMware, Inc.
Managing SATPs
Theesxcli storage nmp satpcommandsmanageSATPs.Youcanusethesecommandstoperformthe followingtasks:
ThedefaultSATPforanactiveactiveFCarraywithavendorandmodelnotlistedintheSATPrulesis VMW_SATP_DEFAULT_AA.
VMware, Inc.
89
AddaSATPrulethatspecifiesthatdiskswithvendorstringVMWAREandmodelstringVirtualshould beaddedtoVMW_SATP_LOCAL.
esxcli <conn_options> storage nmp satp rule add --satp="VMW_SATP_LOCAL" --vendor="VMWARE" --model="Virtual" --description="VMware virtual disk"
AddaSATPrulethatspecifiesthatdiskswiththedriverstringsomedrivershouldbeaddedto VMW_SATP_LOCAL.
esxcli <conn_options> storage nmp satp rule add --satp="VMW_SATP_LOCAL" --driver="somedriver"
90
VMware, Inc.
AddarulethatspecifiesthatallstoragedeviceswithvendorstringABCandamodelnamethatstartswith 120shoulduseVMW_SATP_DEFAULT_AA(VMW_SATP_DEFAULT_AAisanexample).
esxcli <conn_options> storage nmp satp rule add --satp VMW_SATP_DEFAULT_AA --vendor="ABC" --model="^120*
Youcanspecifyoneofthefollowingdeviceconfigurationstrings:
--device -d --path -p
DevicetosetSATPconfigurationfor.NotallSATPssupportthesetconfigoptionondevices. PathtosetSATPconfigurationfor.NotallSATPssupportthesetconfigoptiononpaths.
VMware, Inc.
91
Attemptstounclaimallpathstoadevice. Runstheloadedclaimrulesoneachoftheunclaimedpathstoreclaimthosepaths.
92
VMware, Inc.
Options --device <device> -d <device> --driver <driver> -D <driver> --lun <lun_number> -L <lun_number> --model <model> -m <model> --path <path> -p <path> --plugin <plugin> -P
Description If--typeissettodevice,attemptstounclaimallpathstothespecifieddevice.Ifthere areactiveI/Ooperationsonthespecifieddevice,atleastonepathcannotbeunclaimed. If--typeisdriver,unclaimsallpathsspecifiedbythisHBAdriver. If--typeislocation,specifiestheSCSILUNforthepathstounclaim.Ifyoudonot specify--lun,unclaimingrunsonpathswithanyLUNnumber. If--typeisvendor,attemptstounclaimallpathstodeviceswithspecificmodel information(formultipathingplugins)orunclaimthedeviceitself(forfilterplugins).If thereareactiveI/Ooperationsonthisdevice,atleastonepathfailstounclaim. If--typeispath,unclaimsapathspecifiedbyitspathUIDorruntimename. If--typeisplugin,unclaimsallpathsforaspecifiedmultipathplugin. <plugin>canbeanyvalidPSApluginonthesystem.BydefaultonlyNMPand MASK_PATHareavailable,butadditionalpluginsmightbeinstalled. If--typeislocation,unclaimsthepathswiththeSCSItargetnumberspecifiedby target.Ifyoudonotspecify--target,unclaimingrunsonpathsfromalltargets. Typeofunclaimoperationtoperform.Validvaluesarelocation,path,driver, device,plugin,andvendor. If--typeisvendor,attemptstounclaimallpathstodeviceswithspecificvendorinfo formultipathingpluginsorunclaimthedeviceitselfforfilterplugins.Ifthereareany activeI/Ooperationsonthisdevice,atleastonepathfailstounclaim
Thefollowingtroubleshootingcommandtriestounclaimallpathsonvmhba1.
esxcli <conn_options> storage core claiming unclaim --type location -A vmhba1
VMware, Inc.
93
Options --adapter <adapter> -A <adapter> --autoassign -u --channel <channel> -C <channel> --claimrule-class <cl> -c <cl>
Description Adapterofthepathstouse.Validonlyif--typeislocation. Addsaclaimrulebasedonitscharacteristics.Therulenumberisnotrequired. Channelofthepathstouse.Validonlyif--typeislocation. Claimruleclasstouseinthisoperation.YoucanspecifyMP(default),Filter,orVAAI. Toconfigurehardwareaccelerationforanewarray,addtwoclaimrules,oneforthe VAAIfilterandanotherfortheVAAIplugin.SeevSphereStoragefordetailed instructions. DriverfortheHBAofthepathstouse.Validonlyif--typeisdriver. Forceclaimrulestoignorevaliditychecksandinstalltherule. LUNofthepathstouse.Validonlyif--typeislocation. Modelofthepathstouse.Validonlyif--typeisvendor. ValidvaluesarevaluesoftheModelstringfromtheSCSIinquirystring.Run vicfg-scsidevs <conn_options> -loneachdevicetoseemodelstringvalues. PSAplugintouse.Currently,thevaluesareNMPorMASK_PATH,butthirdpartiescan shiptheirownPSApluginsinthefuture. MASK_PATHreferstothepluginMASK_PATH_PLUGIN.Thecommandaddsclaimrules forthispluginiftheuserwantstomaskthepath. ESX3.5includestheMaskLUNsadvancedconfigurationoption.Thisoptionisnot availableinESX/ESXi4.xandESXi5.0.Ithasbeenreplacedbythe MASK_PATH_PLUGIN.YoucanaddaclaimrulethatcausestheMASK_PATH_PLUGINto claimthepathtomaskapathorLUNfromthehost.SeethevSphereStorage documentationfordetails.
--driver <driver> -D <driver> --force -f --lun <lun_number> -L <lun_number> --model <model> -M <model> --plugin -P
RuleIDtouse.Runesxcli storage core claimrule listtoseetheruleID.The ruleIDindicatestheorderinwhichtheclaimruleistobeevaluated.Userdefined claimrulesareevaluatedinnumericorderstartingwith101. Targetofthepathstouse.Validonlyif--typeislocation. Transportofthepathstouse.Validonlyif--typeistransport.Thefollowingvalues aresupported:
blockblockstorage fcFibreChannel iscsivendoriSCSI iscsinotcurrentlyused ideIDEstorage sasSASstorage sataSATAstorage usbUSBstorage parallelparallel unknown
--wwnn --wwpn
94
VMware, Inc.
Claimrulesarenumberedasfollows.
Addrule321,whichclaimsthepathonadaptervmhba0,channel0,target0,LUN0fortheNMPplugin.
esxcli <conn_options> storage core claimrule add -r 321 -t location -A vmhba0 -C 0 -T 0 -L 0 -P NMP
Addrule429,whichclaimsallpathsprovidedbyanadapterwiththemptscsidriverfortheMASK_PATH plugin.
esxcli <conn_options> storage core claimrule add -r 429 -t driver -D mptscsi -P MASK_PATH
Addrule914,whichclaimsallpathswithvendorstringVMWAREandmodelstringVirtualfortheNMP plugin.
esxcli <conn_options> storage core claimrule add -r 914 -t vendor -V VMWARE -M Virtual -P NMP
Addrule1015,whichclaimsallpathsprovidedbyFCadaptersfortheNMPplugin.
esxcli <conn_options> storage core claimrule add -r 1015 -t transport -R fc -P NMP
VMware, Inc.
95
WhenyouconvertLUNmaskingtotheclaimruleformatafteranupgradefromESX/ESXi3.5toESX/ESXi4.x, thiscommandconvertsthe/adv/Disk/MaskLUNsadvancedconfigurationentryintheesx.conffiletoclaim ruleswithMASK_PATHastheplugin. IMPORTANTThisconversiondoesnotworkforallinputMaskLUNvariations.Forexample,roleconversion forsoftwareiSCSILUNsisnotsupported. Inspectthelistofgeneratedclaimrulescarefullybeforeyoucommitthembyusing--commit. Table 6-1. esxcli storage core claimrule convert Options
Options --commit -C Description ForcesLUNmaskconfigurationchangestobesaved.Ifyoucallthecommandwithoutthis parameter,changesarenotsaved,andyoucanfirstinspectthegeneratedclaimrules.
Thefollowingexampleremovesrule1015.
esxcli <conn_options> storage core claimrule remove -r 1015
96
VMware, Inc.
Quiescethedevicesthatusepathsforwhichyouwanttochangetheruleandunclaimthosepaths.
esxcli <conn_options> storage core claiming unclaim --device=<device>
Runpathclaimingrules.
esxcli <conn_options> storage core claimrule run
Thiscommandisalsousedfortroubleshootingandboottimeconfiguration.
Options --adapter <adapter> -A <adapter> --channel <channel> -C <channel> --claimrule-class -c --lun <lun> -L <lun> --path <path_UID> -p <path_UID> --target <target> -T <target> Description If--typeislocation,nameoftheHBAforthepathstoruntheclaimruleson.To runclaimrulesonpathsfromalladapters,omitthisoption. If--typeislocation,valueoftheSCSIchannelnumberforthepathstorunthe claimruleson.Torunclaimrulesonpathswithanychannelnumber,omitthis option. Claimruleclasstouseinthisoperation. If--typeislocation,valueoftheSCSILUNforthepathstorunclaimruleson.To runclaimrulesonpathswithanyLUN,omitthisoption. If--typeispath,thisoptionindicatestheuniquepathidentifier(UID)orthe runtimenameofapathtorunclaimruleson. If--typeislocation,valueoftheSCSItargetnumberforthepathstorunclaim ruleson.Torunclaimrulesonpathswithanytargetnumber,omitthisoption
VMware, Inc.
97
Description Typeofclaimtoperform.Bydefault,usesall,whichmeansclaimrulesrunwithout restrictiontospecificpathsorSCSIaddresses.Validvaluesarelocation,path,and all. Youcanusethisoptiononlyifyoualsouse--typeall. Iftheoptionisincluded,theclaimwaitsforpathstosettlebeforerunningtheclaim operation.Inthatcase,thesystemdoesnotstarttheclaimingprocessuntilitislikely thatallpathsonthesystemhaveappearedbeforestartingtheclaimprocess. Aftertheclaimingprocesshasstarted,thecommanddoesnotreturnuntildevice registrationhascompleted. Ifyouaddorremovepathsduringtheclaimingorthediscoveryprocess,thisoption mightnotworkcorrectly.
98
VMware, Inc.
Managing Users
Ifyoucreateauserwithoutspecifyingtherole(--role),theuserhasnopermissions.Youcannotchangethe usersrole,youcanonlychangetheuserspermission.
VMware, Inc.
99
100
VMware, Inc.
Thecommandcreatestheuser.Bydefault,thecommandautogeneratesaUIDfortheuser. 3 ListtheusersagaintoverifythatthenewuserwasaddedandaUIDwasgenerated.
vicfg-user <conn_options> -e user -o list USERS ------------------Principal -: root Full Name -: root UID -: 0 Shell Access -> 1 ------------------... -------------------Principal -: user27 Full Name -: UID -: 501 Shell Access -> 0
Modifythepasswordforuseruser27.
vicfg-user <conn_options> -e user -o modify -l user27 -p 27_password2
Thesystempromptswhetheryouwanttochangethepassword,whichmightbeadvisableiftheuserdoes notcurrentlyhaveapassword.Answeryorn.Thesystemthenupdatestheuser.
Updated user user27 successfully. Assigned the role read-only
6
VMware, Inc.
RemovetheuserwithloginIDuser27.
101
Thesystemremovestheuserandprintsamessage.
Removed the user user27 successfully.
102
VMware, Inc.
vmwarecmdOverviewonpage 103 ListingandRegisteringVirtualMachinesonpage 104 RetrievingVirtualMachineAttributesonpage 105 ManagingVirtualMachineSnapshotswithvmwarecmdonpage 106 PoweringVirtualMachinesOnandOffonpage 107 ConnectingandDisconnectingVirtualDevicesonpage 108 WorkingwiththeAnswerVMAPIonpage 109 ForciblyStoppingVirtualMachineswithEXCLIonpage 109
vmware-cmd Overview
vmware-cmdwasincludedinearlierversionoftheESXServiceConsole.Avmware-cmdcommandhasbeen availableinthevCLIpackagesinceESXiversion3.0. IMPORTANTvmware-cmdisnotavailableintheESXiShell.Runthevmware-cmdvCLIcommandinstead. Olderversionsofvmware-cmdsupportasetofconnectionoptionsandgeneraloptionsthatdifferfromthe optionsinothervCLIcommands.Thevmware-cmdvCLIcommandsupportstheseoptions.ThevCLI commandalsosupportsthestandardvCLI--server,--username,--password,and--vihostoptions. vmware-cmddoesnotsupportotherconnectionoptions. IMPORTANTvmware-cmdisalegacytoolandsupportstheusageofVMFSpathsforvirtualmachine configurationfiles.Asarule,usedatastorepathstoaccessvirtualmachineconfigurationfiles.
VMware, Inc.
103
Datastoreprefixstyle:'[ds_name] relative_path',forexample:
'[myStorage1] testvms/VM1/VM1.vmx'(Linux)
UUIDbasedpath: folder/subfolder/file,forexample:
'/vmfs/volumes/mystorage/testvms/VM1/VM1.vmx'(Linux)
"/vmfs/volumes/mystorage/testvms/VM1/VM1.vmx"(Windows)
104
VMware, Inc.
ThecommandliststheVMXfileforeachvirtualmachine.
/vmfs/volumes/<storage>/winxpPro-sp2/winxpPro-sp2.vmx /vmfs/volumes/<storage>/RHEL-lsi/RHEL-lsi.vmx /vmfs/volumes/<storage>/VIMA0809/VIMA0809.vmx .....
Runvmware-cmd -s unregistertoremoveavirtualmachinefromtheinventory.
vmware-cmd -H <vc_server> -U <login_user> -P <login_password> --vihost <esx_host> -s unregister /vmfs/volumes/Storage2/testvm/testvm.vmx
Thesystemreturns0toindicatesuccess,1toindicatefailure. NOTEWhenyourunagainstavCenterServersystem,youmustspecifythedatacenterandtheresource pooltoregisterthevirtualmachinein.Thedefaultdatacenterisha-datacenterandthedefaultresource poolisResources. WhenyourunagainstanESXihost,youusuallydonotspecifytheresourcepoolanddatacenter. However,iftwovirtualmachineswiththesamenameexistintworesourcepools,youmustspecifythe resourcepool. 3 4 Runvmware-cmd -lagaintoverifythatthevirtualmachinewasremovedfromtheinventory. Runvmware-cmd -s registertoaddthevirtualmachinebacktotheinventory.
vmware-cmd -H <vc_server> -U <login_user -P <login_password --vihost <esx_host> -s register /vmfs/volumes/Storage2/testvm/testvm.vmx
Thesystemreturns0toindicatesuccess,1toindicatefailure.
TheHardeningGuideincludesadditionalinformationaboutvariablesyoucanuseinconjunctionwith guestinfo.Acompletelistisnotavailable.
Thegetuptimeoptionretrievestheuptimeoftheguestoperatingsystemonthevirtualmachine,in seconds.
vmware-cmd -H <vc_system> -U <user> -P <password> --vihost <esx_host> /vmfs/volumes/Storage2/testvm/testvm.vmx getuptime getuptime() = 17921
Thegetproductinfo productoptionliststheVMwareproductthatthevirtualmachinerunson.
vmware-cmd -H <vc_system> -U <user> -P <password> --vihost <esx_host> /vmfs/volumes/Storage2/testvm/testvm.vmx getproductinfo product
VMware, Inc.
105
Thereturnvalueisesx(VMwareESX),embeddedESX(VMwareESXi),orunknown.
Thegetproductinfo platformoptionliststheplatformthatthevirtualmachinerunson.
vmware-cmd -H <vc_system> -U <user> -P <password> --vihost <esx_host> /vmfs/volumes/Storage2/testvm/testvm.vmx getproductinfo platform
Thereturnvalueiswin32-x86(x86basedWindowssystem),linux-x86(x86basedLinuxsystem),or vmnix-x86(x86basedESXimicrokernel).
ThegettoolslastactiveoptionindicateswhetherVMwareToolsisinstalledandwhethertheguest operatingsystemisrespondingnormally.
vmware-cmd -H <vc_system> -U <user> -P <password> --vihost <esx_host> /vmfs/volumes/Storage2/testvm/testvm.vmx gettoolslastactive
106
VMware, Inc.
(Optional)Checkthattheshutdownoperationhasbeencompleted.
vmware-cmd -H <vc_system> -U <user> -P <password> --vihost <esx_host> /vmfs/volumes/Storage2/testvm/testvm.vmx getstate
Runvmware-cmdwiththecreatesnapshotoption. Youmustspecifythedescription,quiesceflag(0or1)andmemoryflag(0or1).
vmware-cmd -H <vc_system> -U <user> -P <password> --vihost <esx_host> /vmfs/volumes/Storage2/testvm/testvm.vmx createsnapshot VM1Aug09 test snapshot August 09 0 0
Checkthatthevirtualmachinehasasnapshotbyusingthehassnapshotoption. Thecallreturns1ifthevirtualmachinehasasnapshotandreturns0otherwise.
vmware-cmd -H <vc_system> -U <user> -P <password> --vihost <esx_host> /vmfs/volumes/Storage2/testvm/testvm.vmx hassnapshot hassnapshot () = 1
Runvmware-cmdwiththeremovesnapshotsoptiontoremoveallsnapshotsassociatedwithavirtual machine.Ifnosnapshotexists,thecommanddoesnothing.
vmware-cmd -H <vc_system> -U <user> -P <password> --vihost <esx_host> /vmfs/volumes/Storage2/testvm/testvm.vmx removesnapshots
VMware, Inc.
107
Softpoweroperations.Whenyouspecifysoftasthepowerop_modevalue,theresultofthecalldepends ontheoperation.
Operation Stop Reset Suspend Result vmware-cmdattemptstoshutdowntheguestoperatingsystemandpowersoffthevirtualmachine. vmware-cmdattemptstoshutdowntheguestoperatingsystemandrebootsthevirtualmachine. vmware-cmdattemptstorunascriptintheguestoperatingsystembeforesuspendingthevirtual machine.
Hardpoweroperations.vmware-cmdimmediatelyandunconditionallyshutsdown,resets,orsuspends thevirtualmachine.
Thefollowingexamplesillustratehowtousevmware-cmd.
Start.Usethestartoptiontopoweronavirtualmachineortoresumeasuspendedvirtualmachine.The powerop_mode,eitherhardorsoft,isrequired.
vmware-cmd -H <vc_system> -U <user> -P <password> --vihost <esx_host> /vmfs/volumes/Storage2/testvm/testvm.vmx start soft
Suspend.Youhavetwooptionsforsuspendingavirtualmachine.
Thesuspendoptionwiththehardpoweropmodeunconditionallyshutsdownavirtualmachine.
vmware-cmd -H <vc_system> -U <user> -P <password> --vihost <esx_host> /vmfs/volumes/Storage2/testvm/testvm.vmx suspend hard
Thevirtualmachinehasaguestoperatingsystemthatsupportshotplugfunctionality.SeetheOperating SystemInstallationdocumentation.
108
VMware, Inc.
Thevirtualmachineisusinghardwareversion7.
Thefollowingexamplesillustrateconnectinganddisconnectingavirtualdevice.
TheconnectdeviceoptionconnectsthevirtualIDEdeviceCD/DVDDrive2tothespecifiedvirtual machine.
vmware-cmd -H <vc_system> -U <user> -P <password> --vihost <esx_host> /vmfs/volumes/Storage2/testvm/testvm.vmx connectdevice "CD/DVD Drive 2"
Thedisconnectdeviceoptiondisconnectsthevirtualdevice.
vmware-cmd -H <vc_system> -U <user> -P <password> --vihost <esx_host> /vmfs/volumes/Storage2/testvm/testvm.vmx disconnectdevice "CD/DVD Drive 2"
Stopthevirtualmachinebyrunningthefollowingcommand.
esxcli <conn_options> vm process kill --type <kill_type> --world-id <ID>
Thecommandsupportsthree--typeoptions.Trythetypessequentially(softbeforehard,hardbefore force).Thefollowingtypesaresupportedthroughthe--typeoption:
Ifallthreeoptionsdonotwork,rebootyourESXihosttoresolvetheissue.
VMware, Inc.
109
110
VMware, Inc.
IntroductiontovSphereNetworkingonpage 111 RetrievingBasicNetworkingInformationonpage 113 NetworkTroubleshootingonpage 114 SettingUpvSphereNetworkingwithvSphereStandardSwitchesonpage 115 SettingUpvSphereNetworkingwithvSphereDistributedSwitchonpage 126 ManagingStandardNetworkingServicesinthevSphereEnvironmentonpage 126 SettingtheDNSConfigurationonpage 126 AddingandStartinganNTPServeronpage 129 ManagingtheIPGatewayonpage 129 SettingUpIPseconpage 130 ManagingtheESXiFirewallonpage 133
VirtualswitchesallowyourESXihosttomigratevirtualmachineswithVMwarevMotionandtouseIPstorage throughVMkernelnetworkinterfaces.
VMware, Inc.
111
Host2
virtual
Host2 physical
physical network
AssociatedwitheachESXihostareoneormoreuplinkadapters(1).Uplinkadaptersrepresentthe physicalswitchestheESXihostusestoconnecttothenetwork.Youcanmanageuplinkadaptersusingthe esxcli network nicorvicfg-nicsvCLIcommand.SeeManagingUplinkAdaptersonpage 120. Eachuplinkadapterisconnectedtoastandardswitch(2).Youcanmanageastandardswitchand associateitwithuplinkadaptersbyusingtheesxcli network vswitchorvicfg-vswitchvCLI command.SeeSettingUpVirtualSwitchesandAssociatingaSwitchwithaNetworkInterfaceon page 115. Associatedwiththestandardswitchareportgroups(3).Portgroupisauniqueconceptinthevirtual environment.Youcanconfigureportgroupstoenforcepoliciesthatprovideenhancednetworking security,networksegmentation,betterperformance,highavailability,andtrafficmanagement.Youcan usetheesxcli network vswitch standard portgrouporvicfg-vswitchcommandtoassociatea standardswitchwithaportgroup,andtheesxcli network ip interfaceorvicfg-vmkniccommand toassociateaportgroupwithaVMkernelnetworkinterface. TheVMkernelTCP/IPnetworkingstacksupportsiSCSI,NFS,andvMotionandhasanassociated VMkernelnetworkinterface.YouconfigureVMkernelnetworkinterfaceswithesxcli network ip interfaceorvicfg-vmknic.SeeAddingandModifyingVMkernelNetworkInterfacesonpage 123. SeparateVMkernelnetworkinterfacesareoftenusedforseparatetasks,forexample,youmightdevote oneVMkernelNetworkinterfacecardtovMotiononly.VirtualmachinesruntheirownsystemsTCP/IP stacksandconnecttotheVMkernelattheEthernetlevelthroughvirtualswitches.
112
VMware, Inc.
uplink
Host2
virtual
Host2 physical
physical network
Eachphysicalnetworkadapter(1)onthehostispairedwithadistributeduplinkport(2),which representstheuplinktothevirtualmachine.Withdistributedswitches,thevirtualmachinenolonger dependsonthehostsphysicaluplinkbutonthe(virtual)uplinkport.Youmanageauplinkports primarilyusingthevSphereWebClient,orvSphereAPIs. Thedistributedswitchitself(3)functionsasasinglevirtualswitchacrossallassociatedhosts.Becausethe switchisnotassociatedwithasinglehost,virtualmachinescanmaintainconsistentnetwork configurationastheymigratefromonehosttoanother. Likeastandardswitch,eachdistributedswitchisanetworkhubthatvirtualmachinescanuse.A distributedswitchcanroutetrafficinternallybetweenvirtualmachinesorlinktoanexternalnetworkby connectingtophysicalnetworkadapters.YoucreateadistributedswitchusingthethevSphereWeb ClientUI,butcanmanagesomeaspectsofadistributedswitchwithvicfg-vswitch.Youcanlist distributedvirtualswitcheswiththeesxcli network vswitchcommand.SeeSettingUpVirtual SwitchesandAssociatingaSwitchwithaNetworkInterfaceonpage 115.
ForinformationcorrespondingtotheLinuxnetstatcommand,usethefollowingESXCLIcommand.
esxcli <conn_options> network ip connection list
VMware, Inc.
113
Network Troubleshooting
YoucanusevCLInetworkcommandstoviewnetworkstatisticsandtroubleshootyournetworkingsetup.The nestedhierarchyofcommandsallowsyoutodrilldowntopotentialtroublespots. 1 Listallvirtualmachinenetworksonahost.
esxcli network vm list
ThecommandreturnsforeachvirtualmachinetheWorldID,name,numberofports,andnetworks,asin thefollowingexample.
World ID Name Num Ports Networks ---------------------------------------------------10374 ubuntu-server-11.04-1 2 VM Network, 10375 ubuntu-server-11.04-2 2 VM Network, 10376 ubuntu-server-11.04-3 2 VM Network, 10408 ubuntu-server-11.04-4 3 VM Network,
ListtheportsforoneoftheVMsbyspecifyingitsWorldID.
esxcli network vm port list -w 10408
Thecommandreturnsportinformation,asinthefollowingexample.
Port: Port ID: XXXXXXXX vSwitch: vSwitch0 Portgroup: VM Network DVPort ID: MAC Address: 00:XX:XX:aa:XX:XX IP Address: 10.XXX.XXX.XXX Team Uplink: vmnic0 Uplink Port ID: 12345678 Active Filters:
Retrievetheswitchstatisticsforaport.
esxcli network port stats get -p 12345678
Thecommandreturnsdetailedstatistics,asinthefollowingexample.
Packet statistics for port 12345678: Packets received: 517631 Packets sent: 18937 Bytes received: 100471874 Bytes sent: 1527233 Broadcast packets received: 474160 Broadcast packets sent: 107 Multicast packets received: 8020 Multicast packets sent: 8 Unicast packets received: 35451 Unicast packets sent: 18822 Receive packets dropped: 45 Transmit packets dropped: 0
Retrievethefilterinformationfortheport.
esxcli network port filter stats get -p 12345678
Thecommandreturnsdetailedstatistics,asinthefollowingexample.
Filter statistics for dvfilter-test: Filter direction: Receive Packets in: 202080 Packets out: 202080 Packets dropped: 0
114
VMware, Inc.
Packets filtered: 0 Packets faulted: 0 Packets queued: 0 Packets injected: 0 Packet errors: 0
RetrievecompletestatisticsforaNIC.
esxcli network nic stats get -n vmnic0
GetaperVLANpackedbreakdownonaNIC.
esxcli network nic vlan stats get -n vmnic0
ThecommandreturnsthenumberofpacketssentandreceivedfortheVLANyouspecified.
8 9 10
11
VMware, Inc.
115
Whenworkingwithvirtualswitchesandportgroups,performthefollowingtasks: 1 Findoutwhichvirtualswitchesareavailableand(optionally)whattheassociatedMTUandCDP(Cisco DiscoveryProtocol)settingsare.SeeRetrievingInformationaboutVirtualSwitcheswithESXCLIon page 116andRetrievingInformationaboutVirtualSwitcheswithvicfgvswitchonpage 116. Addavirtualswitch.SeeAddingandDeletingVirtualSwitcheswithESXCLIonpage 117andAdding andDeletingVirtualSwitcheswithvicfgvswitchonpage 117. Foranewlyaddedswitch,performthesetasks: a b c d Addaportgroup.SeeManagingPortGroupswithESXCLIonpage 118andManagingPort Groupswithvicfgvswitchonpage 118. (Optional)SettheportgroupVLANID.SeeSettingthePortGroupVLANIDwithESXCLIon page 119andSettingthePortGroupVLANIDwithvicfgvswitchonpage 120. Addanuplinkadapter.SeeLinkingandUnlinkingUplinkAdapterswithESXCLIonpage 122and LinkingandUnlinkingUplinkAdapterswithvicfgvswitchonpage 122. (Optional)ChangetheMTUorCDPsettings.SeeSettingSwitchAttributeswithesxclinetwork vswitchstandardonpage 117andSettingSwitchAttributeswithvicfgvswitchonpage 118.
2 3
Listallvirtualswitchesandassociatedportgroups.
esxcli <conn_options> network vswitch standard list
Listthenetworkpolicysettings(securitypolicy,trafficshapingpolicy,andfailoverpolicy)forthevirtual switch.Thefollowingcommandsaresupported.
esxcli <conn_options> network vswitch standard policy failover get esxcli <conn_options> network vswitch standard policy security get esxcli <conn_options> network vswitch standard policy shaping get
CheckwhethervSwitch1exists.
vicfg-vswitch <conn_options> -c vSwitch1
Listallvirtualswitchesandassociatedportgroups.
vicfg-vswitch <conn_options> -l
RetrievethecurrentCDP(CiscoDiscoveryProtocol)settingforthisvirtualswitch.
116
VMware, Inc.
Addavirtualswitch.
esxcli <conn_options> network vswitch standard add --vswitch-name=vSwitch42
Youcanspecifythenumberofportgroupswhileaddingthevirtualswitch.Ifyoudonotspecifyavalue, thedefaultvalueisused.Thesystemwideportcountcannotbegreaterthan4096.
esxcli <conn_options> network vswitch standard add --vswitch-name=vSwitch42 --ports=8
Deleteavirtualswitch.
esxcli <conn_options> network vswitch standard remove --vswitch-name=vSwitch42
Addavirtualswitch.
vicfg-vswitch <conn_options> --add vSwitch2
Deleteavirtualswitch.
vicfg-vswitch <conn_options> --delete vSwitch1
SettheMTUforavSwitch.
esxcli <conn_options> network vswitch standard set --mtu=9000 --vswitch-name=vSwitch1
VMware, Inc.
117
TheMTUisthesize,inbytes,ofthelargestprotocoldataunittheswitchcanprocess.Whenyousetthis option,itaffectsalluplinksassignedtothevirtualswitch.
SettheCDPvalueforavSwitch.Youcansetstatustodown,listen,advertise,orboth.
esxcli <conn_options> network vswitch standard set --cdp-status=listen --vswitch-name=vSwitch1
SettheMTUforavSwitch.
vicfg-vswitch <conn_options> -m 9000 vSwitch1
TheMTUisthesize(inbytes)ofthelargestprotocoldataunittheswitchcanprocess.Whenyousetthis option,itaffectsalluplinksassignedtothevirtualswitch.
SettheCDPvalueforavSwitch.Youcansetstatustodown,listen,advertise,orboth.
vicfg-vswitch <conn_options> --set-cdp listen
Listportgroupscurrentlyassociatedwithavirtualswitch.
esxcli <conn_options> network vswitch standard portgroup list
Liststheportgroupname,associatedvirtualswitch,activeclients,andVLANID.
Addaportgroup.
esxcli <conn_options> network vswitch standard portgroup add --portgroup-name=<name> --vswitch-name=vSwitch1
Deleteoneoftheexistingportgroups.
esxcli <conn_options> network vswitch standard portgroup remove --portgroup-name=<name> --vswitch-name=vSwitch1
Checkwhetherportgroupsarecurrentlyassociatedwithavirtualswitch.
vicfg-vswitch <conn_options> --check-pg <port_group> vSwitch1
118
VMware, Inc.
Addaportgroup.
vicfg-vswitch <conn_options> --add-pg <port_group_name> vSwitch1
Deleteoneoftheexistingportgroups.
vicfg-vswitch <conn_options> --del-pg <port_group_name> vSwitch1
Connecting and Disconnecting Uplink Adapters and Port Groups with ESXCLI
Ifyoursetupincludesoneormoreportgroups,youcanassociateeachportgroupwithoneormoreuplink adapters(andremovetheassociation).Thisfunctionalityallowsyoutofiltertrafficfromaportgrouptoa specificuplink,evenifthevirtualswitchisconnectedwithmultipleuplinks.Specifyoneoftheoptionslisted inConnectionOptionsonpage 17inplaceof<conn_options>.
Connectaportgroupwithanuplinkadapter.
esxcli <conn_options> network vswitch standard portgroup policy failover set --active-uplinks=vmnic1,vmnic6,vmnic7
Thiscommandfailssilentlyiftheuplinkadapterdoesnotexist.
Makesomeoftheadaptersstandbyinsteadofactive.
esxcli <conn_options> network vswitch standard portgroup policy failover set --standby-uplinks=vmnic1,vmnic6,vmnic7
Connectaportgroupwithanuplinkadapter.
vicfg-vswitch <conn_options> --add-pg-uplink <adapter_name> --pg <port_group> <vswitch_name>
Thiscommandfailssilentlyiftheuplinkadapterdoesnotexist.
Removeaportgroupfromanuplinkadapter.
vicfg-vswitch <conn_options> --del-pg-uplink <adapter_name> --pg <port_group> <vswitch_name>
SettheVLANIDto4095toallowaportgrouptoreachportgroupslocatedonotherVLAN. SettheVLANIDto0todisabletheVLANforthisportgroup.
AllowportgroupstoreachportgroupslocatedonotherVLANs.
VMware, Inc.
119
esxcli <conn_options> network vswitch standard portgroup set -p <pg_name> --vlan-id 4095
CallthecommandmultipletimestoallowallportstoreachportgroupslocatedonotherVLANs.
DisableVLANforportgroupg42
esxcli <conn_options> network vswitch standard portgroup set --vlan-id 0 -p <pg_name>
SettheVLANIDto4095toallowaportgrouptoreachportgroupslocatedonotherVLAN. SettheVLANIDto0todisabletheVLANforthisportgroup.
AllowallportgroupstoreachportgroupslocatedonotherVLANs.
vicfg-vswitch <conn_options> --vlan 4095 --pg ALL vSwitch2
DisableVLANforportgroupg42.
vicfg-vswitch <conn_options> --vlan 0 --pg g42 vSwitch2
Changeuplinkadaptersettings.
esxcli <conn_options> network nic set <option>
120
VMware, Inc.
Specifyoneofthefollowingoptions.
-a|--auto -D|--duplex=<str> -P | --phy-address -l|--message-level=<long>
-n|--nic-name=<str>
-p|--port=<str>
-S|--speed=<long> -t|--transceiver-type=<str>
SpeedtosetthisNICto.Acceptablevaluesare10,100,1000,and10000. Selecttransceivertype.Thefollowingtransceivertypesareavailable.
externalSetthetransceivertypetoexternal internalSetthetransceivertypetointernal
-w|--wake-on-lan=<str>
SetWake-on-LANoptions.Notalldevicessupportthisoption.Theoptionvalue isastringofcharactersspecifyingwhichoptionstoenable.
(Optional)Bringtheuplinkadapterbackup.
esxcli <conn_options> network nic up --nic-name=vmnic0
Ifyouwanttokeepvmnic0andvmnic1inthearray,youcanmakethoseNICsstandbyuplinksinthe commandthatchangestheactiveuplinks.
esxcli network vswitch standard portgroup policy failover set -p testPortgroup --active-uplinks vmnic3,vmnic5 --standby-uplinks vmnic1,vmnic0,vmnic6,vmnic7
VMware, Inc.
121
Liststheuplinksinthesystem,theircurrentandconfiguredspeed,andtheirduplexsetting. 2 Setthesettingsforvmnic0tofullandthespeedto100.
vicfg-nics <conn_options> -d full -s 100 vmnic0
Setvmnic2toautonegotiateitsspeedandduplexsettings.
vicfg-nics <conn_options> -a vmnic2
Listuplinkadapters.
esxcli <conn_options> network vswitch standard list
TheuplinkadaptersarereturnedintheUplinkitem.
Addanewuplinkadaptertoavirtualswitch.
esxcli <conn_options> network vswitch standard uplink add --uplink-name=vmnic15 vswitch-name=vSwitch0
Removeanuplinkadapterfromavirtualswitch.
esxcli <conn_options> network vswitch standard uplink remove --uplink-name=vmnic15 vswitch-name=vSwitch0
Addanewuplinkadaptertoavirtualswitch.
vicfg-vswitch <conn_options> --link vmnic15 vSwitch0
Removeanuplinkadapterfromavirtualswitch.
vicfg-vswitch <conn_options> --unlink vmnic15 vSwitch0
Youcansettheaddressasfollows.
<X.X.X.X>StaticIPv4address. DHCPUseIPv4DHCP.
VMware, Inc.
123
Thecommanddisplaysthenetworkinformation,portgroup,MTU,andcurrentstateforeachvirtual networkadapterinthesystem. YoucanaddandconfigureanIPv6VMkernelNICwithESXCLI. To add and configure a VMkernel Network Interface for IPv6 1 Runesxcli network ip interface addtoaddanewVMkernelnetworkinterface.
esxcli <conn_options> network ip interface add --interface-name=vmk<x> --portgroup-name=<my_portgroup>
YoucanspecifytheMTUsettingafteryouhaveaddedthenetworkinterfacebyusingesxcli network ip interface set --mtu. Whenthecommandfinishessuccessfully,thenewlyaddedVMkernelnetworkinterfaceisenabled. 2 Runesxcli network ip interface ipv6 address add toconfiguretheinterfaceasanIPv6interface. YoumustspecifytheIPaddressusing--ipandthename.Forthefollowingexamples,assumethat VMSFVMK363isaportgrouptowhichyouwanttoaddaVMkernelnetworkinterface.
esxcli <conn_options> network ip interface ipv6 address add --ip=<X:X:X::/X> --interface-name=vmk<X>
Youcansettheaddressasfollows.
124
VMware, Inc.
ChangetheIPaddressasneeded.
vicfg-vmknic <conn_options> --ip <address> VMSF-VMK-363
ForIPv4,chooseoneofthefollowingformats:
<X.X.X.X>StaticIPv4address. DHCPUseIPv4DHCP.
Youcanlateruse--disable-vmotiontodisablevMotionforthisVMkernelnetworkinterface. 4 ListinformationaboutallVMkernelnetworkinterfacesonthesystem.
vicfg-vmknic <conn_options> --list
Thecommanddisplaysthenetworkinformation,portgroup,MTU,andcurrentstateforeachvirtual networkadapterinthesystem. To add and configure an IPv6 VMkernel Network Interface with vicfg-vmknic 1 Runvicfg-vmknic --addtoaddaVMkernelnetworkinterface. YoumustspecifytheIPaddressbyusing--ip,thenetmask,andtheportgroupname.Forthefollowing examples,assumethatVMSFVMK363isaportgrouptowhichyouwanttoaddaVMkernelnetwork interface. YoucanspecifytheMTUsettingwhenyouaddaVMkernelnetworkinterface.Youcannotchangethat settingatalatertime. Whenthecommandcompletessuccessfully,thenewlyaddedVMkernelnetworkinterfaceisenabled. 2 EnableIPv6.
vicfg-vmknic <conn_options> --enable-ipv6 true VMSF-VMK-363
SupplyanIPv6address.
vicfg-vmknic <conn_options> --ip <ip_address> VMSF-VMK-363
ForIPv6,theIPaddresscanhaveoneofthefollowingformats:
(Optional)EnablevMotion. Bydefault,vMotionisdisabled.
vicfg-vmknic <conn_options> --enable-vmotion VMSF-VMK-363
Youcanlateruse--disable-vmotiontodisablevMotionagain. 5 ListinformationaboutallVMkernelnetworkinterfacesonthesystem.
vicfg-vmknic <conn_options> --list
VMware, Inc.
125
vicfg-vmknic <conn_options> --unset-ip <X:X:X::/X> VMSF-VMK-363 vicfg-vmknic <conn_options> --enable-ipv6 false VMSF-VMK-363
Addanuplinkport.
vicfg-vswitch <conn_options> --add-dvp-uplink <adapter_name> --dvp <DVPort_id> <dvswitch_name>
Removeanuplinkport.
vicfg-vswitch <conn_options> --del-dvp-uplink <adapter> --dvp <DVPort_id> <dvswitch_name>
126
VMware, Inc.
SpecifytheDNSserverusingthe--dnsoptionandtheDNShost.
esxcli <conn_options> network ip dns server add --server=<server>
RunthecommandmultipletimestospecifymultipleDNShosts.
ConfiguretheDNShostnamefortheserverspecifiedby--server(or--vihost).
esxcli <conn_options> system hostname set --host=<new_host_name>
ConfiguretheDNSdomainnamefortheserverspecifiedby--server(or--vihost).
esxcli <conn_options> system hostname --domain=mydomain.biz
ToturnonDHCP,enableDHCPandsettheVMkernelNIC.
TurnonDHCPforIPv4
esxcli <conn_options> network ip interface ipv4 set --type dhcp/none/static esxcli <conn_options> network ip interface ipv4 set --peer-dns=<str>
TurnonDHCPforIPv6
esxcli <conn_options> network ip interface ipv6 set --enable-dhcpv6=true/false esxcli <conn_options> network ip interface ipv6 set --peer-dns=<str>
Listthehostanddomainname.
esxcli <conn_options> system hostname get
ListavailableDNSservers
esxcli <conn_options> network ip dns server list
ListtheDHCPsettingsforindividualVMkernelNICs.
esxcli <conn_options> network ip interface ipv4 get esxcli <conn_options> network ip interface ipv6 get
VMware, Inc.
127
IftheDNSpropertiesareset,andyouwanttochangetheDHCPsettings,youmustspecifythevirtual networkadaptertousewhenoverridingthesystemDNS.OverridetheexistingDHCPsettingasfollows:
esxcli <conn_options> network ip interface ipv4 set --type dhcp/none/static esxcli <conn_options> network ip interface ipv6 set --enable-dhcpv6=true/false
IfDNSisnotsetupforthetargetserver,thecommandreturnsanerror. 2 Tochangethesettings,usevicfg-dnswith--dns,--domain,or--hostname.
SpecifytheDNSserverbyusingthe--dnsoptionandacommaseparatedlistofhosts,inorderof preference.
vicfg-dns <conn_options --dns <dns1,dns2>
ConfiguretheDNShostnamefortheserverspecifiedby--server(or--vihost).
vicfg-dns <conn_options> -n dns_host_name
ConfiguretheDNSdomainnamefortheserverspecifiedby--server(or--vihost).
vicfg-dns <conn_options> -d mydomain.biz
ToturnonDHCP,usethe--DHCPoption.
vicfg-dns <conn_options> --dhcp yes
128
VMware, Inc.
Runvicfg-ntp --starttostarttheservice.
vicfg-ntp <conn_options> --start
Runvicfg-ntp --listtolisttheservice.
vicfg-ntp <conn_options> --list
Runvicfg-ntp --stoptostoptheservice.
vicfg-ntp <conn_options> --stop
Runvicfg-ntp --deletetoremovethespecifiedNTPserverfromthehostspecifiedin<conn_options>.
vicfg-ntp <conn_options> --delete 192.XXX.XXX.XX
ForIPv4networks,noadditionaloptionsarerequired.
vicfg-route <conn_options> --add <network_ip> <netmask_IP> <gateway_ip>
Forexample,toaddarouteto192.XXX.100.0through192.XXX.0.1:
vicfg-route <conn_options> -a 192.XXX.100.0/24 192.XXX.0.1
or
vicfg-route <conn_options> -a 192.XXX.100.0 255.255.255.0 192.XXX.0.1
ForIPv6networks,use--family v6
vicfg-route <conn_options> -f V6 --add <network_ip_and_mask> <gateway_ip>
Forexample:
vicfg-route <conn_options> -f V6 --add 2001:10:20:253::/64 2001:10:20:253::1
Listrouteentriestocheckthatyourroutewasaddedbyrunningthecommandwithoutoptions.
VMware, Inc.
129
vicfg-route <conn_options>
Theoutputlistsallnetworksandcorrespondingnetmasksandgateways. 3 Setthedefaultgateway.
ForIPv4,usethissyntax:
vicfg-route <conn_options> 192.XXX.0.1 or vicfg-route <conn_options> -a default 192.XXX.0.1
ForIPv6,usethissyntax:
vicfg-route <conn_options> -f V6 -a default 2001:10:20:253::1
Runvicfg-route --deletetodeletetheroute.Specifyfirstthegateway,andthenthenetwork.
vicfg-route <conn_options> -d 192.XXX.100.0/24 192.XXX.0.1
Setting Up IPsec
YoucansetInternetProtocolSecuritywithesxcli network ip ipseccommandsorwiththevicfg-ipsec command.whichsecuresIPcommunicationscomingfromandarrivingatESXihosts.Administratorswho performIPsecsetupmusthaveasolidunderstandingofbothIPv6and IPsec. ESXihostssupportIPseconlyforIPv6traffic,butnotforIPv4traffic. IMPORTANTInESX/ESXi4.1,ESXi5.0,andESXi5.1,IPv6isbydefaultdisabled.YoucanturnonIPv6by runningoneofthefollowingvCLIcommands:
esxcli <conn_options> network ip interface ipv6 set --enable-dhcpv6 esxcli <conn_options> network ip interface ipv6 address add vicfg-vmknic <conn_options> --enable-ipv6
130
VMware, Inc.
Theactionisspecifiedbythefollowingoptions
vicfg-ipsec sa-name sp-name action (none, discard, ipsec esxcli network ip ipsec --saname --spname --action
BecauseIPsecallowsyoutotargetpreciselywhichtrafficshouldbeencrypted,itiswellsuitedforsecuring yourvSphereenvironment.Forexample,youcansetuptheenvironmentsoallvMotiontrafficisencrypted.
VMware, Inc.
131
YoucanperformthesemaintaskswithSAs:
ListanSAwithesxcli network ip ipsec sa list.ThiscommandreturnsSAscurrentlyavailable forusebyanSP.ThelistincludesSAsyoucreated. RemoveasingleSAwithesxcli network ip ipsec sa remove.IftheSAisinusewhenyourunthis command,thecommandcannotperformtheremoval. RemoveallSAswithesxcli network ip ipsec sa remove--removeall.ThisoptionremovesallSAs evenwhentheyareinuse. CAUTIONRunningesxcli network ip ipsec sa remove--removeallremovesallSAsonyour systemandmightleaveyoursysteminaninconsistentstate.
132
VMware, Inc.
Mode,eithertunnelortransport. NameoftheSAtousebythisSP.
YoucanperformthesemaintaskswithSPs:
ListanSPwithesxcli network ip ipsec list.ThiscommandreturnsSPscurrentlyavailable.All SPsarecreatedbytheadministrator. RemoveanSPwithesxcli network ip ipsecremove.IftheSPisinusewhenyourunthiscommand, thecommandcannotperformtheremoval.Youcanrunesxcli network ip ipsecremove --removeallinsteadtoremovetheSPevenwhenitisinuse. CAUTIONRunningesxcli network ip ipsecremove --removeallremovesallSPsonyoursystem andmightleaveyoursysteminaninconsistentstate.
Name --------sshServer
Enabled ------true
EnablethesshServerrulesetifitisdisabled.
esxcli <conn_options> network firewall ruleset set --ruleset-id sshServer --enabled true
ObtainaccesstotheESXiShellandcheckthestatusoftheallowedAllflag.
esxcli <conn_options> network firewall ruleset allowedip list --ruleset-id sshServer Ruleset Allowed IP Addresses --------- -------------------sshServer All
SeeGettingStartedwithvSphereCommandLineInterfacesforinformationonaccessingtheESXiShell. 4 SetthestatusoftheallowedAllflagtofalse.
esxcli <conn_options> network firewall ruleset set --ruleset-id sshServer --allowed-all false
AddthelistofallowedIPaddresses.
esxcli <conn_options> network firewall ruleset allowedip add --ruleset-id sshServer --ip-address 192.XXX.1.0/24 esxcli <conn_options> network firewall ruleset allowedip add --ruleset-id sshServer --ip-address 192.XXX.10.10
ChecktheallowedIPaddresslist.
esxcli <conn_options> network firewall ruleset allowedip list --ruleset-id sshServer Ruleset Allowed IP Addresses --------- ----------------------------sshServer 192.XXX.10.10, 192.XXX.1.0/24
134
VMware, Inc.
10
10
UsingresxtopforPerformanceMonitoringonpage 135 ManagingDiagnosticPartitionsonpage 135 ManagingCoreDumpsonpage 136 ConfiguringESXiSyslogServicesonpage 138 ManagingESXiSNMPAgentsonpage 139 RetrievingHardwareInformationonpage 141 ESX,ESXi,andVirtualMachineLogsonpage 142
VMware, Inc.
Deactivatethecurrentdiagnosticpartition.
esxcli <conn_options> system coredump partition set --unconfigure
TheESXisystemisnowwithoutadiagnosticpartition,andyoumustimmediatelysetanewone. 3 Settheactivepartitiontonaa.<naa_ID>.
esxcli <conn_options> system coredump partition set --partition=naa.<naa_ID>
Listpartitionsagaintoverifythatadiagnosticpartitionisset.
136
VMware, Inc.
Ifadiagnosticpartitionisset,thecommanddisplaysinformationaboutit.Otherwise,thecommand showsthatnopartitionisactivatedandconfigured.
(Optional)CheckthatESXiDumpCollectorisconfiguredcorrectly.
esxcli <conn_options> system coredump network get
ThehostonwhichyouhavesetupESXiDumpCollectorsendscoredumpstothespecifiedserverbyusing thespecifiedVMkernelNICandoptionalport.
Displayinformationaboutallpartitionsthatcanbeusedasdiagnosticpartitions.Use-ltolistall diagnosticpartitions,-ftolistalldiagnosticpartitionsinorderofpriority.
vicfg-dumppart <conn_options> -f
Theoutputmightappearasfollows.
Partition name on vml.mpx.vmhba36:C0:T0:L0:7 -> mpx.vmhba36:C0:T0:L0:7
Deactivatethediagnosticpartition.
vicfg-dumppart <conn_options> -d
TheESXisystemisnowwithoutadiagnosticpartition,andyoumustimmediatelysetanewone. 4 Settheactivepartitiontonaa.<naa_ID>.
vicfg-dumppart <conn_options> -s naa.<naa_ID>
VMware, Inc.
137
Runvicfg-dumppart -tagaintoverifythatadiagnosticpartitionisset.
vicfg-dumppart <conn_options> -t
Ifadiagnosticpartitionisset,thecommanddisplaysinformationaboutit.Otherwise,thecommand informsyouthatnopartitionisset.
Remotehostandport.RemotehosttowhichSyslogmessagesareforwardedandportonwhichthe remotehostreceivesSyslogmessages.Theremotehostmusthavealoglistenerserviceinstalledand correctlyconfiguredtoreceivetheforwardedsyslogmessages.Seethedocumentationforthesyslog serviceinstalledontheremotehostforinformationonconfiguration. Transportprotocol.LogscanbesentbyusingUDP(default),TCPorSSLtransports. Localloggingdirectory.Directorywherelocalcopiesofthelogsarestored.Thedirectorycanbelocated onmountedNFSorVMFSvolumes.Onlythe/scratchdirectoryonthelocalfilesystemispersistent acrossreboots. Uniquedirectorynameprefix.SettingthisoptiontotruecreatesasubdirectorywiththenameofESXi hostunderthespecifiedloggingdirectory.ThismethodisespeciallyusefulifthesameNFSdirectoryis usedbymultipleESXihosts. Logrotationpolicies.Setsmaximumlogsizeandthenumberofarchivestokeep.Policiescanbespecified bothglobally,andforindividualsubloggers.Forexample,youcansetalargersizelimitforthevmkernel log.
IMPORTANTTheesxcli system syslogcommandistheonlysupportedcommandforchangingESXi5.0 loggingconfiguration.Thevicfg-syslogcommandandeditingconfigurationfilesisnotsupportedforESXi 5.0andcanresultinerrors. Aftermakingconfigurationchanges,restartthesyslogservice(vmsyslogd)byrunningesxcli system syslog reload. Theesxcli system syslogcommandallowsyoutoconfiguretheloggingbehaviorofyourESXisystem. WithvSphere5.0,youcanmanagethetoplevelloggerandsubloggers.Thecommandhasthefollowing options.
Option mark reload config get config set Description Marksalllogswiththespecifiedstring. Reloadstheconfiguration,andupdatesanychangedconfigurationvalues. Retrievesthecurrentconfiguration. Setstheconfiguration.Useoneofthefollowingoptions.
138
VMware, Inc.
esxcli system syslog Examples Thefollowingworkflowillustrateshowyoumightuseesxcli system syslogforlogconfiguration.Specify oneoftheoptionslistedinConnectionOptionsonpage 17inplaceof<conn_options>. 1 Showconfigurationoptions.
esxcli <conn_options> system syslog config get Default Rotation Size: 1024 Default Rotations: 8 Log Output: /scratch/log Logto Unique Subdirectory: false Remote Host: <none>
Setalllogstokeeptwentyrotationsbeforeoverwritingtheoldestlog.
esxcli <conn_options> system syslog config set --default-rotate=20
SettherotationpolicyforVMkernellogsto10rotations,rotatingat2MB.
esxcli <conn_options> system syslog config logger --id=vmkernel --size=2048 --rotate=10
Sendlogstoremotehostmyhost.mycompany.com.Thelogswillusethedefaulttransport(UDP)andport (514).
esxcli system syslog config set --loghost='myhost.mycompany.com'
Savethelocalcopyoflogsto/scratch/mylogsandsendanothercopytotheremotehost.
esxcli <conn_options> system syslog config set --loghost='tcp://myhost.mycompany.com:1514' --logdir='/scratch/mylogs'
Reloadthesyslogdaemonandapplyconfigurationchanges.
esxcli <conn_options> system syslog reload
VMware, Inc.
139
Eachtimeyouspecifyacommunitywiththiscommand,thesettingsthatyouspecifyoverwritetheprevious configuration.
140
VMware, Inc.
(Optional)EnabletheSNMPagentifitisnotyetrunning.
vicfg-snmp <conn_options> --enable
(Optional)Sendatesttraptoverifythattheagentisconfiguredcorrectly.
vicfg-snmp <conn_options> --test
TheagentsendsawarmStarttraptotheconfiguredtarget.
(Optional)IftheSNMPagentisnotenabled,enableit.
vicfg-snmp <conn_options> --enable
Runvicfg-snmp --testtovalidatetheconfiguration.
Thefollowingexampleshowshowthecommandsareruninsequence.
vicfg-snmp <conn_options> c public t example.com@162/private --enable # next validate your config by doing these things: vicfg-snmp <conn_options> -test walk v1 c public esx-host
VMware, Inc.
141
esxcli hardware ipmi sel get esxcli hardware ipmi sdr get
142
VMware, Inc.
Index
Numerics
3.5 LUN masks 95
A
Active Directory 25, 26 active path 47 ARP redirect 74 authentication algorithm (IPsec) 132 default inheritance 61 key (IPsec) 132 returning to default inheritance 61 AUTOCONF 125
local 136 managing 137 cp850 encoding 18 cp936 encoding 18 creating directories 35
D
datastores mounting 30 NFS 50 overview 41 default gateway 130 default inheritance 61, 78, 79 default port groups 116 dependent hardware iSCSI 57, 68, 73 device 41 device management 44, 86 device mappings 43, 44 device naming device UID 41 runtime name 41 VML name 41 Device UID 41 DHCP 127, 128 DHCPV6 125 diagnostic partitions creating 136 example 136, 137 managing 135 directory management 37 directory names with special characters 34 discovery sessions 58 discovery targets 59 disk file path 54 distributed switches 111, 112, 113, 115 DNS 126, 127, 128 downloading files 34 duplicate datastores 29 dynamic discovery 58
B
backing up configuration data 24
C
CDP 116, 117, 118 Challenge Handshake Authentication Protocol 60 changing IP gateway 129 CHAP 60 chapDiscouraged 60 chapPreferred 60 chapProhibited 60 chapRequired 60 Cisco Discovery Protocol 116 claim rules adding 93 converting 95 deleting 96 from 3.5 systems 95 from LUN mask 95 listing 96 loading 96 moving 97 rule IDs 95 running 97 commands with esxcfg prefix 12 configuration data backing up 24 restoring 24 configuration files, path 54 copying files 34 core dumps 136 ESXi Dump Collector 137
E
encoding cp936 18 Shift_JIS 18 encodings cp850 18
VMware, Inc.
143
encryption algorithm (IPsec) 131 encryption key (IPsec) 131 ESX/ESXi logs 142 esxcfg prefix 12 esxcli network ip commands 123 esxcli network ip dns 127 esxcli network nic commands 120 esxcli network vswitch commands 116, 118, 122 esxcli storag nfs commands 51 esxcli storage core claiming commands 92 claimrule commands 93 claimrule convert commands 95 claimrule delete command 96 claimrule list command 96 claimrule load command 96 claimrule move command 97 claimrule run command 97 device list 42 esxcli storage core adapter rescan 55 esxcli storage core claiming reclaim command 92 unclaim command 92 esxcli storage core path 45, 47 esxcli storage nmp 85 device list command 86 device set command 86 fixed deviceconfig commands 88 path list command 86 psp commands 86, 87 psp roundrobin commands 88 roundrobin 50, 89 satp commands 89 esxcli system coredump 136 ESXi Dump Collector 135, 137 EUI name 45, 46, 59 examples backup with vMA 24 configure VMkernel NIC for IPv4 123 configure VMkernel NIC for IPv6 124 DNS setup 127 enable and set NetQueue modules 25 entering maintenance mode 22, 23 iSCSI storage setup 66, 68, 71, 73 managing users 101 route entry setup 129 svmotion 54 uplink adapter setup 120 external HBA properties 76
FC LUNs 41 Fibre Channel LUNs 41 file management introduction 27 vifs 28, 37 file path, configuration file 54 file systems NAS 51 VMFS 29 fixed path selection policy 88
G
gateway, IP 129 groups 99, 102
H
hard power operations 108 hardware iSCSI setup tasks 70, 74 HBA mappings 44 HBA properties 76 hosts managing 21 shutdown or reboot 21
I
ifconfig, ESXCLI equivalents 113 independent hardware iSCSI definition 57 setup tasks 70, 74 inheritance 79 IP gateway 129 IP storage 112 IPsec 130 IPv4 123, 124 IPv6 124, 125 IQN name 59 iSCSI authentication 61, 80, 81 default inheritance 78, 79 dependent hardware iSCSI 68, 73 discovery target names 59 independent hardware iSCSI 70, 74 LUNs 41 mutual authentication 80, 81 options 75 overview 57 parameters 77, 78 parameters, returning to default inheritance 78, 79 port binding 68, 73 ports for multipathing 81 remove sessions 83 securing ports 60
F
failover 44
144
VMware, Inc.
Index
O
offload iSCSI 57 orphaned virtual machine 104
K
Kerberos 129
L
license 53 listing available LUNs 42, 43 listing IP gateway 129 loading claim rules 96 lockdown mode 19 logical devices, listing 44 logs 142 LUN masks, convert to claim rule 95 LUNs listing available 42, 43 names 45, 46 overview 42
P
parameters default inheritance (iSCSI) 79 setting (iSCSI) 78 partitions, diagnostic 136 path change conditions for round robin 89 path claiming 92 path operations 86 path policies 47, 88, 89 path state, changing 47 paths active 47 changing state 47 disabling 47 identifier 41 listing 46 listing with ESXCLI 45 managing 44 preferred 49, 50, 88 performance monitoring 135 physical network interfaces 120 platform support 14 Pluggable Storage Architecture 44 port binding 68, 73, 82 port groups 112, 119, 120 adding 118 and uplink adapter 119 default 116 removing 118 ports, iSCSI multipathing 81 power operations 108 powerop_mode 108 preferred path 49, 50, 88 PSA 44 acronym 85 managing claim rules 93 PSP acronym 85 information 87 operations 86
M
MAC address, VMkernel NIC 123 MagicPacket 121 maintenance mode 22, 23 Managing 44, 57, 120 managing 136 managing local core dumps 136 managing NMP 85 managing paths 44 managing physical network interfaces 120 migrating virtual machines,svmotion 52 mount datastores 30 MTU 117, 118 multipathing 44, 45 mutual authentication 80, 81 mutual CHAP 67, 69, 72, 74, 80, 81
N
naa.xxx device name 45, 46 NAS datastores, datastores, NAS 50 NAS file systems 51 NetQueue VMkernel modules 25 network adapters duplex value 120 managing 120 speed 120 network interfaces 115, 120 networking vDS 126 vSS 115 NFS datastores 50 NFS, capabilities 51
R
raw devices 41 rebooting hosts 21 register virtual machines 105 removing snapshots 107
145
VMware, Inc.
rescanning adapters 55 rescanning storage 41, 55 rescanning storage adapters 55 resignature VMFS copy 31 restoring configuration data 24 resxtop 12, 135 reverting snapshots 107 RFCs (vicfg-ipsec) 130 roles 99 round robin operations 50, 88 path change conditions 89 retrieve settings 89 route entry setup 129 rule IDs 95 rules 91 claim rules 93 SATP rules 91 runtime name 41
rescanning 41, 55 virtual machines 40 storage array target 42 storage device naming 41 supported platforms 14 svmotion 52 interactive Mode 53 license for storage vMotion 53 limitations 53 noninteractive mode 53 requirements 53 special characters 53 switch attributes 117, 118 syslog server specification 138
T
TCP Segmentation Offload 123 TCP/IP 70, 74, 112 transport mode 131 TSO 123 tunnel mode 131
S
SATP configuration parameters 91 deleting rules 91 retrieve settings 89 rules, adding 90 securing iSCSI ports 60 security associations (IPsec) 131 security policies (IPsec) 132 sessions, iSCSI 83 Shift_JIS encoding 18 Simple Network Management Protocol 139 snapshots 106, 107 SNMP communities 140 management 139 polling 141 traps 140 soft power operations 108 software iSCSI setup tasks 66, 68, 71, 73 spaces in directory names 34 special characters in directories 34 vicfg-iscsi 77, 79 standard networking services 126 starting NTP server 129 state of path, changing 47 static discovery 58 stopping virtual machines 109 storage creating directories with vifs 35 overview 39 path claiming 92
146
U
unregister virtual machines 105 uplink adapters 112, 120 and port groups 119 setup 122 useANO (round robin) 50 user input 109 users creating 101 in vSphere environment 99 modifying 101
V
VDS 111 vicfg-authconfig 25 vicfg-cfgbackup 23, 24 vicfg-dumppart 136, 137 vicfg-hostops 21, 22 vicfg-ipsec 131, 132 vicfg-iscsi command syntax 61 default inheritance for authentication 61 default inheritance for parameters 78, 79 iscsi parameter options 79 vicfg-module 24 vicfg-mpath 46 vicfg-nas 50, 51 vicfg-nics 122 vicfg-ntp 129 vicfg-rescan 55, 72, 73 vicfg-scsidevs
VMware, Inc.
Index
3.5 support 43 list options 43 vicfg-snmp 139 vicfg-syslog 138 vicfg-user 99, 100, 102 vicfg-vmhbadevs 42, 43 vicfg-vmknic 123 vicfg-volume 29 vicfg-vswitch 115, 118 vifs 28, 33 virtual devices 108 virtual machine configuration file path 54 virtual machines attributes 105 file management 27 listing 104, 105 logs 142 managing 105 migration with svmotion 52 network settings 113 orphaned 104 path 104 registering 104, 105 starting 107 stopping 109 storage VMotion 52 vmware-cmd 105 virtual switches 111, 115, 116 MTU 117, 118 retrieving information 116 vicfg-vswitch 115 VLAN ID 119, 120 VMFS duplicate datastores 29 resignature copy 30 resignaturing 31 VMFS3 to VMFS5 conversion 29 VMkernel modules 24 VMkernel network interfaces 123 VMkernel NIC 123 enable VMotion 125 IPv4 123, 124 IPv6 124, 125 VMkernel NICs 123 vmkfstools 28 VML LUN names 45, 46 VMotion 112, 125 VMW_PSP_FIXED 48 VMW_PSP_MRU 48 VMW_PSP_RR 48 vmware-cmd connection options 104
general options 104 server options 104 snapshots 106 virtual machine options 105 VMware Tools 108 vSphere distributed switches 113, 126 VSS 111
W
Windows Active Directory 26
VMware, Inc.
147
148
VMware, Inc.