Printer Friendly Version      Send     
Click to Rate and Give Feedback
TechNet
TechNet Library
Deployment
Desktop Deployment
Deployment
 Scripts
Microsoft Deployment Toolkit Reference
Scripts
Published: December 20, 2007

The scripts used in LTI and ZTI reference properties that determine the process steps and configuration settings used during the deployment process. This reference section can be used to help determine the correct scripts to include in actions and the valid arguments to provide when running each script. The following information is provided for each script:

  • Name. Specifies the name of the script.

  • Description. Provides a description of the purpose of the script and any pertinent information regarding script customization.

  • Input. Indicates the files used for input to the script.

  • Output. Indicates the files created or modified by the script.

  • References. Indicates other scripts or configuration files that are referenced by the script.

  • Location. Indicates the folder where the script can be found. In the information for the location, the following variables are used:

    • program_files. This variable points to the location of the Program Files folder on the computer where Microsoft Deployment is installed.

    • distribution. This variable points to the location of the Distribution folder for the deployment point.

    • platform. This variable is a placeholder for the operating system platform (x86 or x64).

  • Use. Provides the command line and options that can be specified.

  • Arguments and description. Indicate the valid arguments to be specified for the script and a brief description of what each argument means.

  • Properties. The properties referenced by the script.

On This Page

BDD_Autorun.wsf BDD_Autorun.wsf
BDD_Welcome_ENU.xml BDD_Welcome_ENU.xml
Credentials_ENU.xml Credentials_ENU.xml
Credentials_scripts.vbs Credentials_scripts.vbs
DeployWiz_Definition_ENU.xml DeployWiz_Definition_ENU.xml
DeployWiz_Initialization.vbs DeployWiz_Initialization.vbs
DeployWiz_Validation.vbs DeployWiz_Validation.vbs
LiteTouch.vbs LiteTouch.vbs
LiteTouch.wsf LiteTouch.wsf
LTIApply.wsf LTIApply.wsf
LTICleanup.wsf LTICleanup.wsf
LTICopyScripts.wsf LTICopyScripts.wsf
LTIGetFolder.wsf LTIGetFolder.wsf
LTISysprep.wsf LTISysprep.wsf
NICSettings_Definition_ENU.xml NICSettings_Definition_ENU.xml
Summary_Definition_ENU.xml Summary_Definition_ENU.xml
Summary_scripts.vbs Summary_scripts.vbs
Wizard.hta Wizard.hta
WizUtility.vbs WizUtility.vbs
ZeroTouchInstallation.vbs ZeroTouchInstallation.vbs
ZeroTouchInstallation.wsf ZeroTouchInstallation.wsf
ZTIApplications.wsf ZTIApplications.wsf
ZTIAppXmlGen.wsf ZTIAppXmlGen.wsf
ZTIBackup.wsf ZTIBackup.wsf
ZTIBde.wsf ZTIBde.wsf
ZTIBIOSCheck.wsf ZTIBIOSCheck.wsf
ZTIConfigure.wsf ZTIConfigure.wsf
ZTIConfigureADDS.wsf ZTIConfigureADDS.wsf
ZTIConfigureDHCP.wsf ZTIConfigureDHCP.wsf
ZTIConfigureDNS.wsf ZTIConfigureDNS.wsf
ZTIConnect.wsf ZTIConnect.wsf
ZTICopyLogs.wsf ZTICopyLogs.wsf
ZTIDiskpart.wsf ZTIDiskpart.wsf
ZTIDiskUtility.vbs ZTIDiskUtility.vbs
ZTIDrivers.wsf ZTIDrivers.wsf
ZTIGather.wsf ZTIGather.wsf
ZTIGroups.wsf ZTIGroups.wsf
ZTILangPacksOnline.wsf ZTILangPacksOnline.wsf
ZTIMoveStateStore.wsf ZTIMoveStateStore.wsf
ZTINextPhase.wsf ZTINextPhase.wsf
ZTINICConfig.wsf ZTINICConfig.wsf
ZTINICUtility.vbs ZTINICUtility.vbs
ZTIOSRole.wsf ZTIOSRole.wsf
ZTIPackages.wsf ZTIPackages.wsf
ZTIPatches.wsf ZTIPatches.wsf
ZTIPrereq.vbs ZTIPrereq.vbs
ZTICONFIGMGR.wsf ZTICONFIGMGR.wsf
ZTISetVariable.wsf ZTISetVariable.wsf
ZTITatoo.wsf ZTITatoo.wsf
ZTIUserState.wsf ZTIUserState.wsf
ZTIUtility.vbs ZTIUtility.vbs
ZTIValidate.wsf ZTIValidate.wsf
ZTIWindowsUpdate.wsf ZTIWindowsUpdate.wsf
ZTIWipeDisk.wsf ZTIWipeDisk.wsf

