Lookup.xml File - SQL-FineBuild/Common GitHub Wiki
Previous Install Audit Folder | FineBuild State File Next |
---|
The Lookup.xml file allows all passwords used by SQL FineBuild to be stored in a single file which can be encrypted. The use of this file is optional within SQL FineBuild.
It is planned that a future version of SQL FineBuild will encrypt this file, but the current version of FineBuild does not encrypt this file. To allow encryption of passwords with the current version of SQL FineBuild, the following process is suggested:
- Create an encrypted version of Lookup.xml using a different name
- Decrypt that file and call it Lookup.xml when it is desired to run SQL FineBuild
- Delete Lookup.xml when the SQL FineBuild processing is finished
Where a password is obtained from Lookup.xml, the value of that password is held only in memory and never written to any permanent storage
Location of Lookup.xml
SQL FineBuild will always look for Lookup.xml in the Site SQL Files Folder
Format of Lookup.xml
Lookup.xml is a simple XML file with one root node and a series of attributes, one attribute for each password
A simple example of a Lookup.xml file is shown below. The file has a single attribute holding the password for the APPGB_SQLCS_0001 account. Other passwords would be stored as separate attributes
<ROOT APPGB_SQLCS_0001="j25Fb*ef$36ySIyBW7hZ" />
Forcing Lookup processing in SQL FineBuild
Any parameter that matches one of the following formats can have its value taken from the Lookup.xml file. Always use upper case for the attribute name within Lookup.xml
Item | Attribute Name |
---|---|
Contains Password | The account to which the password applies. Do not include any domain with the account name |
Contains Pwd | The account to which the password applies. Do not include any domain with the account name |
Contains Passphrase | The same as the parameter name |
Contains PID | The same as the parameter name The /PID: parameter cannot be included in Lookup.xml |
In order to perform a lookup for one of the above parameters, use the value lookup for that parameter. For example, if the value of /CmdShellAccount: is ROOT\APPGB_SQLCS_0001 then using the parameter below will cause the password for the CmdShell Account to be retrieved from Lookup.xml:
/CmdShellPassword:lookup
Copyright FineBuild Team © 2021. License and Acknowledgements
Previous Install Audit Folder | Top | FineBuild State File Next |
---|