6.5

VMware, Inc. 63
Chapter B Credential Store Perl Library
vSphere Credential Store Subroutine Reference
TheViCredStorepackageincludesthefollowingsubroutines:
 “init”onpage 63
 “get_password”onpage 63
 “add_password”onpage 64
 “remove_password”onpage 64
 “clear_passwords”onpage 64
 “get_hosts”onpage 64
 “get_usernames”onpage 64
 “close”onpage 65
init
Initializesthecredentialstore.Callthissubroutineonce,beforeanyoftheothercredentialstoresubroutines.
Thecredentialstoreisnotcreateduntilyourprogramcallsadd_password.
Thissubroutineacceptsthelocationofthecredentialstorefile.Ifyoudonotprovideacredentialstorefilename
VICredStore::init()looksinthe
defaultlocation.
 Linux:$HOME/.vmware/credstore/vicredentials.xml
 Windows:%APPDATA%\VMware\credstore\vicredentials.xml
Ifnocredentialstoreexistsatthedefaultlocation,theinitializationprocess:
 Checksthatthecredstoredirectoryexists,andcreatesoneifitdoesnot.
 Createsthevicredentials.xmlfileandparentdirectory.
Ifyouprovideanon‐defaultcredentialstorefilenametoVICredStore::init(),thecredentialstoreatthat
locationisused.Ifthereisnocredentialstoreatthatlocationandthedirectoryyouspecifyexists,the
initializationprocesscreatesthefile.Ifthedirectory
youspecifydoesnotexist,theinitializationprocessfails.
Parameters
Returns
Returns1ifinitializationissuccessful;otherwise,returns0.
get_password
Retrievesthepasswordforaspecifiedserverandusername.
Parameters
Returns
Returnsthepassword,orundefifnopasswordisfound.
Parameter Description
filename Nameofcredentialstorefile.
Parameter Description
server Serverforwhichyouwanttoretrievethepasswordforthespecifieduser.CanbeanESX/ESXi
orvCenterServersystem.
username Userforwhomyouwanttoretrievethepassword.