BDD_Autorun.wsf

This script displays a dialog box that indicates the user inserted deployment media created by the Microsoft Deployment process (such as a bootable DVD or a removable hard disk). The message is displayed for 15 seconds. If no action is taken, the script starts LiteTouch.vbs.

For more information about LiteTouch.vbs, see the corresponding topic in the “Scripts” section of this reference.

Value

Description

Input

None

Output

None

References

LiteTouch.vbs. Initiates LTI.

Location

distribution\Scripts

Use

None

Arguments

Arguments

Description

None

None

Properties

Name

Read

Write

None

 

 

BDD_Welcome_ENU.xml

This .xml file contains the script code and HTML layout for the Welcome to Windows Deployment page that is displayed at the start of the Deployment Wizard. This .xml file is read by Wizard.hta, which runs the wizard pages embedded in this .xml file.

Value

Description

Input

None

Output

None

References

  • NICSettings_Definition_ENU.xml. Allows the user to provide configuration settings for network adapters.

  • RecEnv.exe. If this utility exists, the user is prompted to determine if they want to launch Windows Recovery Environment (Windows RE).

  • WPEUtil.exe. Initializes Windows Preinstallation Environment (Windows PE) and network connections; initiates LTI.

Location

distribution\Tools\platform

Use

mshta.exe Wizard.hta BDD_Welcome_ENU.xml

Arguments

Value

Description

None

None

Properties

Name

Read

Write

KeyboardLocale

 

Credentials_ENU.xml

This .xml file contains the script code and HTML layout for the Specify credentials for connecting to network shares wizard page in the Deployment Wizard. This .xml file is read by Wizard.hta, which runs the wizard pages embedded in this .xml file.

Note   This wizard page is only displayed if there is a failure while validating the predefined user credentials.

Value

Description

Input

None

Output

None

References

Credentials_scripts.vbs

Location

distribution\Scripts

Use

mshta.exe Wizard.hta /NotWizard /definition:Credentials_ENU.xml [/ValidateAgainstDomain:domain | /ValidateAgainstUNCPath:uncpath] </DoNotSave> </LeaveShareOpen>

Arguments

Value

Description

/ValidateAgainstDomain:domain

Specifies the domain in which the credentials exist (as specified in domain).

/ValidateAgainstUNCPath:UNCPath

Specifies the shared network folder to be used to validate the credentials by connecting to the folder (as specified in UNCPath).

/DoNotSave

Does not write the properties to a file; just connects to the path.

/LeaveShareOpen

If UNC path is specified, then does NOT delete the share if successful.

Properties

Name

Read

Write

None

 

 

Credentials_scripts.vbs

This script parses the arguments that were provided when loading the Credentials_ENU.xml file into the Deployment Wizard. It also performs user credential validation. This script is read by the Credentials_ENU.xml file.

For more information about Credentials_ENU.xml, see the corresponding topic in the “Scripts” section of this reference.

Value

Description

Input

None

Output

Event message are written to these log files:

  • Credentials_scripts.log. Log file that contains events generated by this script.

  • BDD.log. Log file that contains events generated by all Microsoft Deployment scripts.

References

None

Location

distribution\Scripts

Use

<script language="VBScript" src="Credentials_scripts.vbs"/>

Arguments

Value

Description

  • None

None

Properties

Name

Read

Write

UserCredentials

 

DeployWiz_Definition_ENU.xml

This .xml file contains the script code and HTML layout for each wizard page in the Deployment Wizard. This .xml file is read by Wizard.hta, which runs the wizard panes embedded in this .xml file. This .xml file contains the following wizard panes:

  • Welcome to the Windows Deployment Wizard

  • Select a task sequence to execute on this computer

  • Specify the product key needed to install this operating system

  • Choose a migration type

  • Configure the computer name

  • Join the computer to a domain or workgroup

  • Specify where to save your data and settings

  • Specify whether to restore user data

  • Specify where to save a complete computer backup

  • Packages

  • Locale selection

  • Set the time zone

  • Select one or more applications to install

  • Administrator password

  • Specify whether to capture an image

  • Specify the BitLocker configuration

  • Specify credentials for connecting to network shares

  • Ready to begin

Value

Description

Input

None

Output

None

References

  • DeployWiz_Initialization.vbs. Includes support functions and subroutines used by the script.

  • DeployWiz_Validation.vbs. Includes support functions and subroutines used by the script.

Location

distribution\Scripts

Use

None

Arguments

Value

Description

None

None

Properties

