using sysprep with altiris deployment solution v3

Using Sysprep withAltiris Deployment Solution Produced By Customer Support Altiris, Inc.September 28, 2004Version Information:This document only applies to images created for Windows 2000 and Windows XP and using Altiris Deployment Solution version 6.0 and above.WHITE PAPERNoticeThe content in this document represents the current view of Altiris as of the date of publication. Because Altiris responds c ontinually to changing market conditions, thi s document should not be interpreted as a commitment on the part of Altiris. Altiris cannot guarantee the accuracy of any information presented after the date of publication.Copyright © 2004, Altiris, Inc. All rights reserved.Altiris, Inc.588 West 400 SouthLindon, UT 84042P hone: (801) 226-8500Fax: (801) 226-8506BootWorks U.S. P atent No. 5,764,593.RapiDeploy U.S. P atent No. 6,144,992.Altiris, BootWork s, Inventory Solution, P C Transplant, RapiDeploy, and RapidInstall are registered trademarks of Altiris, Inc. in the United States.Carbon Copy is a registered trademark licensed to Altiris, Inc. in the United States and a registered trademark of Altiris, Inc. in other countries.Microsoft, Windows, and the Windows logo are trademarks, or registered trademarks of Microsoft Corporation in the United States and/or other countries.Other brands and names are the property of their respective owners.Information in this document is subject to change without notice. For the latest documentation, visit .ContentsOVERVIEW (4)HIGH-LEVEL VIEWS (5)Using Token Replacement to create SYSPREP.INF (5)Using the default SYSPREP.INF created by AClient (5)DETAILED PROCESS REVIEWS (7)Using Token Replacement to create SYSPREP.INF (7)Using the default SYSPREP.INF created by AClient (9)ADVANCED / CUSTOM IMAGING: OTHER OPTIONS (11)Scenario 1: AClient is not in the image (11)Scenario 2: The image will be going to dissimilar machines (hardware) (11)APPENDIXES (12)Appendix A: Sample Sysprep.INF file as created by AClient (12)Appendix B: Example of a SYSPREP.INF file using Tokens (13)Appendix C: Sample Script using Token Replacement to create SYSPREP.INF (14)OVERVIEWWhen “imaging” or “duplicating” machines became more common, Microsoft developed Sysprep to help ensure that the duplicated machine would work properly on new hardware, and be unique on the network. Deployment Solution is able to assist using Sysprep, to ensure the machines function correctly, and require little or no actual hands-on configuration.Remember that Sysprep is a Microsoft product, and is supported by Microsoft. Altiris supports configuring Deployment Solution to use Sysprep, but cannot support the product or its functions.There are really two methods Altiris recommends when using Sysprep. Those two methods are:ing Token Replacement to create SYSPREP.INFing the default SYSPREP.INF created by AClientBoth will be discussed at a high level and in detail. There are advantages and disadvantages to each. Altiris recommends at least a review of both in making a decision.Additionally, there will be a section discussing where to go for more information relative to advanced use of the products. At the end of the document will be the appendixes with examples mentioned in the processes that follow.HIGH-LEVEL VIEWSUsing Token Replacement to create SYSPREP.INFBecause of the tight integration of Sysprep with the operating system, there are some advantages to allowing Sysprep to configure the machine. Some customers have found increased reliability of their results, but the work involved is more than with the other option. There is also more flexibility in this method for managing hardware and other OS configurations such as follow-up scripting.At a high level, the process looks like this:1.Install AClient on the source machine (the machine that will be used to create the image)and include Sysprep.2.Create a “SYSPREP.TXT” file in the temp folder under the Express Share. This file is thetemplate file used in the Token Replacement process, and will include all settings andcommands issued to Sysprep, or run during the Mini Setup.3.Send a job to the source machine to capture the image. This will run Sysprep on themachine and shut it down for imaging. On reboot, RDeploy will then capture the image.4.Create an imaging job for recipient machines (either as an Initial Deployment job, orstand-alone) to receive this image. The second task in this job will perform the TokenReplacement process, creating a customized SYSPREP.INF file for the machine.5.The recipient machines are then imaged. Once the image has been received, themachine will reboot, the Mini Setup will run and read the customized SYSPREP.INF file to perform any necessary machine configurations.6.Since AClient is in the image, when the image process is complete, the new machine willautomatically “report in” to the Deployme nt Server.Using the default SYSPREP.INF created by AClientThe main advantage of this process is that there is no need to fully understand Sysprep. Altiris has created a basic process that can be used with most basic imaging needs. However, it is less flexible (i.e. it requires using similar hardware for the source and destination machines) and with Windows XP images it currently requires modifying the image after it has been captured. It is probably the faster process though.At a high level, the process looks like this:1.Install AClient on the source machine that will be used to create the image, and includeSysprep.2.Create a “Sysprep.w2k” file in the Express Share with the Produc t Key for the OS beingimaged. This is to prevent the recipient machines from being prompted for a license.3.Send a job to the source machine to capture the image. This will run Sysprep on themachine and shut it down for imaging. On reboot, RDeploy will then capture the image.a.Troubleshooting Note: When using Windows XP, it will be necessary to modifythe image before deploying it, otherwise there will be a prompt for a product IDduring the Mini Setup.4.Create an imaging job for recipient machines, either as an Initial Deployment job, orstand-alone, including the option to allow AClient to configure the machine.5.Image the machine and allow it to reboot. The Mini Setup will run first, and sinceAClient is in the image, AClient will finish configuring the machine.DETAILED PROCESS REVIEWSUsing Token Replacement to create SYSPREP.INFThis will discuss in more details what goes on behind the scenes, and what you will have to do to make this work correctly.1.Install AClient to the source machine, and select the option to include Sysprep.a. A prompt will appear requesting the location of the DEPLOY.CAB file, which is onthe OS Installation CD for the target client’s OS.b.DEPLOY.CAB will be copied i nto the Altiris\AClient folder, or different folder if adifferent location was specified, for future use.c.Troubleshooting Note: Sysprep is OS dependant, and the correct DEPLOY.CABfrom the associate original OS CD must be used, or downloaded from Microsoft.d.Troubleshooting Note: If DEPLOY.CAB is not in the AClient folder for any reason,it can be copied there either manually or with a job.2.Create a SYSPREP.TXT file in the temp folder under the Express share.a.This file will be a template file for SYSPREP.INF file. It is a plain text file and willlook similar to what is in Appendix B.b.This file should have a number of Tokens in it – variables that will be replaced byspecific information in the Deployment Server database to customize the file forthe recipient machine. Again, see Appendix B.c.Troubleshooting Note: Sysprep is OS dependant and Altiris does not recommendusing the same template file for different Operating Systems.d.Troubleshooting Note: This process is very particular. Altiris stronglyrecommends becoming familiar with the format of this file to avoid problemsduring imaging. A good place to start is at/default.aspx?scid=kb;en-us;2984913.Schedule a job to capture the image.a.This will prompt AClient to prepare the machine for imaging, and if DEPLOY.CABis present, AClient will extract all the necessary Sysprep information.b.AClient will then execute SYSPREP.EXE which will do additional preparations, andthen shut-down.c.Troubleshooting Note: If DEPLOY.CAB i s not present, the process will “look” justlike above, in that the machine will automatically shut down. However, the resultwill be different. Unfortunately there is no outward appearance or warning toprompt that Sysprep is missing. The future step f or Token Replacement will thensimply be wasted.4.On reboot, RDeploy captures the image to the Deployment Server.5.Create an image job for the recipient machines.a.Troubleshooting Note: Be sure to NOT mark the option to have AClient performits post configuration tasks. AClient can be used for this work, but Altirisrecommends doing as much as possible with Sysprep. Do not configure bothAClient and Sysprep to do the same process. For instance, if Sysprep has themachine join the domain, and then AClient tries to, it can be a problem.b. A second task needs to be added to the deployment job to create the customSYSPREP.INF file for the workstation. See Appendix C for an example.i.This task will be a script that should be executed in DOS mode.ii.The task will have a step to customize the file using the Template file created above.iii.The second step of the task will be to FIRM copy the file to theworkstation.iv.The file should be copied into the PROD:\sysprep folder.6.Deploy an Image to the recipient machine.a.When the machine is finished receiving the image, the custom SYSPREP.INF filewill be sent to the machine.b.The machine will then reboot, Mini-Setup will run and manage the SID/MachineName and auto-detection of hardware. Additionally, any other postconfiguration of the machine, including possible scripts specified will be run viathe Sysprep process.c.Troubleshooting Note: If the machine being deployed to does not have the samehardware, there are a couple of places the process may fail or stop. Somehardware differences will prevent machine from booting into 32 bit mode.Others will simply prompt for device driver files, or not install the correcthardware. To correct this type of issue, refer to Scenario Two in the Advanced /Custom Imaging section.d.Troubleshooting Note: Multiple reboots may be required to complete thisprocess. Consider adding information for logging in automatically into theSYSPREP.INF file.Using the default SYSPREP.INF created by AClientThis will discuss in more details what goes on behind the scenes, and what will be required to make this work correctly.1.Install AClient to the source machine, and select the option to include Sysprep.a. A prompt for the location of the DEPLOY.CAB file will appear which is on the OSInstallation CD for the target client’s OS.b.DEPLOY.CAB will be copied i nto the Altiris\AClient folder or different folder if adifferent location is specified, for future use.c.Troubleshooting Note: Sysprep is OS dependant. The correct DEPLOY.CAB fromthe associate original OS CDs must be used, or downloaded from Microsoft.d.Troubleshooting Note: If DEPLOY.CAB is not in the AClient folder for any reason,it can be copied there either manually or with a job.2.Create a SYSPREP.W2K file in the Express Share with the Product Key for the OS beingimaged. (This step is only necessary for Windows 2000 Images.)a.The SYSPREP.W2K file is a plain text file with ONLY the license key in it includingdashes.b.This file will be used later in the process to replace the license that AClientplaces in the SYSPREP.INF file.c.Troubleshooting Note: The license key AClient places in the file is legitimate,but is hashed, and the Mini Setup doesn’t recognize it. Without this step, theprocess will stop when being prompted to enter a valid license number for theproduct.3.Schedule a job to capture the image.a.This will prompt AClient to prepare the machine for imaging, and if DEPLOY.CABis present, AClient will extract all the necessary Sysprep information.b.AClient will then execute SYSPREP.EXE which will do additional preparations, andthen shut-down.c.Troubleshooting Note:if DEPLOY.CAB is not present, the process will “look” j ustlike above, meaning the machine will automatically shut down. However, theresults will not be the same. Unfortunately there is no outward appearance orwarning that indicates Sysprep is missing.4.On reboot, RDeploy captures the image to the Deployment Server.a.Troubleshooting Note – for Windows XP Images Only: It is necessary to edit theimage to correct the SYSPREP.INF file AClient created.i.Open the image in Image Explorer.ii.Find the file c:\Sysprep\Sysprep.inf, and open it for editing.iii.Find the line that reads “ProductID=xxxx” and change it to“ProductKey=xxxx”. Verify that xxxx is the 25 digit XP product keyincluding dashes. See AKB5911 for more informationiv.More Information: The process was designed around Windows 2000.Microsoft changed the SYSPREP.INF file for Windows XP to read“ProductKey” instead of “ProductID.” The remaining information works inboth operating systems.5.Create an image job for the recipient machines.a.Be sure to include the option to have AClient perform its post configuration tasks6.Image the recipient machine.a.When the machine is finished receiving the image, a file will be sent tellingAClient what to do for Post Configuration.b.The machine will then reboot, the Mini-Setup will run, managing theSID/Machine Name and auto-detection of hardwarec.The machine will reboot and AClient will run any Post Configuration tasksrequired.d.Troubleshooting Note: If the machine being deployed does not have the samehardware, there are a couple of places the process may fail or stop. Somehardware differences will prevent the machine from booting into 32 bit mode.Some will simply prompt for device driver files, or not install the correcthardware. To correct this type of issue, refer to Scenario 2 in the Advanced /Custom Imaging section.ADVANCED / CUSTOM IMAGING: OTHER OPTIONSSince no solution will fit all scenarios, here are places to find additional guidance. One excellent place to start is on Microsoft’s web site:/default.aspx?scid=kb;en-us;298491. This site discusses Sysprep in detail, with links to other sites as well. Additionally, in the DEPLOY.CAB file included on every full OS Installation CD, there is a document with complete details on the use of Sysprep. For instance, on the Windows XP CD, this is called REF.CHM.Particularly though, there are a couple of scenarios that will require additional work beyond what this document covers:1.AClient is not in the image2.There are hardware differences between the source and recipient machines Scenario 1: AClient is not in the imageUnder these circumstances, the Sysprep process will need to be managed manually. The rest of the process can still be managed by Deployment Solution, so long as the Deployment Server knows about the machine, and Bootworks or PXE is being used.The key difference in the process is that the Sysprep files will need to be manually extracted and run. Additionally, the SYSPREP.INF file will also need to be created manually, though it is possible to use the Token Replacement method for customizing it.Scenario 2: The image will be going to dissimilar machines (hardware) Conceptually, the reason this can be a problem is two fold:1.Different hardware will prompt for drivers (i.e. different NIC or Video Card). This canoften be resolved simply by including custom drivers in the Sysprep folders.2.Some hardware differences will prevent the OS from loading into 32bit Mode, causingMini Setup to fail (i.e. an image with IDE drives being deployed to an image with SCSIdrives). This will require research and SYSPREP.INF file customizations.As such, the default SYSPREP.INF created in Appendix A will not be sufficient. Thus the key to this is the requirement to have a more customized SYSPREP.INF file, though there are limits to what can be done. Use the Token Replacement method discussed previously, or manually create this file, as needed. Additionally, Altiris has an additional article that discusses this further, called “Hardware Independent Imaging,” and is numbered AKB3313.APPENDIXESAppendix A: Sample Sysprep.INF file as created by AClient [Unattended]OEMSkipEula=YES[GuiUnattended]AdminPassword="*"OEMSkipRegional=1TimeZone=004OEMSkipWelcome=1[UserData]ProductID=xxxx-xxxx-xxxx-xxxx-xxxxOrgName=""FullName="WinXP"ComputerName="NEWCOMP"[Identification]JoinWorkgroup=WORKGROUP[Networking]InstallDefaultComponents=YES[Sysprepcleanup]Appendix B: Example of a SYSPREP.INF file using TokensTake note of everywhere there is a % sign. These are tokens, and Deployment Server will attempt to replace them. The variables ARE case-sensitive, and you should use all caps. [Unattended]OEMSkipEula=YES[GuiUnattended]AdminPassword="password"OEMSkipRegional=1TimeZone=%TIMEZONE%OEMSkipWelcome=1[UserData]ProductID=xxxx-xxxx-xxxx-xxxx-xxxxOrgName="%ORGANIZATION%"FullName="%DEPARTMENT%"ComputerName="%COMPNAME%"[GuiRunOnce]Command0=”mycustomscript.vbs”[Identification]DomainAdmin=”DOMAIN\AcctAddToDom”DomainAdminPassword=acctpasswordJoinDomain=%DOMAIN%[Networking]InstallDefaultComponents=YESAppendix C: Sample Script using Token Replacement to create SYSPREP.INFAs a simple explanation of this, the first line is JUST a comment. The second line, though it looks like a comment is actually interpreted by the Deployment Server as command to do the actual customization of the SYSPREP.INF file. The third line places the file on the system. The variables ARE case-sensitive, and you should use all caps for them.REM Token Replacement Task for Sysprep.inf fileREM Replacetokens .\temp\SYSPREP.TXT .\temp\%COMPNAME%.INFFIRM Copy F:\temp\%COMPNAME%.INF PROD:\sysprep\sysprep.inf。