Scripts

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

 

OSDBitLockerWaitForEncryption

 

OSVersion

 

SMSTSRebootRequested

 

SMSTSRetryRequested

 

TPMOwnerPassword

 

ZTIBIOSCheck.wsf

This script checks the BIOS on the target computer and then looks at a list of BIOSes that are incompatible with Windows Vista. The list of incompatible BIOSes is stored in the ZTIBIOSCheck.xml file.

If the BIOS is listed in the ZTIBIOSCheck.xml file, then the script returns a status that indicates the BIOS is incompatible with Windows Vista and the deployment process should be terminated.

For information on populating the ZTIBIOSCheck.xml file with a list of incompatible BIOSes, see the corresponding topic in the “Support Files” section of this reference.

Value

Description

Input

  • ZTIBIOSCheck.xml. Contains a list of BIOSes that are known to be incompatible with Windows Vista.

  • 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

  • ZTIBIOSCheck.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 ZTIBIOSCheck.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

 

 

ZTIConfigure.wsf

This script configures the Unattend.xml, Sysprep.inf, or Unattend.txt files with the property values specified earlier in the Microsoft Deployment deployment process. The script configures the appropriate file based on the operating system being deployed.

This script reads the ZTIConfigure.xml file to determine how to update the Unattend.xml, Sysprep.inf, or Unattend.txt files with the appropriate values specified in the deployment properties. The ZTIConfigure.xml file contains the information to translate properties to settings in the Unattend.xml, Sysprep.inf, or Unattend.txt files.

Value

Description

Input

  • ZTIConfigure.xml. Contains a list of property values (specified earlier in the deployment process) and their corresponding configuration settings.

  • 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

  • ZTIConfigure.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 ZTIConfigure.wsf </debug:value> </predict>

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).

/predict

TBD

Properties

Name

Read

Write

DeploymentMethod

 

DeploymentType

 

DeployRoot

 

DeploySystemDrive

 

DomainAdminDomain

 

Phase

 

TaskSequenceID

 

Upgrade

 

ZTIConfigureADDS.wsf

This script starts DCPromo to configure the target computer as an Active Directory directory services domain controller.

For more information about Dcpromo.exe, see DCPromo at https://technet2.microsoft.com/windowsserver2008/en/library/d660e761-9ee7-4382-822a-06fc2365a1d21033.mspx.

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

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

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

References

  • DCPromo.exe. Installs and removes Active Directory Domain Services.

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

Location

distribution\Scripts

Use

cscript ZTIConfigureADDS.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

ADDSPassword

 

ADDSUserDomain

 

ADDSUserName

 

AutoConfigDNS

 

ChildName

 

ConfirmGC

 

DatabasePath

 

DomainLevel

 

DomainNetBiosName

 

ForestLevel

 

LogPath

 

NewDomain

 

NewDomainDNSName

 

OSVersion

 

ParentDomainDNSName

 

ReplicaOrNewDomain

ReplicaDomainDNSName

 

ReplicationSourceDC

 

SafeModeAdminPassword

 

SiteName

 

SysVolPath

 

ZTIConfigureDHCP.wsf

This script configures DHCP on the target computer.

Note   DHCP should already be installed on the target computer prior to running this script.

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

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

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

References

  • Netsh.exe. A utility that permits automating the configuration of networking components.

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

Location

distribution\Scripts

Use

cscript ZTIConfigureDHCP.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

IPAddress

 

Scopes

 

ScopesxScopeName

 

ScopesxScopeIP

 

ScopesxScopeSubnetmask

 

ScopesxScopeAddStartIP

 

ScopesxScopeAddEndIP

 

ScopesxScopeExcludeStartIP

 

ScopesxScopeExcludeEndIP

 

ScopesxScopeState

 

ScopesxScopeRouterOption

 

ScopesxScopeDNSSrvOption

 

ScopesxScopeWINSSrvOption

 

ScopesxScopeDNSDomainNameOption

 

ScopesxScopeWINSNodeOption

 

ScopesxScopeDwordOption

 

SrvOptionsDNSDomainName

 

SrvOptionsDNSSrv

 