Name

Read

Write

ComputerName

 

DeployRoot

 

DeployTemplate

 

DeploymentMethod

 

DoCapture

 

ImageBuild

 

ImageFlags

 

JoinDomain

 

OSGUID

 

SkipAdminPassword

 

SkipApplications

 

SkipAppsOnUpgrade

 

SkipBitLocker

 

SkipCapture

 

SkipComputerBackup

 

SkipComputerName

 

SkipDeploymentType

 

SkipDomainMembership

 

SkipLocaleSelection

 

SkipPackageDisplay

 

SkipProductKey

 

SkipSummary

 

SkipTaskSequence

 

SkipTimeZone

 

SkipUserData

 

UserDomain

 

UserID

 

UserPassword

 

DeployWiz_Initialization.vbs

This script initializes the pages in the Windows Deployment Wizard (stored in DeployWiz_Definition_ENU.xml). It also contains functions and subroutines that are called by the Windows Deployment Wizard during an LTI-based deployment.

For more information about DeployWiz_Definition_ENU.xml, see the corresponding topic in the “Scripts” section of this reference.

Value

Description

Input

  • Applications.xml. Contains a list of available applications.

  • DomainOUList.xml. Contains a list of domain OUs.

  • LocationServer.xml. Contains a list of available deployment points.

  • Packages.xml. Contains a list of available packages.

  • TaskSequences.xml. Contains a list of task sequences.

  • Environment Variables. Contains the list of property values, custom properties, database connections, deployment rules, and other information required by the scripts to complete the deployment process. The environment variables are populated by ZTIGather.wsf.

Output

Event message are written to these log files:

  • DeployWiz_Initialization.log. Log file that contains events generated by this script.

  • BDD.log. Log file that contains events generated by all Microsoft Deployment scripts.

References

None

Location

distribution\Scripts

Use

<script language="VBScript" src="DeployWiz_Initialization.vbs"/>

Arguments

Value

Description

None

None

Properties

Name

Read

Write

Architecture

 

Applications

 

BDEInstall

 

ComputerbackupLocation

 

DeploymentType

 

DeployRoot

 

DomainAdmin

DomainAdminDomain

DomainAdminPassword

ImageBuild

 

ImageFlags

 

ImageLanguage

 

ImageProcessor

 

IsServer

 

KeyboardLocale

 

LanguagePacks

 

LanguagePacks1

LocalDeployRoot

 

OSCurrentBuild

 

OSVersion

 

OverrideProductKey

 

ProductKey

 

SkipCapture

 

TaskSequenceID

 

TimeZone

 

TimeZoneName

 

TSGUID

 

UDDir

 

UDShare

 

UserDataLocation

 

UserDomain

 

UserID

 

UserLocale

 

UserPassword

 

DeployWiz_Validation.vbs

This script initializes and validates the information entered in the pages of the Windows Deployment Wizard (stored in DeployWiz_Definition_ENU.xml). This script contains functions and subroutines that are called by the Windows Deployment Wizard during an LTI-based deployment.

For more information about DeployWiz_Definition_ENU.xml, see the corresponding topic in the “Scripts” section of this reference.

Value

Description

Input

  • OperatingSystems.xml. Contains the list of operating systems available for deployment.

  • Environment Variables. Contains the list of property values, custom properties, database connections, deployment rules, and other information required by the scripts to complete the deployment process. The environment variables are populated by ZTIGather.wsf.

Output

None

References

Credentials_ENU.xml. Prompts the user for credentials that will be used when connecting to network resources.

Location

distribution\Scripts

Use

<script language=”VBScript” src=”DeployWiz_Validation.vbs”/>

Arguments

Value

Description

None

None

Properties

Name

Read

Write

DeploymentType

 

DeployTemplate

 

ImageProcessor

 

OSGUID

 

OSVersion

UserCredentials

 

UserDomain

 

UserID

 

UserPassword

 

LiteTouch.vbs

This script is called by the Windows Deployment Wizard to initiate LTI. The script:

  • Removes the C:\MININT folder (if it exists).

  • Checks that the target computer meets the requirements for running the Windows Deployment Wizard by calling ZTIPrereq.vbs.

  • Starts the Windows Deployment Wizard by running LiteTouch.wsf.

For more information about ZTIPrereq.vbs and LiteTouch.wsf, see the corresponding topics in the “Scripts” section of this reference.

Value

Description

Input

None

Output

None

References

  • ZTIPrereq.vbs. Used to determine if the target computer meets the prerequisites for deploying a new operating system.

  • LiteTouch.wsf. The script responsible for controlling the LTI deployment process.

Location

distribution\Scripts

Use

