6.0

vSphere SDK for Perl Programming Guide
62 VMware, Inc.
 Apersistencefileusedtostoreauthenticationcredentials.Currently,onlypasswordsaresupported.The
persistencefilemapsaremoteuseraccountfromanESX/ESXihosttothatuser’spasswordonthehost.
 vSphereWebServicesSDK(C#andJav a)andvSphereSDKforPerllibrariesforprogrammatically
managingthefile.vSphereWebServicesSDKandvSphereSDKforPerlaccessthesamecredentialstore.
Credential Store Components
ThevSphereSDKforPerlincludestwocredentialstorefilesinitsinstallationpackage:
 VICredStore.pm–ThePerlpackageforthecredentialstorelibrarylocatedin:
Windows: \Program Files\VMware\VMware vSphere CLI\Perl\lib\VMware\VICredStore.pm
Linux: /usr/lib/perl5/site_perl/5.8.8/VMware/VICredStore.pm
Perlapplicationscanusethispackagetoadd,retrieve,delete,update,andlisttheentriesstoredinthe
credentialstore.Theapps/general/credstore_admin.plfileisanexampleforcredentialstoreuse.
Eachentryinthecredentialstoreisatupleofhostname,username,andpassword.Thepasswordis
storedin
anobfuscatedmannerinthecredentialstore.
 credstore_admin.pl—APerlapplicationthatusesVICredStore.pmforaccessingthecredentialstore.
Youcanusecredstore_admin.pl,whichisanexample,asacommand‐lineinterfacetothecredential
store.credstore_admin.plislocatedin:
Windows: \Program Files\VMware\VMware vSphere CLI\Perl\apps\general\credstore_admin.pl
Linux: /usr/lib/vmware-viperl/apps/general/credstore_admin.pl
Managing the Credential Store
YoucanusePerltomanagethecredentialstoreinoneoftwoways:
 UsethesubroutinesinVICredStore.pminyourPerlscript.See“vSphereCredentialStoreSubroutine
Reference”onpage 63forreferencedocumentation.Thecredstore_admin.plscriptillustrateshowto
usethesubroutines.
 Usethe\apps\general\credstore_admin.plcommandstomanagethestoreinteractively.
Using the Credential Store
Afteryouhavesetupthecredentialstorewithusersandpasswords,youcanusethecredentialsasfollows:
 InyourownPerlscripts,youcanretrievepasswordsorotherinformationasneededusingthelibrary
subroutine.
 WhenyourunanexistingvSphereSDKforPerlorvSphereCLIscript,youcanspecifythehostanduser
nameeitherfromthecommandlineorinanenvironmentvariable.Whenthathostandusernamehasan
entrywithavalidpasswordinthecredentialstore,thescriptis
run.
 Ifyourunascriptthatincludesahostnamebutnouser,andifthecredentialstorecontainsexactlyone
entryforthathost,thescripttakestheuserfromthatcredentialstoreentryandnotpromptforauser.
 WhenyoucallanexistingvSphereSDKforPerlorvSphereCLIscript,andyouspecifyonlythehostname,
theauthenticationmechanismpromptsforausername.Ifnoentryexistsforthatuser,theauthentication
mechanismalsopromptsforapassword.
I
MPORTANTThepasswordsinthefileareobfuscatedbutnotencrypted.Youmustprotectthefilebyother
meansandcarefullycontrolwhocanaccessit.
IMPORTANTCreateauserwithappropriateprivilegesandstorethecorrespondingusernameandpassword
inthecredentialstore.Donotusetherootoradministratoruserandthecorrespondingpassword.