SrvOptionsDword

 

SrvOptionsRouterSrv

 

SrvOptionsWINSNodeType

 

SrvOptionsWINSSrv

 

Note   The x in the properties listed above, is a placeholder for a zero based array that contains DHCP configuration information.

ZTIConfigureDNS.wsf

This script configures DNS on the target computer.

For more information about Dnscmd.exe, see Dnscmd Overview at https://technet2.microsoft.com/windowsserver/en/library/5c497b2e-3387-4ecf-adf5-562045620a961033.mspx.

Note   DNS should already be installed on the target computer prior to running this script.

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

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

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

References

  • DNScmd.exe. Assists administrators in DNS management.

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

Location

distribution\Scripts

Use

cscript ZTIConfigureDNS.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

ForwarderTimeout

 

SlaveOption

 

ForwarderIPAddress

 

Zones

 

ZonesxZoneName

 

ZonesxZoneType

 

ZonesxZoneUpdate

 

ZonesxZoneIP

 

ZonesxZoneAging

 

Note   The x in the properties listed above, is a placeholder for a zero based array that contains DNS configuration information.

ZTIConnect.wsf

The Microsoft Deployment deployment process uses this script to authenticate with a server computer (such as a computer running SQL Server or another server that has a shared network folder). When this script is run, it validates that a connection can be created to the network shared folder specified in the /uncpath argument.

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

  • ZTIConnect.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 ZTIConnect.wsf /UNCPath:uncpath </debug:value>

Arguments

Value

Description

/UNCPath:uncpath

Specifies a fully qualified UNC path to a network shared folder.

/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

 

 

ZTICopyLogs.wsf

Copy the Smsts.log and BDD.log files to a subfolder beneath the share specified by the SLShare property. The subfolder will be named the name specified by OSDComputerName, or OSDNewComputerName, or HostName.

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

  • ZTICopyLogs.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 ZTICopyLogs.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

HostName

 

OSDComputerName

 

OSDNewMachineName

 

SLShare

 

ZTIDiskpart.wsf

This script creates the disk partitions on the target computer by calling the Diskpart utility. The parameters used to configure the disk are specified in the Task Sequencer or CustomSettings.ini. ZTIDiskpart.wsf is primarily run during new computer scenarios. The process is as follows:

  1. The Microsoft Deployment deployment process runs the ZTIDiskpart.wsf script based on the steps and sequence of steps in the Task Sequencer.

  2. ZTIDiskpart.wsf starts the Diskpart utility and sends it the required configuration commands.

  3. ZTIDiskpart.wsf runs ZTIDiskpart.cmd and provides this .txt file as a command-line parameter to ZTIDiskpart.cmd.

  4. The disk is initially cleaned by sending Diskpart the “Clean” command.

  5. If this is the first disk, and a disk configuration has not been specified in the Task Sequencer or CustomSettings.ini, a single partition is created to store the OS. However, if a disk configuration has been specified, the disk will be configured in accordance with the specified configuration.

  6. If BitLocker Drive Encryption is to be enabled, space is reserved at the end of the first disk.

  7. All format commands are queued until after Diskpart has completed. If not explicitly specified in the Task Sequencer or CustomSettings.ini, ZTIDiskpart.wsf performs a quick format of drive C using the following command line: FORMAT C: /FS:NTFS /V:OSDisk /Q /Y

  8. ZTIDiskpart.wsf copies the ZTIDiskpart_diskpart.log and BDD.log files from the RAM disk back to the hard drive.

You can customize this file to create different partition configurations on the target computer using by providing the required information in the Task Sequencer or CustomSettings.ini.

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

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

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

References

  • 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 ZTIDiskpart.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

BDEDriveLetter

 

BDEDriveSize

 

BDEInstall

 

DeploymentType

 

ImageBuild

 

OSDDiskIndex

 

OSDDiskpartBiosCompatibilityMode

 

OSDDiskType

 

OSDPartitions

 

ZTIDiskUtility.vbs

This script contains disk-related functions and subroutines that are called by the various scripts in the Microsoft Deployment deployment process.

Value

Description

Input

None