cscript LiteTouch.vbs </debug:value>

Arguments

Value

Description

/debug:value

Outputs the event messages to the console and to the .log files. If the value specified in value is:

  • TRUE, event messages are sent to the console and the .log files.

  • FALSE, event messages are sent only to the .log files (this is the behavior when the argument is not provided).

Properties

Name

Read

Write

None

 

 

LiteTouch.wsf

This script is called by LiteTouch.vbs and responsible for controlling the LTI deployment process. This includes:

  • Running the Windows Deployment Wizard.

  • Running the LTI deployment process by using the appropriate task sequence file.

For more information about LiteTouch.vbs, see the corresponding topic in the “Scripts” section of this reference.

Value

Description

Input

  • task_sequence_file .xml. Contains the tasks and sequence of tasks for the LTI deployment process.

  • Environment Variables. Contains the list of property values, custom properties, database connections, deployment rules, and other information required by the scripts to complete the deployment process. The environment variables are populated by ZTIGather.wsf.

Output

  • LiteTouch.log. Log file that contains events generated by this script.

  • BDD.log. Log file that contains events generated by all Microsoft Deployment scripts.

References

  • BDD_Welcome_ENU.xml. Displays the Deployment Wizard Welcome page for LTI deployment.

  • CMD.exe. Windows Command Processor for running external commands while debugging the deployment.

  • DeployWiz_Definition_ENU.xml. Displays the Deployment Wizard pages for LTI deployment.

  • Diskpart.exe. Utility that allows the automated management of disks, partitions, and volumes.

  • LTICleanup.wsf. Performs cleanup tasks after deployment completes.

  • RecEnv.exe. If this utility exists, the user is prompted to determine if they want to launch Windows RE.

  • Regsvr32.exe. Registers files (.dll, .exe, .ocx, and so on) with the operating system.

  • Summary_Definition_ENU.xml. Displays the summary results for the LTI deployment.

  • TsmBootstrap.exe. Task sequence BootStrap utility.

  • ZTIUtility.vbs. Includes support functions and subroutines used by the script.

Location

distribution\Scripts

Use

BDDRun.exe “wscript.exe ScriptDirectory\LiteTouch.wsf </debug:value>”

Arguments

Value

Description

/debug:value

Outputs the event messages to the console and to the .log files. If the value specified in value is:

  • TRUE, event messages are sent to the console and the .log files.

  • FALSE, event messages are sent only to the .log files (this is the behavior when the argument is not provided).

Properties

Name

Read

Write

_SMSTSPackageName

 

Architecture

DeployDrive

DeploymentMethod

DeploymentType

DeployRoot

 

DeploySystemDrive

ImageLanguage001

 

JoinDomain

 

JoinWorkgroup

 

KeyboardLocale

OSDAdapterCount

 

Phase

ResourceDrive

ResourceRoot

RetVal

 

SkipBDDWelcome

 

SkipFinalSummary

 

SkipWizard

 

TaskSequenceID

UILanguage

 

UserLocale

 

WelcomeWizardCommand

 

WizardComplete  

 

LTIApply.wsf

This script is responsible for installing a Windows PE image, Windows XP image, or Windows Vista image to the target computer. The Windows PE image is used to collect information about the target computer and to run the deployment tasks on the target computer.

Value

Description

Input

OperatingSystems.xml

Output

  • LTIApply.log. Log file that contains events generated by this script.

  • LTIApply_wdsmcast.log. Log file that contains events generated by the Wdsmcast utility.

  • BDD.log. Log file that contains events generated by all Microsoft Deployment scripts.

References

  • ZTIUtility.vbs. Includes support functions and subroutines used by the script.

  • Bootsect.exe. Applies a boot sector to the hard disk.

  • ImageX.exe. A utility used to create and manage Windows Imaging Format (.wim) files.

  • Wdsmcast.exe. A utility used by target computers to join a multicast transmission.

Location

distribution\Scripts

Use

cscript LTIApply.wsf </pe> </post> </debug:value>

Arguments

Value

Description

/pe

Uses the process for installing the Windows PE image on the target computer.

/post

Cleans up unnecessary files after the installation of an image.

/debug:value

Outputs the event messages to the console and to the .log files. If the value specified in value is:

  • TRUE, event messages are sent to the console and the .log files.

  • FALSE, event messages are sent only to the .log files (this is the behavior when the argument is not provided).

Properties

Name

Read

Write

Architecture

 

DeployRoot

 

OSGUID

 

OSVersion

 

ImageBuild

 

ImageProcessor

 

SourcePath

 

TaskSequenceID

 

UserDomain

 

UserID

 

UserPassword

 

WDSServer

LTICleanup.wsf

