6.0
Table Of Contents
- Getting Started with vSphere Command-Line Interfaces
- Contents
- About This Book
- Managing vSphere with Command-Line Interfaces
- Installing vCLI
- Running Host Management Commands in the ESXi Shell
- Running vCLI Host Management Commands
- Overview of Running vCLI Host Management Commands
- Protecting Passwords
- Authenticating Through vCenter Server and vCenter Single Sign-On
- Authenticating Directly to the Host
- Trust Relationship Requirement for ESXCLI Commands
- Common Options for vCLI Host Management Command Execution
- Using vCLI Commands in Scripts
- Running Host Management Commands from a Windows System
- Running Host Management Commands from a Linux System
- Running DCLI Commands
- Index
VMware, Inc. 41
Chapter 5 Running DCLI Commands
Running DCLI Commands
YoucandisplayhelpinformationforDCLIcommands,andrunthecommandsfromasystemwherevCLIis
installed,fromthevCenterServerApplianceshell,orfromavCenterServeronWindowscommandprompt.
Displaying Help Information for DCLI Commands
Youcandisplayhelpforeachnamespaceandcommandbyusingthe--helpcommand‐lineoption.Because
theavailablecommandsdependentirelyontheservicesthatareavailableinthevCenterenvironmentthatyou
aretargeting,youmustincludetheserverforaccuratehelpinformation.Helpreturnsthefollowing
informationfor
acommand:
Eachinputoption
Whethertheoptionisrequired
Inputtype
formatter Outputformatter,oneofthefollowing:
simple
table
xml
json
html
csv
Defaultistableforlistsof
structuresandsimplefor
allotheroutput.
loglevel Theloglevel,oneofdebug,info,warning,orerror. info
username Ifyourunfromthelocalshell,mostDCLIcommandsdonot
requiretheusername.IfyouarerunningvCLIcommands,theuser
youspecify
mustbeabletoauthenticatetothevCenterServer
system.
Theuseryouspecifymusthavetheprivilegestoperformthetask,
asspecifiedthroughvCenterServerroles.
Youarepromptedforthepassword.Thepasswordisnotechoedto
screen.
credstore-file Pathtothecredentialstorefiletousefor
credentialstoreoperations
orforreadinglogincredentials.
Usethisoptiononlyifthedefaultcredentialstorefilenamedoes
notworkinyourenvironment.
Bydefault,thecredentialstorefileisinthe
.dcli\.dcli_credstoredirectoryinsidethehomedirectory.
$HOME/.dcli/.dcli_cr
edstore
credstore-add Addslogincredentialsenteredforacommandto
theDCLI
credentialstorefile.
ThisoptionstorestheserverIPaddress,sessionmanager,
usernameandpasswordforthecommandbeingexecuted.Ifan
entryalreadyexists,thecommandupdatestheentry.
dclidirectoryinsidethe
homedirectory.
$HOME/dcli
credstore-remove RemovesanentryfromtheDCLIcredentialstorefile.
Thisoptionremoves
theentryforaspecifiedserverIPaddressand
usernameifonlyonesessionmanagerispresentforatargetserver
anduser.
Inrarecases,informationaboutmultiplesessionmanagerentries
ispresent.Youhavetoprovidethesessionmanagerwiththe
session-manager option.
credstore-list Listsallentriesstoredinthe
DCLIcredentialstorefile.Eachentry
includestheserverIPaddress,sessionmanager,andusername.
session-manager Usethisoptionifyouusethecredstore-removeoptionthesame
usernameandpasswordarestoredthroughmultiplesession
managers.Notusuallyrequired.
Table 5-1. DCLI Options
Option Description Default