Output

  • ZTIDiskUtility.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="ZTIDiskUtility.vbs"/>

Arguments

Value

Description

None

None

Properties

Name

Read

Write

None

 

 

ZTIDrivers.wsf

This script installs the additional device drivers onto the target computer prior to initiating the configuration of the operating system. This script reads the Drivers.xml file and copies the list of device driver files in the Drivers.xml file (created and managed by the Deployment Workbench Drivers node) to the target computer.

When not deploying the Windows Vista operating system, the following updates are also performed on the target computer:

  • The setup answer files, Sysprep.inf or Unattend.txt, are updated so that the OemPnPDriversPath property includes the new driver locations.

  • The following registry value is updated to include the new driver locations: HKEY_LOCAL_MACHINE\Microsoft\Windows\CurrentVersion\DevicePath.

Value

Description

Input

  • Drivers.xml. Contains a list of device drivers to be copied to the target computer.

  • CustomSettings.ini. Contains the list of property values, custom properties, database connections, deployment rules, and other information required by the scripts to complete the deployment process.

Output

  • PnpEnum.xml. Contains a list of all devices installed on the target computer.

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

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

References

  • Microsoft.BDD.PnpEnum.exe. Utility that enumerates Plug and Play devices.

  • 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 ZTIDrivers.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

 

DeploymentMethod

 

DeployRoot

 

DeploySystemDrive

 

DriverGroup

 

DriverPaths

 

OSDPlatformArch

 

Phase

 

ResourceRoot

 

TaskSequenceID

 

ZTIGather.wsf

This script gathers the properties and processing rules that control the deployment process. The properties and rules are explicitly defined in this script (also known as local properties), contained in the ZTIGather.xml file, contained in the CustomSettings.ini file, and in the deployment database (created in the Deployment Workbench Database node).

Value

Description

Input

  • ZTIGather.xml. Contains a list of predefined properties that are parsed in the .ini file and deployment database.

  • CustomSettings.ini. Contains the list of property values, custom properties, database connections, deployment rules, and other information required by the scripts to complete the deployment process.

Output

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

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

References

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

  • Wpeutil.exe. Initializes Windows PE and network connections; initiates LTI.

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

Location

distribution\Scripts

Use

cscript ZTIGather.wsf </debug:value> </localonly> </inifile:ini_file_name>

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).

/localonly

Returns only the information about the target computer and the current operating system installed on the target computer. Does not parse the input .ini file (specified in the /inifile argument) and returns properties and rules specified in the .ini file.

If not specified, the script will return information about the target computer, the currently installed operating system, and will parse the .ini file.

/inifile:ini_file_name

Name and path of the input .ini file that contains the properties and rules used in the deployment process.

If not specified, the script uses the default value of CustomSettings.ini.

Properties

Name

Read

Write

All

 

ZTIGroups.wsf

This script captures and restores the local group membership on the target computer. This script is called with the /capture argument to back up the group membership from the target computer before deploying the operating system. The CaptureGroups property contains the list of groups to be backed up by this script. The script is called with the /restore argument to restore the group membership after the operating system is deployed. When performing a restore, it will restore the membership of all groups that were backed up when the script was run using the /capture argument.

Note   When restoring group membership, the script does not create any destination groups that do not already exist on the target computer. Therefore, be sure to include all required groups in the reference computer when building the image file.

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

  • ZTIGroups.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 ZTIGroups.wsf </debug:value> </backup> </restore>

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).

/capture

Backs up the group membership of the local groups on the target computer as specified in the CaptureGroups property.

/restore

Restores the group membership to the local groups backed up earlier in the deployment process.

Properties

Name

Read

Write

CaptureGroups

 

Groups

HostName

 

ZTILangPacksOnline.wsf

Install Language Packs for Windows Vista and Windows Server 2008.

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

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

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

References

  • Lpksetup.exe. The Language Pack Setup tool (Lpksetup.exe) used to add or remove language packs.

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

Location

distribution\Scripts

Use

cscript ZTILangPacksOnline.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

 

OSVersion

 

ZTIMoveStateStore.wsf