This script removes any files or configuration settings (such as scripts, folders, registry entries, or automatic logon configuration settings) from the target computer after the deployment process completes.

Value

Description

Input

Environment Variables. Contains the list of property values, custom properties, database connections, deployment rules, and other information required by the scripts to complete the deployment process. The environment variables are populated by ZTIGather.wsf.

Output

  • LTICleanup.log. Log file that contains events generated by this script.

  • BDD.log. Log file that contains events generated by all Microsoft Deployment scripts.

References

  • ZTIUtility.vbs. Includes support functions and subroutines used by the script.

  • Bootsect.exe. Applies a boot sector to the hard disk.

Location

distribution\Scripts

Use

cscript LTICleanup.wsf </debug:value>

Arguments

Value

Description

/debug:value

Outputs the event messages to the console and to the .log files. If the value specified in value is:

  • TRUE, event messages are sent to the console and the .log files.

  • FALSE, event messages are sent only to the .log files (this is the behavior when the argument is not provided).

Properties

Name

Read

Write

DeployRoot

 

DeploySystemDrive

 

ImageBuild

 

OSVersion

 

LTICopyScripts.wsf

This script copies the deployment scripts for the LTI-based and ZTI-based deployment processes to a local hard drive on the target computer.

Value

Description

Input

None

Output

  • LTICopyScripts.log. Log file that contains events generated by this script.

  • BDD.log. Log file that contains events generated by all Microsoft Deployment scripts.

References

  • ZTIUtility.vbs. Includes support functions and subroutines used by the script.

Location

distribution\Scripts

Use

cscript LTICopyScripts.wsf </debug:value>

Arguments

Value

Description

/debug:value

Outputs the event messages to the console and to the .log files. If the value specified in value is:

  • TRUE, event messages are sent to the console and the .log files.

  • FALSE, event messages are sent only to the .log files (this is the behavior when the argument is not provided).

Properties

Name

Read

Write

None

 

 

LTIGetFolder.wsf

This script displays a dialog box that allows the user to browses to a folder. The selected folder path is stored in the FolderPath environment variable.

Value

Description

Input

Environment Variables. Contains the list of property values, custom properties, database connections, deployment rules, and other information required by the scripts to complete the deployment process. The environment variables are populated by ZTIGather.wsf.

Output

None

References

  • ZTIUtility.vbs. Includes support functions and subroutines used by the script.

  • WizUtility.vbs. Includes support functions and subroutines used by the user interface (such as wizard pages).

Location

  • distribution\Scripts

  • program_files\Microsoft Deployment Toolkit\Scripts

Use

cscript LTIGetFolder.wsf

Arguments

Value

Description

None

None

Properties

Name

Read

Write

DefaultFolderPath

 

FolderPath

 

LTISysprep.wsf

This script prepares the target computer for running Sysprep, runs Sysprep on the target computer, and then verifies that Sysprep ran successfully.

Value

Description

Input

Environment Variables. Contains the list of property values, custom properties, database connections, deployment rules, and other information required by the scripts to complete the deployment process. The environment variables are populated by ZTIGather.wsf.

Output

  • LTISysprep.log. Log file that contains events generated by this script.

  • BDD.log. Log file that contains events generated by all Microsoft Deployment scripts.

References

  • Expand.exe. Expands compressed files.

  • ZTIUtility.vbs. Includes support functions and subroutines used by the script.

Location

distribution\Scripts

Use

cscript LTISysprep.wsf </debug:value>

Arguments

Value

Description

/debug:value

Outputs the event messages to the console and to the .log files. If the value specified in value is:

  • TRUE, event messages are sent to the console and the .log files.

  • FALSE, event messages are sent only to the .log files (this is the behavior when the argument is not provided).

Properties

Name

Read

Write

Architecture

 

DoCapture

 

OSCurrentBuild

 

SourcePath

 

NICSettings_Definition_ENU.xml

This .xml file contains the script code and HTML layout for the Configure Static IP Network Settings wizard page in the Windows Deployment Wizard. During an LTI deployment, the Wizard.hta reads this .xml file and runs the embedded wizard page that prompts for the required network addressing configuration. If the team member chooses to not supply static IP addressing configuration, the deployment scripts will default to using DHCP to obtain the required network configuration.

Value

Description

Input

None

Output

None

References

ZTINICUtility.vbs. Includes support functions and subroutines used by the script.

Location

distribution\Scripts

Use

None

Arguments

Value

Description

None

None

Properties

Name

Read

Write

OSDAdapter0DNSServerList

 

OSDAdapter0DNSSuffix

 

OSDAdapter0Gateways

 

OSDAdapter0IPAddressList

 

OSDAdapter0MacAddress

 

OSDAdapter0SubnetMask

 

OSDAdapter0WINSServerList

 

OSDAdapterCount

 

Summary_Definition_ENU.xml

This .xml file contains the script code and HTML layout for the Deployment Summary wizard page in the Windows Deployment Wizard. During an LTI deployment, the Wizard.hta reads this .xml file and runs the embedded wizard page that displays the summary results for the LTI deployment. This .xml file contains the following wizard pages:

  • Success. Notification regarding the successful completion of the deployment tasks.

  • Failure. Notification regarding the failure to successfully complete the deployment tasks.

Value

Description

Input

None

Output

None

References

Summary_Scripts.vbs. Includes support functions and subroutines used by the wizard pages embedded in this .xml file.

Location

distribution\Scripts

Use

None

Arguments

Value

Description

None

None

Properties

Name

Read

Write

SkipFinalSummary

 

RetVal

 

Summary_scripts.vbs

This script is called by the Summary wizard page of the Windows Deployment Wizard. It contains functions and subroutines that are used for initialization and validation.

Value

Description

Input

Environment Variables. Contains the property values, custom property values, database connections, deployment rules, and other information required by the scripts to complete the deployment process.

Output

Event message are written to these log files:

  • Summary_scripts.log. Log file that contains events generated by this script.

  • BDD.log. Log file that contains events generated by all Microsoft Deployment scripts.

References

None

Location

distribution\Scripts

Use

<script language=”VBScript” src=”Summary_Scripts.vbs”/>

Arguments

Value

Description

None

None

Properties

Name

Read

Write

DeploymentType

 

RetVal

 

Wizard.hta

This Hypertext Application (HTA) displays the Windows Deployment Wizard pages.

Value

Description

Input

Environment Variables. Contains the list of property values, custom properties, database connections, deployment rules, and other information required by the scripts to complete the deployment process. The environment variables are populated by ZTIGather.wsf.

Output

  • Wizard.log. Log file that contains events generated by this script.

  • BDD.log. Log file that contains events generated by all Microsoft Deployment scripts.

References

  • ZTIUtility.vbs. Includes support functions and subroutines used by the script.

  • WizUtility.vbs. Includes support functions and subroutines used by the script.

Location

  • distribution\Scripts

  • program_files\Microsoft Deployment Toolkit\Scripts

Use

mshta.exe Wizard.hta </definition:filename> </NotWizard> </debug:value>

Arguments

Value

Description

/debug:value

Outputs the event messages to the console and to the .log files. If the value specified in value is:

  • TRUE, event messages are sent to the console and the .log files.

  • FALSE, event messages are sent only to the .log files (this is the behavior when the argument is not provided).

/NotWizard

Used to bypass wizard page prompts.

/Definition:filename

Specifies the .xml file that is to be loaded into the wizard.

Properties

Name

Read

Write

WizardComplete

 

WizUtility.vbs

This script contains functions and subroutines that are referenced by the various Windows Deployment Wizard scripts.

Value

Description

Input

Environment Variables. Contains the property values, custom property values, database connections, deployment rules, and other information required by the scripts to complete the deployment process.

Output

  • WizUtility.log. Log file that contains events generated by this script.

  • BDD.log. Log file that contains events generated by all Microsoft Deployment scripts.

References

LTIGetFolder.wsf. Script file that provides a BrowseForFolder dialog box to the user.

Location

  • distribution\Scripts

  • program_files\Microsoft Deployment Toolkit\Scripts

Use

<script language="VBScript" src="WizUtility.vbs"/>

Arguments

Value

Description

None

None

Properties

Name

Read

Write

DefaultFolderPath

 

FolderPath

 

OSVersion

 

UserCredentials

 

ZeroTouchInstallation.vbs

This script is run to initiate the ZTI deployment process. The script:

  • Checks that the target computer meets the requirements for running the Windows Deployment Wizard by calling ZTIPrereq.vbs.

  • Starts the Windows Deployment Wizard by running ZeroTouchInstallation.wsf.

For more information about ZTIPrereq.vbs and ZeroTouchInstallation.wsf, see the corresponding topics in the “Scripts” section of this reference.

Value

Description

Input

None

Output

None

References

  • BDDRun.exe. Runs a command that requires user interaction.

  • Regsvr32.exe. Registers files (.dll, .exe, .ocx, and so on) with the operating system.

  • TsmBootStrap.exe. Task sequence bootstrap utility.

  • ZTIGather.wsf. Gathers the properties and processing rules that control the deployment process.

  • ZTINicConfig.wsf. Configures network adapters.

  • ZTIUtility.vbs. Includes support functions and subroutines used by the scripts in this file.

  • ZTIPrereq.vbs. Used to determine if the target computer meets the prerequisites for deploying a new operating system.

  • ZeroTouchInstallation.wsf. Initiates the ZTI deployment process.