This script moves the captured user state and backup files to C:\Windows\Temp\StateStore.

Note   This script is run only when deploying images using System Center Configuration Manager.

Value

Description

Input

None

Output

  • ZTIMoveStateStore.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 ZTIMoveStateStore.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

 

 

ZTINextPhase.wsf

This script updates the Phase property to the next phase in the deployment process. The Task Sequencer uses these phases to determine the sequence in which each task must be completed. The Phase property includes the following values:

  • VALIDATION. Identify that the target computer is capable of running the scripts necessary to complete the deployment process.

  • STATECAPTURE. Save any user state migration data before deploying the new target operating system.

  • PREINSTALL. Complete any tasks that need to be done (such as creating new partitions) before the target operating system is deployed.

  • INSTALL. Install the target operating system on the target computer.

  • POSTINSTALL. Complete any tasks that need to be done before restoring the user state migration data. These tasks customize the target operating system before starting the target computer the first time after deployment (such as installing updates or adding drivers).

  • STATERESTORE. Restore the user state migration data saved during the State Capture Phase.

For more information about the Phase property, see the corresponding topic 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

  • ZTINextPhase.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 ZTINextPhase.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

DeploymentMethod

 

Phase

ZTINICConfig.wsf

This script configures activated network adapters with values that were captured by ZTIGather.wsf based on the properties listed in the CustomSettings.ini file or the deployment database (created in the Deployment Workbench Database node).

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

  • ZTINICConfig.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.

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

Location

distribution\Scripts

Use

cscript ZTINicConfig.wsf </debug:value> </ForceCapture> </RestoreWithinWinPE>

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).

/ForceCapture

If there are any local networking adapters with static IP addresses saved, this script will capture those settings and save them to the local environment. For example: C:\MININT\SMSOSD\OSDLOGS\VARIABLES.DAT. This script can be useful in capturing static IP settings for a large number of machines for automation.

/RestoreWithinWinPE

When specified, will apply any saved static IP network settings to the local machine, when appropriate. Used for internal processing only.

Properties

Name

Read

Write

DeploymentMethod

 

DeploymentType

 

OSDAdapterCount

 

OSDMigrateAdapterSettings

 

Phase

 

ZTINICUtility.vbs

This script contains network adapter–related functions and subroutines that are called by the various scripts in the Microsoft Deployment deployment process.

Value

Description

Input

None

Output

None

References

None

Location

distribution\Scripts

Use

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

Arguments

Value

Description

None

None

Properties

Name

Read

Write

OSDAdapterAdapterIndexAdapterName

ZTIOSRole.wsf

This script installs server roles for target computers that are running Windows Server 2003 and Windows Server 2008. The script reads the OSRoles, OSRoleServices, and OSFeatures properties to determine what should be installed.

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

  • ZTIOSRole.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 ZTIOSRole.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

IsServerCoreOS

 

OSFeatures

 

OSRoles

 

OSRoleServices

 

OSVersion

 

ZTIPackages.wsf

This script installs a list of packages during the OSD State Restore Phase. The installation process is:

  1. Retrieve the list of packages from the Packages environment variable into the oPackageList dictionary object.

  2. Verify that the Osdswdexec executable can be located.

  3. Verify the existence of the specified .ini file. The default .ini file is CustomSettings.ini.

  4. Read the Systems Management Server database connection information from the specified .ini file.

  5. Connect to the Systems Management Server database.

  6. Read each package from oPackageList and call the InstallSinglePackage procedure to launch the installation.

  7. The InstallSinglePackage procedure queries the Systems Management Server database for the Systems Management Server package information.

  8. The InstallSinglePackage procedure launches the installation using Osdswdexec.exe.

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

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

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

References

  • Osdswdexec.exe. SMS OSD Feature Pack application installer.

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

Location

distribution\Scripts

Use

cscript ZTIPackages.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

PackageID

 

Packages

 

ProgramName

 

ZTIPatches.wsf

This script installs updates (language packs, security updates, and so on) that are listed in the Packages.xml file.

The script will terminate if the deployment is not in one of the following states:

  • DeploymentMethod equals OSD and Phase equals POSTINSTALL

  • DeploymentMethod not equal OSD and Phase equals PREINSTALL