Location

distribution\Scripts

Use

cscript ZeroTouchInstallation.vbs </debug:value>

Arguments

Value

Description

/debug:value

Outputs the event messages to the console and to the .log files. If the value specified in value is:

  • TRUE, event messages are sent to the console and the .log files.

  • FALSE, event messages are sent only to the .log files (this is the behavior when the argument is not provided).

Properties

Name

Read

Write

None

 

 

ZeroTouchInstallation.wsf

This script is responsible for controlling the ZTI deployment process. This includes running the ZTI deployment process using the appropriate task sequence file.

Note   This script is initiated by ZeroTouchInstallation.vbs

Value

Description

Input

  • task_sequence_file .xml. Contains the tasks and sequence of tasks for the ZTI deployment process (where task_sequence_file is the name of the task sequence file).

  • Environment Variables. Contains the list of property values, custom properties, database connections, deployment rules, and other information required by the scripts to complete the deployment process. The environment variables are populated by ZTIGather.wsf.

Output

  • ZeroTouchInstallation.log. Log file that contains events generated by this script.

  • BDD.log. Log file that contains events generated by all Microsoft Deployment scripts.

References

  • BDDRun.exe. Runs a command that requires user interaction.

  • TsmBootStrap.exe. Task sequence bootstrap utility.

  • ZTIGather.wsf. Gathers the properties and processing rules that control the deployment process.

  • ZTIUtility.vbs. Includes support functions and subroutines used by the script.

Location

distribution\Scripts

Use

cscript ZeroTouchInstallation.wsf </debug:value>

For more information about ZTIUtility.vbs, ZeroTouchInstallation.vbs, and task_sequence_file, see the corresponding topics in the “Scripts” section of this reference.

Arguments

Value

Description

/debug:value

Outputs the event messages to the console and to the .log files. If the value specified in value is:

  • TRUE, event messages are sent to the console and the .log files.

FALSE, event messages are sent only to the .log files (this is the behavior when the argument is not provided).

Properties

Name

Read

Write

_SMSTSPackageName

 

Architecture

 

DeployDrive

DeploymentMethod

DeploymentType

DeployRoot

DeploySystemDrive

 

OSDAdapterCount

 

OSDInstallPackage

 

OSDPackageID

 

OSDPackagePath

 

OSVersion

 

Phase

ResourceDrive

 

ResourceRoot

 

ZTIApplications.wsf

This script will initiate an installation of applications that have been configured on the Deployment Workbench Applications node. This script will not attempt to install any application that:

  • Does not support the target computer’s platform type.

  • Does not support the target computer’s processor type.

  • Has an uninstall entry in the registry under HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Uninstall.

    Note   If the listed application has any dependant applications defined, this script will attempt to install those dependant applications prior to installing the listed application.

Value

Description

Input

  • Applications.xml. Contains a list of applications to be installed. This file is created by Deployment Workbench.

  • Environment Variables. Contains the property values, custom property values, database connections, deployment rules, and other information required by the scripts to complete the deployment process.

Output

  • ZTIApplications.log. Log file that contains events generated by this script.

  • BDD.log. Log file that contains events generated by all Microsoft Deployment scripts.

References

  • ZTIUtility.vbs. Includes support functions and subroutines used by the script.

  • BDDRun.exe. Runs a command that requires user interaction.

Location

distribution\Scripts

Use

cscript ZTIApplications.wsf </debug:value>

Arguments

Value

Description

/debug:value

Outputs the event messages to the console and to the .log files. If the value specified in value is:

  • TRUE, event messages are sent to the console and the .log files.

  • FALSE, event messages are sent only to the .log files (this is the behavior when the argument is not provided).

Properties

Name

Read

Write

Architecture

 

ApplicationGUID

 

DeploymentMethod

 

InstalledApplications

ResourceDrive

 

ResourceRoot

SMSTSRebootRequested

 

SMSTSRetryRequested  

 

ZTIAppXmlGen.wsf

This script generates an .xml file, ZTIAppXmlGen.xml, for use when automatically capturing user data (documents) that are associated with installed applications.

This script accomplishes this task by enumerating through the HKEY_CLASSES_ROOT\Software\Classes registry key and capturing any applications that:

  • Are not associated with one of these file extensions: .mp3, .mov, .wma, .wmv, .chm, .evt, .evtx, .exe, .com, and .fon.

  • Are not associated with a Microsoft Office system, such as the 2007 Microsoft Office System or Microsoft Office 2003.

  • Have a valid open handler listed at: HKEY_CLASSES_ROOT\ application \shell\open\command.

Value

Description

Input

Environment Variables. Contains the property values, custom property values, database connections, deployment rules, and other information required by the scripts to complete the deployment process.

Output

  • ZTIAppXmlGen.xml. Contains a list of applications that are installed on the target computer.

  • ZTIAppXmlGen.log. Log file that contains events generated by this script.

  • BDD.log. Log file that contains events generated by all Microsoft Deployment scripts.

References

ZTIUtility.vbs. Includes support functions and subroutines used by the script.

Location

distribution\Scripts

Use

cscript ZTIAppXmlGen.wsf </debug:value>

Arguments

Value

Description

/debug:value

Outputs the event messages to the console and to the .log files. If the value specified in value is:

  • TRUE, event messages are sent to the console and the .log files.

  • FALSE, event messages are sent only to the .log files (this is the behavior when the argument is not provided).

Properties

Name

Read

Write

USMTMigFiles

ZTIBackup.wsf

This script performs a backup of the target computer using the ImageX utility. The backup is stored in the location specified in the BackupDir and BackupShare properties. For more information about these properties, see the corresponding topics in the “Properties” section of this reference.

Value

Description

Input

Environment Variables. Contains the property values, custom property values, database connections, deployment rules, and other information required by the scripts to complete the deployment process.

Output

  • ZTIBackup.log. Log file that contains events generated by this script.

  • ZTIBackup_imagex.log. Log file that contains events generated by ImageX.exe.

  • BDD.log. Log file that contains events generated by all Microsoft Deployment scripts.

References

  • ImageX.exe. A utility used to create and manage .wim files.

  • Reg.exe. Console Registry Tool for reading and modifying registry data.

  • ZTIUtility.vbs. Includes support functions and subroutines used by the script.

Location

distribution\Scripts

Use

cscript ZTIBackup.wsf </debug:value>

Arguments

Value

Description

/debug:value

Outputs the event messages to the console and to the .log files. If the value specified in value is:

  • TRUE, event messages are sent to the console and the .log files.

  • FALSE, event messages are sent only to the .log files (this is the behavior when the argument is not provided).

Properties

Name

Read

Write

BackupDir

 

BackupDisk

 

BackupDrive

 

BackupFile

 

BackupPartition

 

BackupShare

 

ComputerBackupLocation

 

DeploymentMethod

 

DeploymentType

 

DoCapture

 

ImageFlags

 

TaskSequenceID

 

ZTIBde.wsf

This script installs and configures BitLocker Drive Encryption on the target computer.

Note   The BitLocker Drive Encryption configuration is limited to New Computer and Upgrade Computer scenarios that have hard disks configured with a single partition.

Value

Description

Input

  • BdeFixDiskPart.txt. Answer file used by the Diskpart tool to adjust drive letter assignments.

  • Environment Variables. Contains the property values, custom property values, database connections, deployment rules, and other information required by the scripts to complete the deployment process.

Output

  • ZTIBde.log. Log file that contains events generated by this script.

  • ZTIBdeFix_diskpart.log. Log file that contains events generated by the Diskpart tool.

  • BDD.log. Log file that contains events generated by all Microsoft Deployment scripts.

References

  • BdeHdCfg.exe. Manages the BitLocker Drive Encryption configuration.

  • Diskpart.exe. Utility that allows for the automated management of disks, partitions, and volumes.

  • ZTIDiskUtility.vbs. Includes support functions and subroutines used by the script.

  • ZTIUtility.vbs. Includes support functions and subroutines used by the script.

Location

distribution\Scripts

Use

cscript ZTIBde.wsf </debug:value>

Arguments

Value

Description

/debug:value

Outputs the event messages to the console and to the .log files. If the value specified in value is:

  • TRUE, event messages are sent to the console and the .log files.

  • FALSE, event messages are sent only to the .log files (this is the behavior when the argument is not provided).

Properties

Name

Read

Write

AdminPassword

 

BDEDriveLetter

 

BDEDriveSize

 

BDEInstall

 

BDEInstallSuppress

 

BDEKeyLocation

 

BDEPin

 

BDERecoveryKey

 

BDERecoveryPassword

 

BDESecondPass

BdeWaitForEncryption

 

ComputerName

 

DeploymentMethod

 

DeploymentType

 

OSDBitLockerCreateRecoveryPassword

 

OSDBitLockerMode

 

OSDBitLockerRecoveryPassword

 

OSDBitLockerStartupKey

 

OSDBitLockerStartupKeyDrive

OSDBitLockerTargetDrive