The script will start Pkgmgr if the deployment is in the following state:

  • DeploymentMethod equals OSD and Phase equals POSTINSTALL.

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

  • ZTIPatches.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.

  • Pkgmgr.exe. Installs or updates Windows Vista offline.

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

Location

distribution\Scripts

Use

cscript ZTIPatches.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

 

DeployRoot

 

DeploymentMethod

 

DeploymentType

 

LanguagePacks

 

OSDPlatformArch

 

Phase

 

ResourceRoot

 

ZTIPrereq.vbs

This script checks to verify that the target computer has the prerequisite software installed, and that it is functional. The checks performed are:

  • Determine if the Windows Script version is equal to or greater than version 5.6.

  • Verify that errors do not occur when object references are instantiated to Wscript.Shell, Wscript.Network, Scripting.FileSystemObject MSXML2.DOMDocument, and the Process environment.

If any one of the checks fail, an error is raised and the script exits the ValidatePrereq procedure.

Value

Description

Input

None

Output

None

References

None

Location

distribution\Scripts

Use

None

Arguments

Value

Description

None

None

Properties

Name

Read

Write

None

 

 

ZTICONFIGMGR.wsf

This script initializes ZTI when deploying using Systems Center Configuration Manager. The script process is:

  1. If debugging is activated, the script creates the OSD.Debug and Archive_OSD.sms files.

  2. It configures these properties:

    1. ScriptRoot is set to the parent folder of the current running script.

    2. DeployRoot is set to the parent folder of ScriptRoot.

    3. ResourceRoot is set to DeployRoot.

    4. DeploySystemDrive is set to “C:.”

    5. DeploymentMethod is set to “CONFIGMGR.”

  3. When DeployRoot contains “:\”:

    1. The DeployRoot folder is copied to _SMSTSMDataPath\WDPackage.

    2. ScriptRoot is set to _SMSTSMDataPath\WDPackage\Scripts.

    3. DeployRoot is set to the parent folder of ScriptRoot.

    4. ResourceRoot is set to DeployRoot.

  4. When Phase is NULL:

    1. If the %SystemDrive% environment variable is “X:,” then DeploymentType is set to “NEWCOMPUTER” and Phase is set to “PREINSTALL.” Otherwise DeploymentType is set to “REPLACE” and Phase is set to “VALIDATION.”

    2. If the OldComputer.tag file exists in the parent folder of the current running script, then DeploymentType is set to “REPLACE” and Phase is set to “VALIDATION.” Otherwise DeploymentType is set to “REFRESH” and Phase is set to “VALIDATION.”

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

  • ZTICONFIGMGR.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 ZTICONFIGMGR.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

_SMSTSMDataPath

 

BDDPackageID

DeploymentMethod

 

DeploymentType

DeployRoot

DeploySystemDrive

 

Phase

ResourceRoot

ScriptRoot

ZTISetVariable.wsf

This script sets the specified global task sequence variable that corresponds to the name contained in VariableName to the value contained in VariableValue.

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

  • ZTISetVariable.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 ZTISetVariable.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

VariableName

 

VariableValue

 

ZTITatoo.wsf

This script will tattoo the target computer with identification and version information. The processes of this script are:

  • Locate and copy the ZTITatoo.mof file to the %SystemRoot%\System32\Wbem folder. Any preexisting ZTITatoo.mof that exists at the destination will be deleted prior to starting the copy operation.

  • Mofcomp.exe will be run using the following command line: %SystemRoot%\System32\Wbem\Mofcomp.exe -autorecover %SystemRoot%\System32\Wbem\ZTITatoo.mof.

  • These deployment details are written to the registry at HKEY_LOCAL_MACHINE\Software\Microsoft\BDD 2007:

    • Deployment Method is set to DeploymentMethod.

    • Deployment Type is set to DeploymentType.

    • Deployment Timestamp is set to the current date in WMI date format.

    • Task Sequence ID is set to TaskSequenceID.

    • Task Sequence Name is set to TaskSequenceName.

    • Task Sequence Version is set to TaskSequenceVersion.

  • If OSDPACKAGEID is not NULL, these deployment details are written to the registry at HKEY_LOCAL_MACHINE\Software\Microsoft\BDD 2007:

    • OSD Package ID is set to OSDPACKAGEID.

    • OSD Program Name is set to OSDPROGRAMID.

    • OSD Advertisement ID is set to OSDADVERTID.

  • If OSDPACKAGEID is not NULL, these deployment details are written to the registry at HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion:

    • CM_DSLID is set to OSDSITECODE:OSDPACKAGEID.

Note   This script is not designed to run on Windows PE.

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

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

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

References

  • Mofcomp.exe. Command line .mof file compiler.

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

Location

distribution\Scripts

Use

cscript ZTITatoo.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

DeploymentMethod

 

DeploymentType

 

OSDAdvertID

 

OSDPackageID

 

OSDProgramID

 

OSDSiteCode

 

OSVersion

 

TaskSequenceID

 

TaskSequenceName

 

TaskSequenceVersion

 

ZTIUserState.wsf

This script initializes USMT to capture and restore user state on the target computer.

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

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

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

References

  • Loadstate.exe. Deposits user state data on a target computer

  • Msiexec.exe. Manages the installation of .msi-based applications.

  • Scanstate.exe. Collects user data and settings.

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

Location

distribution\Scripts

Use

cscript ZTIUserState.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

 

DeploymentType

 

DeploySystemDrive

 

ImageSize

 

ImageSizeMultiplier

 

InstallFromPath

 

IsServerOS

 

LoadStateArgs

 

OSDPackagePath

 

OSDStateStorePath

 

OSVersion

 

ScanStateArgs

 

StatePath

UDDir

 

UDProfiles

 

UDShare

 

UserDataLocation

 

USMTConfigFile

 

USMTEstimate

USMTLocal

 

USMTMigFiles

 

ZTIUtility.vbs

This script contains utility functions that are used by most of the Microsoft Deployment 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

None

References

  • OSDConnectToUNC.exe. Connects to a UNC path.

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

Location

  • distribution\Scripts

  • program_files\Microsoft Deployment Toolkit\Scripts

Use

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

Arguments

Value

Description

None

None

Properties

Name

Read

Write

_SMSTSAdvertID

 

_SMSTSCurrentActionName

 

_SMSTSCustomProgressDialogMessage

 

_SMSTSInstructionTableSize

 

_SMSTSLogPath

 

_SMSTSOrgName

 

_SMSTSNextInstructionPointer

 

_SMSTSPackageID

 

_SMSTSPackageName

 

_SMSTSPackagePath

 

_SMSTSReserved1

 

_SMSTSReserved2

 

Architecture

 

AssetTag

 

EventShare

 

ComputerName

 

Debug

DeployRoot

 

HostName

 

ImageBuild  

ImageFlags

 

ImageIndex

 

ImageLanguage

 

ImageMemory

 

ImageProcessor

 

ImageProcessorSpeed

 

ImageSize

 

InstallFromPath

 

JoinDomain

 

MacAddress

 

OSDAdvertID

 

OSDComputerName

 

OSDNewMachineName

 

OSDPackageID

 

OSDPackagePath

 

OSDReserved1

 

OSGUID

 

OSVersion

 

Phase

 

ResourceRoot

 

SLShare

 

TaskSequenceName

 

TaskSequenceVersion

 

UDDir

 

UDShare

 

UUID

 

UserID

UserPassword

UserDomain

WDSServer

 

ZTIValidate.wsf

This script ensures that it is safe for the deployment to continue by validating the condition of the target computer. The script processes are:

  • If DeploymentType equals “REFRESH” or “UPGRADE” and the target computer is a server, the script will exit.

  • If OSInstall exists and is not equal to “Y”, the script will exit.

  • Verify the minimum amount of RAM exists on the target computer. If not, the script will exit.

  • Verify the processor meets the minimum required speed. If not, the script will exit.

  • Verify the hard disk size meets the minimum size requirements. If not, the script will exit.

  • Verify that the target computer’s operating system is installed on drive C. If not, the script will exit.

  • During an Upgrade scenario: If VerifyOS = “SERVER,” verify that a server operating system is not pending deployment to a target computer that is running a workstation operating system.

  • During an Upgrade scenario: If VerifyOS = “CLIENT,” verify that a workstation operating system is not pending deployment to a target computer that is running a server operating system.

  • If DeploymentType equals “REFRESH,” verify that drive C is not compressed by running Compact /u C:\.

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

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

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

References

  • Compact.exe. Displays or alters the compression of files on NTFS file system partitions.

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

Location

distribution\Scripts

Use

cscript ZTIValidate.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

DeploymentType

 

ImageMemory

 

ImageProcessorSpeed

 

ImageSize

 

ImageSizeMultiplier

 

IsServerOS

 

Memory

 

OSDPackagePath

 

OSInstall

 

ProcessorSpeed  

 

VerifyOS

 

ZTIWindowsUpdate.wsf

This script scans for and installs required updates. The script processes include:

  • Download the WURedist.cab file from: https://update.microsoft.com/redist.

  • Extract the WURedist.xml from the WURedist.cab file to the %Temp% directory.

  • Verify the version of the %SystemRoot%\System32\Wuaueng.dll file meets the minimum required as specified by the clientVersion property contained in the WURedist.xml file. If not, the latest Windows Update Agent (WUA) will be downloaded from the location specified in the downloadUrl property contained in the WURedist.xml file. When the download completes, the downloaded file will be installed using the following command line arguments: /wuforce /quiet.

  • Delete the files that were recently downloaded.

  • The Muauth.cab file is downloaded from: https://download.windowsupdate.com/v6/windowsupdate/redist/standalone.

  • The Authorization.xml file is extracted from the Muauth.cab file to the %Temp% directory.

  • Read the ServiceID from the Authorization.xml file and configure the Automatic Updates service accordingly.

  • Retrieve the script's command-line argument.

  • Verify that the target computer’s operating system has been activated.

  • Build an exclusions list based on values contained in WUMU_ExcludeKB and WUMU_ExcludeID.

  • Use the Automatic Updates service to query for updates with a status specified by UpdateCommand.

  • Mark for download and installation any updates that are not found in the exclusions list and that do not require user input.

  • Download and install the binaries for any updates that require installation.

  • Set SMSTSRebootRequested to “true.”

Note   Consider customizing the script so that it collects the Windows Update Agent installation files and software updates from an internal enterprise server rather than from the Microsoft servers.

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

  • ZTIWindowsUpdate.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.

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

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

Location

distribution\Scripts

Use

cscript ZTIWindowsUpdate.wsf </debug:value> <UpdateCommand:<IsInstalled=0|1> <IsHidden=0|1>> <Query:true|false>

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).

/UpdateCommand:param

  • IsInstalled. Set to 0 to query for updates that are not installed.

  • IsHidden. Set to 0 to query for updates that are hidden.

/Query:value

  • True. Query only for required updates. Do not download and install any binaries.

  • False. Query for and install required updates. Download and install binaries.

Note   When specified, UpdateCommand requires at least one option.

Note   If specifying both options for UpdateCommand, they must be separated by “and”.

Note   The default value for UpdateCommand is IsInstalled=0 and IsHidden=0.

Properties

Name

Read

Write

Architecture

 

MSIT_WU_Count

SMSTSRebootRequested

SMSTSRetryRequested

WUMU_ExcludeID

 

WUMU_ExcludeKB

 

ZTIWipeDisk.wsf

This script formats the target computer’s hard disk. The script processes include:

  • The script exits if WipeDisk is not equal to “TRUE”.

  • Determines the appropriate drive to format.

  • Formats the drive by calling cmd /c format Drive /fs:ntfs /p:3 /Y where Drive is the drive letter of the hard disk drive to be formatted.

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

  • ZTIWipeDisk.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 ZTIWipeDisk.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

ResourceRoot

WipeDisk

 

Download

Get the Microsoft Deployment Solution Accelerator

Update Notifications

Sign up to learn about updates and new releases

Feedback

Send us your comments or suggestions