Toolkit Reference for the Microsoft Deployment Toolkit

This reference is part of Microsoft® Deployment Toolkit (MDT) 2013 and provides configuration settings that you can use in the deployment process. Review the MDT 2013 documents Microsoft Deployment Toolkit Samples Guide and Using the Microsoft Deployment Toolkit for help in customizing configuration settings for the deployment environment.

Note

In this document, Windows applies to the Windows 8.1, Windows 8, Windows 7, Windows Server® 2012 R2, Windows Server 2012, and Windows Server 2008 R2 operating systems unless otherwise noted. MDT does not support ARM processor–based versions of Windows. Similarly, MDT refers to MDT 2013 unless otherwise stated.

Task Sequence Steps

Task sequences are created by the Task Sequence Editor and consist of a combined series of steps that are designed to complete an action. Task sequences can operate across a computer restart and can be configured to automate tasks on a computer without requiring user intervention. In addition, you can add task sequence steps to a task sequence group, which helps keep similar task sequence steps together for better organization and error control.

Each task sequence step performs a specific task, such as validating that the target computer is capable of receiving the deployment image, storing user data in a safe location, deploying an image to a target computer, and restoring saved user data. These task sequence steps accomplish their tasks by using utilities and scripts provided with MDT or by the deployment team. Use this reference to help determine the correct task sequence groups and task sequence steps to configure the deployment process and the valid properties and options to use.

The following information is provided for each task sequence group and step:

  • Name. The name of the task sequence group or step

  • Description. A description of the purpose of the task sequence group or step and any pertinent information regarding its customization

  • Properties. Indicates the valid configuration properties that you can specify for the task sequence group or step that define how the task is performed

  • Options. Indicates the valid configuration options that you can specify for the task sequence group or step that define if and when the task is performed and what is considered a successful exit code from the task

    For more information about the Task Sequence Editor, see Operating System Deployment: Task Sequence Editor.

Common Properties and Options for Task Sequence Step Types

Each task sequence group and step has configurable settings on the Properties and Options tabs that are common to all task sequence groups and steps. These common settings are briefly described in the following sections.

Common Properties

Table 1 shows the settings that are available on the Properties tab of each task sequence step. For more information about the Properties tab for a particular task sequence step, see the topic that corresponds to the step later in this reference.

Note

The task sequence step types listed here are those that are available in the Deployment Workbench. Additional task sequence step types might be available when configuring task sequences using Microsoft System Center 2012 R2 Configuration Manager.

Table 1. Settings Available on the Properties Tab
Name Description Group Step
Type A read-only value that indicates the task sequence group or step type. The type will be set to one of these values:

- Apply Network Settings

- Authorize DHCP

- Capture Network Settings

- Configure ADDS

- Configure DHCP

- Configure DNS

- Enable BitLocker

- Format and Partition Disk

- Gather

- Group

- Inject Drivers

- Install Application

- Install Operating System

- Install Roles and Features

- Install Updates Offline

- Recover From Domain Join Failure

- Restart computer

- Run Command Line

- Validate
- -
Name A user-defined name that should allow easy identification and differentiation from other task sequence steps. - -
Description A user-defined description that should make the task sequence step requirements and tasks easily understandable. - -

Common Options

Table 2 shows the settings that are available on the Options tab of a task sequence step. For more information about the Options tab, see Task Sequence Options Tab.

Table 2. Settings Available on the Options Tab
Name Description Group Step
Disable this step Select this option to disable this task sequence step. - -
Success codes Exit codes of the utility associated with this task sequence step that indicate that the step has finished successfully. -
Continue on error Select this option to allow the Task Sequencer to process additional task sequence steps if a failure occurs. - -
Conditional statements One or more conditions that limit the running of this task sequence group or step. These conditional are based on the following:

- File properties

- Folder properties

Operating system version:

- Is a certain architecture

- Is a certain version

- Query Windows Management Instrumentation (WMI)

Registry setting:

- Exists

- Does not exist

- Equals

- Does not equal

- Greater than

- Greater than or equals

- Less than

- Less than or equals

- Installed software

Task sequence variable:

- Exists

- Equals

- Does not equal

- Greater than

- Greater than or equals

- Less than

- Less than or equals

These conditions can be grouped using IF statements that test all conditions, any condition, or no condition that evaluates as True.
- -

Note

Additional conditional statements might be available when using Configuration Manager to configure task sequence steps.

Specific Properties and Settings for Task Sequence Step Types

Some properties and parameters of each task sequence step type are unique to that type. Each type with unique properties and settings is shown in the following sections with its unique task sequence step properties and settings.

Apply Network Settings

This task sequence step configures the network adapter on the target computer. For more information about what script accomplishes this task and which properties are used, see ZTINICConfig.wsf.

The unique properties and settings for the Apply Network Settings task sequence step type are:

Properties
Name Value
Type Apply Network Settings
Settings
Name Value
Name The name to be assigned to the network connection.
Obtain an IP address automatically When selected, Dynamic Host Configuration Protocol (DHCP) is used to obtain the required Internet Protocol (IP) configuration settings for the network connection. This is the default selection.
Use the following IP address When selected, you can provide one or more IP address and subnet mask combinations in addition to gateways that will be assigned to the network connection.
Obtain a Domain Name System (DNS) server automatically When selected, DHCP is used to obtain the required IP configuration settings for the network connection. This is the default selection.
Use the following DNS servers When selected, you can provide one or more DNS server IP addresses that will be assigned to the network connection.
DNS Suffix The DNS suffix that will be applied to all network connections that use TCP/IP.
Register this connection’s address in DNS Specifies that the computer will attempt dynamic registration of the IP addresses (through DNS) of this connection with the full computer name of this computer.
Use this connection’s DNS suffix in DNS registration Specifies whether DNS dynamic update is used to register the IP addresses and the connection-specific domain name of this connection.
WINS server addresses You can provide one or more Windows Internet Naming Service (WINS) server IP addresses that will be assigned to the network connection.
Enable LMHOSTS lookup Specifies whether a local area network (LAN) Manager Hosts (LMHOSTS) file for network basic input/output system (NetBIOS) name resolution is used.
Default Specifies whether this network connection obtains the setting to enable or disable NetBIOS over TCP/IP (NetBT) from a DHCP server. This is the default selection.
Enable NetBIOS over TCP/IP Specifies that this network connection uses NetBT and WINS.
Disable NetBIOS over TCP/IP Specifies that this network connection does not use NetBT and WINS.

Authorize DHCP

This task sequence step authorizes the target computer as a DHCP server. For more information about which script accomplishes this task and which properties you use, see ZTIAuthorizeDHCP.wsf.

The unique properties and settings for the Authorize DHCP task sequence step type are:

Properties
Name Description
Type Set this read-only type to Authorize DHCP Server.
Settings
Name Description
Name Description
Account A user account that is a member of the Enterprise Admins group, to be used when authorizing DHCP for the target computer.

Capture Network Settings

This task sequence step gathers the network adapter settings from the target computer. For more information about which script accomplishes this task and which properties you use, see ZTINICConfig.wsf.

The unique properties and settings for the Capture Network Settings task sequence step type are:

Properties
Name Description
Name Description
Type Set this read-only type to Capture Network Settings.
Settings
Name Description
None None

Configure ADDS

This task sequence step configures the target computer as an Active Directory® Domain Services (AD DS) domain controller. For more information about the settings listed in the following tables and which this task sequence step can configure, see the Microsoft Help and Support article, Unattended promotion and demotion of Windows 2000 and Windows Server 2003 domain controllers.

The unique properties and settings for the Configure ADDS task sequence step type are:

Properties
Name Description
Type Set this read-only type to Configure ADDS.
Settings
Name Description
Create Specifies the configuration set that will be used to configure the target computer. The configuration sets are:

- New domain controller replica. Creates an additional domain controller in an existing AD DS domain

- New read-only domain controller (RODC) replica. Creates an RODC

- New domain in existing forest. Creates a domain in an existing AD DS forest

- New domain tree in existing forest. Creates a new tree in an existing AD DS forest

- New forest. Creates a new AD DS forest
Domain DNS name The DNS name of the new or existing domain.
Domain NetBIOS name The NetBIOS name of the new child domain, child domain tree, or forest that pre–AD DS clients use to access the domain. This name must be unique on the network.
DNS name The DNS name of the child domain or domain tree.
Replication source domain controller The name of the domain controller from which to source AD DS on new replica or backup domain controller upgrade installations. If no value is supplied, the closest domain controller from the domain being replicated will be selected by default.
Account The account to be used to perform the configuration.
Recovery (safe mode) password The password for the offline Administrator account that is used in AD DS Repair mode.
Install DNS if not already present When selected, DNS will be installed if it has not already been installed.
Make this domain controller a global catalog (GC) server Specifies whether the replica will also be a GC server. When selected, the target computer will be configured as a GC server if the replication source domain controller is a GC server.
Wait for critical replication only When selected, this setting specifies that only critical replication is sourced during the replication phase of Dcpromo. Noncritical replication resumes when the computer restarts as a domain controller.
Forest functional level Specifies the functional level for a new forest. Available options are:

- Windows Server 2003

- Windows Server 2008

- Windows Server 2008 R2
Domain functional level Specifies the functional level for a new domain. Available options are:

- Windows Server 2003

- Windows Server 2008

- Windows Server 2008 R2
Database Fully qualified, non–Universal Naming Convention (UNC) directory on a hard disk of the local computer that will host the AD DS database (NTDS.dit). If the directory exists, it must be empty. If it does not exist, it will be created. Free disk space on the logical drive selected must be 200 megabytes (MB) and possibly larger when rounding errors are encountered and to accommodate all objects in the domain. For best performance, the directory should be located on a dedicated hard disk.
Log files Fully qualified, non-UNC directory on a hard disk on the local computer to host the AD DS log files. If the directory exists, it must be empty. If it does not exist, it will be created.
SYSVOL Fully qualified, non-UNC directory on a hard disk of the local computer that will host the AD DS System Volume (SYSVOL) files. If the directory exists, it must be empty. If it does not exist, it will be created. The directory must be located on a partition that is formatted with the NTFS version 5.0 file system. For best performance, the directory should be located on a different physical hard disk than the operating system.
Site name The value of an existing AD DS site on which to locate the new domain controller. If not specified, an appropriate site will be selected. This option only applies to the new tree in a new forest scenario. For all other scenarios, a site will be selected using the current site and subnet configuration of the forest.

Configure DHCP

This task sequence step configures the DHCP server service on the target computer. For more information about which script accomplishes this task and which properties you use, see ZTIConfigureDHCP.wsf.

The unique properties and settings for the Configure DHCP task sequence step type are:

Properties
Name Description
Type Set this read-only type to Configure DHCP Server.
Settings
Name Description
Name Configure DHCP
Scope Details These options apply to any client computers that obtain a lease within that particular scope. Configured scope option values always apply to all computers obtaining a lease in a given scope unless they are overridden by options assigned to class or client reservation.

Within the Scope Details setting, the following sub-settings are configurable:

- Scope Name. A user-definable name

- Start IP address. The starting IP address for the scope

- End IP address. The ending IP address for the scope

- Subnet mask. The subnet mask of the client subnet

- Lease duration for DHCP clients. The duration that the DHCP lease is valid for the client

- Description. A description of the scope

- Exclude IP address range, Start IP address. The starting IP address for the range of IP addresses that are to be excluded from the scope

- Exclude IP address range, End IP address. The ending IP address for the range of IP addresses that are to be excluded from the scope

- 003 Router. A list of IP addresses for routers on the client subnet

- 006 DNS Servers. A list of IP addresses for DNS name servers available to the client

- 015 DNS Domain Name. The domain name that the DHCP client should use when resolving unqualified domain names with DNS

- 044 WINS/NBNS Servers. Lists the IP addresses for NetBIOS name servers (NBNSes) on the network

- 046 WINS/NBT Node Type. Configures the client node type for NetBT clients

- 060 PXE Client. The address used for Pre-Boot Execution Environment (PXE) client bootstrap code
Server Options These options apply globally for all scopes and classes defined at each DHCP server and for any clients that a DHCP server services. Configured server option values always apply unless they are overridden by options assigned to other scope, class, or client reservation.

Within the Server Options setting, the following sub-settings are configurable:

- 003 Router. A list of IP addresses for routers on the client subnet

- 006 DNS Servers. A list of IP addresses for DNS name servers available to the client

- 015 DNS Domain Name. The domain name that the DHCP client should use when resolving unqualified domain names with the DNS

- 044 WINS/NBNS Servers. Lists the IP addresses for NBNSes on the network

- 046 WINS/NBT Node Type. Configures the client node type for NetBT clients

- 060 PXE Client. The address used for PXE client bootstrap code

Configure DNS

This task sequence step configures DNS on the target computer. For more information about which script accomplishes this task and which properties you use, see ZTIConfigureDNS.wsf.

The unique properties and settings for the Configure DNS task sequence step type are:

Properties
Name Description
Type Set this read-only type to Configure DNS Server.
Settings
Name Description
Name Configure DNS
Zones Within the Scope Details setting, the following sub-settings are configurable:

- DNS zone name. A user-definable name

- Type. The type of DNS zone to be created

- Replication. Specifies the replication scheme used to share information among DNS servers

- Zone file name. The zone’s DNS database file

- Dynamic updates. Enables DNS client computers to register and dynamically update their resource records with a DNS server whenever changes occur

- Scavenge stale resource records. Removes stale resource records
Server Properties Within the Server Properties setting, the following sub-settings are configurable:

- Disable recursion. Specifies that the DNS server will not perform recursion on any query

- BIND secondaries. Specifies whether to use fast transfer format to transfer a zone to DNS servers running legacy Berkeley Internet Name Domain (BIND) implementations

- Fail on load if bad data. Specifies the DNS server should parse files strictly

- Enable round robin. Specifies the DNS server should use the round robin mechanism to rotate and reorder a list of resource records if multiple resource records exist of the same type exist for a query answer

- Enable netmask ordering. Specifies whether the DNS server should reorder resource records within the same resource record set in its response to a query based on the IP address of the source of the query

- Secure cache against pollution. Specifies whether the DNS server will attempt to clean up responses to avoid cache pollution

- Name checking. Configures the name-checking method to be used

Note

The Configure DNS task sequence step uses the Dnscmd tool, which is included in Windows Support Tools, to configure DNS. Be sure that Windows Support Tools is installed before running the Configure DNS task sequence step.

Note

For more information about these server properties, see Dnscmd.

Enable BitLocker

This task sequence step configures BitLocker® Drive Encryption on the target computer. For more information about this step type, see Enable BitLocker.

The unique properties and settings for the Enable BitLocker task sequence step type are:

Properties
Name Description
Type Set this read-only type to Enable BitLocker.
Settings
Name Description
Current operating system drive When selected, the operating system drive will be configured. This is the default selection.
Specific drive When selected, the specified drive will be configured.
TPM only When selected, the Trusted Platform Module (TPM) is required. This is the default selection.
Startup key on USB only When selected, a startup key is required on the specified USB drive.
TPM and startup key on USB When selected, the TPM is required in addition to a startup key on the specified USB drive.
In Active Directory When selected, the recovery key is stored in AD DS. This is the default selection.
Do not create a recovery key When selected, the recovery key is not created. Using this option is not recommended.
Wait for BitLocker to complete When selected, this step will not finish until after BitLocker has finished processing all drives.

Execute Runbook

This task sequence step runs Microsoft System Center 2012 Orchestrator runbooks on the target computer. An Orchestrator runbook is the sequence of activities that orchestrate actions on computers and networks. You can initiate Orchestrator runbooks in MDT using this task sequence step type.

Note

This task sequence step is not included any MDT task sequence templates. You must add this task sequence step to any task sequences you create.

The unique properties and settings for the Execute Runbook task sequence step type are:

Properties
Name Description
Type Set this read-only type to Execute Runbook.
Name The name of the task sequence step, which should reflect the name of the runbook being run.
Description Informative text that provides additional information about the task sequence step
Settings
Name Description
Orchestrator Server Type the URL for the Orchestrator web service, which includes the server name. The Orchestrator web service can use either Hypertext Transfer Protocol (HTTP) or HTTP over Secure Sockets Layer (HTTPS). The Orchestrator web service defaults to port 81.

The Orchestrator web service supports multiple runbook servers. By default, a runbook can run on any runbook server. A runbook can be configured to specify which runbook servers should be used to run the runbook.

Note:

The Orchestrator web service supports the ability to run a runbook on a specific runbook server. This feature is not supported in MDT.

Specify the URL in any of the following formats:

- servername. When using this format, the URL defaults to:

http://<servername>:81/Orchestrator2012/Orchestrator.svc

- servername:port. When using this format, the URL defaults to:

http://<servername:port>/Orchestrator2012/Orchestrator.svc.

- http://*servername:port. When using this format, the URL defaults to:

http://<servername:port>/Orchestrator2012/Orchestrator.svc.

- **http://
servername:port. When using this format, the URL defaults to:

https://<servername:port>/Orchestrator2012/Orchestrator.svc.

- *
http://servername:port/Orchestrator2012/Orchestrator.svc
. When using this format, MDT assumes that you are providing the fully qualified URL, because the value ends with .svc.

- https://servername:port/Orchestrator2012/Orchestrator.svc. When using this format, MDT assumes that you are providing the fully qualified URL, because the value ends with .svc.
Runbook Click Browse, and then select the name of the Orchestrator runbook that this task sequence should run.

Note:

To successfully browse for Orchestrator runbooks, install the ADO.NET Data Services Update for .NET Framework 3.5 SP1 for Windows 7 and Windows Server 2008 R2.
Automatically provide runbook parameters Select this option to automatically provide the Orchestrator runbook input parameter values( which assumes that the runbook parameter values are task sequence variables). For example, if a runbook has an input parameter named OSDComputerName, then the OSDComputerName task sequence variable value is passed to the runbook.

Note:

This option works only for input parameters that are valid task sequence variable names and do not contain spaces or other special characters. Although spaces and other special characters are supported as Orchestrator parameter names, they are not valid task sequence variable names. If you need to pass values to parameters with spaces or other special characters, use the Specify explicit runbook parameters option.

The other option is Specify explicit runbook parameters.

Note:

The values provided for the runbook input parameters to the Orchestrator web service are formatted as XML. Passing values that contain data that is or resembles XML-formatted data may cause errors.
Specify explicit runbook parameters Select this option to explicitly provide the Orchestrator runbook input parameters.

You must configure the following settings for each input parameter that the Orchestrator runbook requires:

- Name. This is the name of the input runbook parameter.

Note:

If you change the parameters for an existing Orchestrator runbook, you need to browse (reselect) for the runbook again, because MDT only retrieves the parameter list when initially adding the Orchestrator runbook.

- Value. This can be a constant or a variable, such as a task sequence variable or an environment variable. For example, you can specify a value of %OSDComputerName%, which will pass the value of the OSDComputerName task sequence variable to the runbook input parameter.
Wait for the runbook to finish before continuing This check box controls whether the task sequence step will wait for the runbook to finish before proceeding to the next task sequence step.

If this check box is:

- Selected, then the task sequence step will wait for the runbook to finish before proceeding on to the next task sequence step.

When this check box is selected, the task sequence step will poll the Orchestrator web service for the runbook to finish. The amount of time between polls starts at 1 second, then increases to 2, 4, 8, 16, 32, and 64 seconds between each poll. Once the amount of time reaches 64 seconds, the task sequence step continues to poll every 64 seconds.

- Cleared, then the task sequence step will not wait for the runbook to finish before proceeding to the next task sequence step.

Note:

This check box must be selected if the runbook returns output parameters.

Format and Partition Disk

This task sequence step partitions and formats disks on the target computer. For more information about this step type, see Format and Partition Disk.

The unique properties and settings for the Format and Partition Disk task sequence step type are:

Properties
Name Description
Type Set this read-only type to Format and Partition Disk.
Settings
Name Description
Disk number The physical number of the disk to be configured.
Disk type The type of drive to be created. Values are:

- Standard (MBR) (Master Boot Record)

- GPT (GUID [globally unique identifier] Partition Table).

The default selection is Standard (MBR).
Volume Within the Volume setting, the following sub-settings are configurable:

- Partition Name. A user-definable name.

- Partition Type. Values vary by disk type:

- MBR: Primary only

- GPT: Primary, EFI, or MSR

- Use a percentage of remaining space.

- Use specific drive size. Values are in increments of 1 MB or 1 gigabyte (GB).

- Make this a boot partition.

- File System. Values are NTFS or FAT32.

- Quick Format. When selected, a quick format is performed.

- Variable. The drive letter that was assigned to this newly configured partition.

Note

When using the CustomSettings.ini file to specify the hard disk and partition configurations, only the first hard disk and first two partitions will be configured. Edit ZTIGather.xml to configure additional hard disks or partitions.

Gather

This task sequence step gathers data and processing rules for the target computer. The unique properties and settings for the Gather task sequence step type are:

Properties
Name Description
Type Set this read-only type to Gather.
Settings
Name Description
Gather only local data When selected, this step processes only the properties contained in the ZTIGather.xml file.
Gather local data and process rules When selected, this step processes the properties contained in the ZTIGather.xml file and the properties contained in the file that the Rules file specifies. This is the default selection.
Rules file The name of the Rules file to process. If left blank, the task sequence step attempts to locate and process the CustomSettings.ini file.

Note

This task sequence step is natively available in System Center 2012 R2 Configuration Manager as Set Dynamic Variablesin the General group.

Inject Drivers

This task sequence step injects drivers that have been configured for deployment to the target computer. The unique properties and settings for the Inject Drivers task sequence step type are:

Properties
Name Description
Type Set this read-only type to Inject Drivers.
Settings
Name Description
Install only matching drivers Injects only the drivers that the target computer requires and that match what is available in Out-of-Box Drivers
Install all drivers Installs all drivers
Selection profile Installs all drivers in the selected profile

Install Application

This task sequence step installs applications on the target computer. For more information about this step type, see Install Software.

The unique properties and settings for the Install Application task sequence step type are:

Properties
Name Description
Type Set this read-only type to Install Application.
Settings
Name Description
Install multiple applications Install mandatory applications that the MandatoryApplications property has specified and optional applications that the Applications property has specified. These properties are configured by rules or are specified during the Deployment Wizard interview process. This is the default selection.
Install a single application The specific application to install. You select the application from a drop-down list that consists of applications that have been configured in the Applications node of the Deployment Workbench.
Success codes A space-delimited list of application installation exit codes that should be used when determining the successful installation of applications.

Install Operating System

This task sequence step installs an operating system on the target computer. MDT can deploy Windows 8.1, Windows 8, Windows 7, Windows Server 2012 R2, Windows Server 2012, and Windows Server 2008 R2 using:

  • setup.exe. This method is the traditional method used, initiated by running setup.exe from the installation media. MDT uses setup.exe by default.

  • imagex.exe. This method installs the operating system image using imagex.exe with the /apply option. MDT uses this method when the setup.exe method cannot be used (i.e., it falls back to using imagex.exe).

    You can control which of these methods is used by using the ForceApplyFallback property, which also affects which operating system task sequences are listed in the Deployment Wizard for a specific processor architecture boot image. For more information, see the ForceApplyFallback property.

    The unique properties and settings for the Install Operating System task sequence step type are:

Properties
Name Description
Type Set this read-only type to Install Operating System.
Settings
Name Description
Operating system to install The name of the operating system to be installed on the target computer. You select the operating system from a drop-down list compiled from operating systems that have been configured in the Operating Systems node of the Deployment Workbench.
Disk The disk on which to install the operating system.
Partition The partition on which to install the operating system.

Install Roles and Features

This task sequence step installs the selected roles and features on the target computer. For more information about which script accomplishes this task and the properties used, see ZTIOSRole.wsf.

The unique properties and settings for the Install Roles and Features task sequence step type are:

Properties
Name Description
Type Set this read-only type to Install Roles and Features.
Description Informative text that describes the purpose of the task sequence step.
Settings
Name Description
Select the operating system for which the roles are to be installed Select the operating system to be deployed to the target computer.
Select the roles and features that should be installed Select one or more roles and features for installation on the target computer.

Install Language Packs Offline

This task sequence step installs updates to the image on the target computer after the operating system has been deployed but before the target computer has been restarted. These updates include language packs. For more information about which script accomplishes this task and which properties you use, see ZTIPatches.wsf.

The unique properties and settings for the Install Language Packs Offline task sequence step type are:

Properties
Name Description
Type Set this read-only type to Install Updates Offline.
Settings
Name Description
Package Name The name of the language pack package that should be applied to the target computer

Note

This task sequence step is valid only when using MDT with Configuration Manager.

Install Language Packs Online

This task sequence step installs language packs to the image on the target computer after the operating system has been deployed and after the target computer has been restarted. For more information about which script accomplishes this task and which properties you use, see ZTILangPacksOnline.wsf.

The unique properties and settings for the Install Language Packs Online task sequence step type are:

Properties
Name Description
Type Set this read-only type to Install Language Packs Online.
Settings
Name Description
Package Name The name of the language pack package that should be applied to the target computer

Note

This task sequence step is valid only when using MDT with Configuration Manager.

Install Updates Offline

This task sequence step installs updates to the image on the target computer after the operating system has been deployed but before the target computer has been restarted. These updates include language packs. For more information about which script accomplishes this task and which properties you use, see ZTIPatches.wsf.

The unique properties and settings for the Install Updates Offline task sequence step type are:

Properties
Name Description
Type Set this read-only type to Install Updates Offline.
Settings
Name Description
Selection Profile The name of the selection profile that should be applied to the target computer

Note:

When using MDT with Configuration Manager, specify the name of the update package that should be applied.

Recover from Domain Join Failure

This task sequence step verifies that the target computer has joined a domain. The unique properties and settings for the Recover from Domain Join Failure task sequence step type are:

Properties
Name Description
Type Set this read-only type to Recover from Domain Join Failure.
Settings
Name Description
Auto recover The task sequence step attempts to join the target computer to a domain.
Manual recover If the target computer fails to join a domain, the task sequence step causes the Task Sequencer to pause, allowing you to attempt to join the target computer to a domain.
No recover If the target computer is not able to join a domain, the task sequence fails, stopping the task sequence.

Restart computer

This task sequence step restarts the target computer. The unique properties and settings for the Restart computer task sequence step type are:

Properties
Name Description
Type Set this read-only type to Restart computer.
Settings
Name Description
None None

Run Command Line

This task sequence step runs the specified commands on the target computer. For more information about this step type, see Run Command Line.

The unique properties and settings for the Run Command Line task sequence step type are:

Properties
Name Description
Type Set this read-only type to Run Command Line.
Settings
Name Description
Command Line The commands to be run when this task sequence step is processed
Start in The starting folder for the application (The path must be a valid path on the target computer.)
Run this step as the following account Allows specification of user credentials that will be used to run the specified command
Account The user credentials that will be used to run the specified command
Load the user’s profile When selected, loads the user profile for the specified account

Run PowerShell Script

This task sequence step runs the specified Windows PowerShell™ script on the target computer. For more information about what script accomplishes this task and which properties are used, see ZTIPowerShell.wsf.

The unique properties and settings for the Run PowerShell Script task sequence step type are:

Properties
Name Description
Type Set this read-only type to Run PowerShell Script.
Settings
Name Description
PowerShell script The Windows PowerShell script to be run when this task sequence step is processed
Parameters The parameters to be passed to the Windows PowerShell script. These parameters should be specified the same as if you were adding them to the Windows PowerShell script from a command line.

The parameters provided should be only those parameters the script consumes, not for the Windows PowerShell command line.

The following example would be a valid value for this setting:

-MyParameter1 MyValue1 -MyParameter2 MyValue2

The following example would be an invalid value for this setting (bold items are incorrect):

-nologo -executionpolicy unrestricted -File MyScript.ps1 -MyParameter1 MyValue1 -MyParameter2 MyValue2

The previous example is invalid, because the value includes Windows PowerShell command-line parameters (-nologo and –executionpolicy unrestricted).

Note

This task sequence step is natively available in System Center 2012 R2 Configuration Manager as Run PowerShell Script in the General group.

Set Task Sequence Variable

This task sequence step sets the specified task sequence variable to the specified value. For more information about this step type, see Set Task Sequence Variable.

The unique properties and settings for the Set Task Sequence Variable task sequence step type are:

Properties
Name Description
Type Set this read-only type to Set Task Sequence Variable.
Settings
Name Description
Task Sequence Variable The name of the variable to modify
Value The value to assign to the specified variable

Uninstall Roles and Features

This task sequence step uninstalls the selected roles and features from the target computer. For more information about which script accomplishes this task and the properties used, see ZTIOSRole.wsf.

The unique properties and settings for the Uninstall Roles and Features task sequence step type are:

Properties
Name Description
Type Set this read-only type to Uninstall Roles and Features.
Description Informative text that describes the purpose of the task sequence step.
Settings
Name Description
Select the operating system for which the roles are to be installed Select the operating system to be deployed to the target computer.
Select the roles and features that should be installed Select one or more roles and features for unstallation from the target computer.

Validate

This task sequence step verifies that the target computer meets the specified deployment prerequisite conditions. The unique properties and settings for the Validate task sequence step type are:

Properties
Name Description
Type Set this read-only type to Validate.
Settings
Name Description
Ensure minimum memory When selected, this step verifies that the amount of memory, in megabytes, installed on the target computer meets or exceeds the amount specified. This is a default selection.
Ensure minimum processor speed When selected, this step verifies that the speed of the processor, in megahertz (MHz), installed in the target computer meets or exceeds the amount specified. This is a default selection.
Ensure specified image size will fit When selected, this step verifies that the amount of free disk space, in megabytes, on the target computer meets or exceeds the amount specified.
Ensure current operating system to be refreshed When selected, this step verifies that the operating system installed on the target computer meets the requirement specified. This is a default selection.

Note

This task sequence step is natively available in System Center 2012 R2 Configuration Manager as Check Readiness in the General group.

Out-of-Box Task Sequence Steps

The following task sequence steps are referenced by one or more of the available task sequence templates included with MDT. Each of the following examples lists the preconfigured properties, parameters, and options and can be used as a basis for building custom task sequences.

Only the task sequence step properties, parameters, and options, and their corresponding values are listed in the examples.

Note

For more information about each task sequence step, see the corresponding topics in Common Properties and Options for Task Sequence Step Types and Specific Properties and Settings for Task Sequence Step Types.

Apply Network Settings

This task sequence step configures the network adapter on the target computer. Following is a brief listing of the settings that show how this step was originally configured in one of the MDT task sequence templates. For more information about which script accomplishes this task and which properties are used, see ZTINICConfig.wsf.

The default configuration of the Apply Network Settings task sequence step is:

Properties
Name Value
Type Apply Network Settings
Name Apply Network Settings
Description Not specified
Settings
Name Value
No parameters are preconfigured for this step. This causes this step, by default, to configure the network adapter to use DHCP.
Options
Name Value
Disable this step Not selected
Success codes 0 3010
Continue on error Not selected
Conditional qualifier Not specified

Note

When using the CustomSettings.ini file to specify the network adapter configurations, only the first network adapter will be configured. Edit ZTIGather.xml to configure additional network adapters.

Apply Patches

This task sequence step installs updates to the image on the target computer after the operating system has been deployed but before the target computer has been restarted. Following is a brief listing of the settings that show how this step was originally configured in one of the MDT task sequence templates. For more information about which script accomplishes this task and which properties you use, see ZTIPatches.wsf.

The default configuration of the Install Updates Offline task sequence step is:

Properties
Name Value
Type Install Updates Offline
Name Apply Patches
Description Not specified
Settings
Name Value
Selection profile The name of the profile used when selecting the patches to install on the target computer
Options
Name Value
Disable this step Not selected
Success codes 0 3010
Continue on error Not selected
Conditional qualifier Not specified

Apply Windows PE

This task sequence step prepares the target computer to start in Windows Preinstallation Environment (Windows PE). Following is a brief listing of the settings that show how this step was originally configured in one of the MDT task sequence templates. For more information about which script accomplishes this task and which properties you use, see LTIApply.wsf.

The default configuration of the Apply Windows PE task sequence step is:

Properties
Name Value
Type Run Command Line
Name Apply Windows PE
Description Not specified
Settings
Name Value
Command line cscript.exe "%SCRIPTROOT%\LTIApply.wsf" /PE
Start in Not specified
Run this step as the following account Not specified
Options
Name Value
Disable this step Not selected
Success codes 0 3010
Continue on error Not selected
Conditional qualifier Not specified

Backup

This task sequence step backs up the target computer before starting the operating system deployment. Following is a brief listing of the settings that show how this step was originally configured in one of the MDT task sequence templates. For more information about which script accomplishes this task and which properties you use, see ZTIBackup.wsf.

The default configuration of the Backup task sequence step is:

Properties
Name Value
Type Run Command Line
Name Backup
Description Not specified
Settings
Name Value
Command line cscript.exe "%SCRIPTROOT%\ZTIBackup.wsf"
Start in Not specified
Run this step as the following account Not specified
Options
Name Value
Disable this step Not selected
Success codes 0 3010
Continue on error Not selected
Conditional qualifier Not specified

Capture Groups

This task sequence step captures group membership of local groups that exist on the target computer. Following is a brief listing of the settings that show how this step was originally configured in one of the MDT task sequence templates. For more information about which script accomplishes this task and which properties you use, see ZTIGroups.wsf.

The default configuration of the Capture Groups task sequence step is:

Properties
Name Value
Type Run Command Line
Name Capture Groups
Description Not specified
Settings
Name Value
Command line cscript.exe "%SCRIPTROOT%\ZTIGroups.wsf" /capture
Start in Not specified.
Run this step as the following account Not specified
Options
Name Value
Disable this step Not selected
Success codes 0 3010
Continue on error Not selected
Conditional qualifier Not specified

Capture User State

This task sequence step captures the user state for user profiles that exist on the target computer. Following is a brief listing of the settings that show how this step was originally configured in one of the MDT task sequence templates. For more information about what script accomplishes this task and what properties are used, see ZTIUserState.wsf. For more information about this step type, see Capture User State.

The default configuration of the Capture User State task sequence step is:

Properties
Name Value
Type Run Command Line
Name Capture User State
Description Not specified
Settings
Name Value
Command line cscript.exe "%SCRIPTROOT%\ZTIUserState.wsf" /capture
Start in Not specified
Run this step as the following account Not specified
Options
Name Value
Disable this step Not selected
Success codes 0 3010
Continue on error Not selected
Conditional qualifier Not specified

Check BIOS

This task sequence step checks the basic input/output system (BIOS) of the target computer to ensure that it is compatible with the operating system you are deploying. Following is a brief listing of the settings that show how this step was originally configured in one of the MDT task sequence templates. For more information about which script accomplishes this task and which properties are used, see ZTIBIOSCheck.wsf.

The default configuration of the Check BIOS task sequence step is:

Properties
Name Value
Type Run Command Line
Name Check BIOS
Description Not specified
Settings
Name Value
Command line cscript.exe "%SCRIPTROOT%\ZTIBIOSCheck.wsf"
Start in Not specified
Run this step as the following account Not specified
Options
Name Value
Disable this step Not selected
Success codes 0 3010
Continue on error Not selected
Conditional qualifier Not specified

Configure

This task sequence step configures the Unattend.xml file with the required property values that are applicable to the operating system you are deploying to the target computer. Following is a brief listing of the settings that show how this step was originally configured in one of the MDT task sequence templates. For more information about which script accomplishes this task and which properties you use, see ZTIConfigure.wsf.

The default configuration of the Configure task sequence step is:

Properties
Name Value
Type Run Command Line
Name Configure
Description Not specified
Settings
Name Value
Command line cscript.exe "%SCRIPTROOT%\ZTIConfigure.wsf"
Start in Not specified
Run this step as the following account Not specified
Options
Name Value
Disable this step Not selected
Success codes 0 3010
Continue on error Not selected
Conditional qualifier Not specified

Copy Scripts

This task sequence step copies the deployment scripts used during the deployment processes to a local hard disk on the target computer. Following is a brief listing of the settings that show how this step was originally configured in one of the MDT task sequence templates. For more information about which script accomplishes this task and which properties you use, see LTICopyScripts.wsf.

The default configuration of the Copy Scripts task sequence step is:

Properties
Name Value
Type Run Command Line
Name Copy Scripts
Description Not specified
Settings
Name Value
Command line cscript.exe "%SCRIPTROOT%\LTICopyScripts.wsf"
Start in Not specified
Run this step as the following account Not specified
Options
Name Value
Disable this step Not selected
Success codes 0 3010
Continue on error Not selected
Conditional qualifier Not specified

Copy Sysprep Files

This task sequence step copies the Sysprep files to the target computer. Following is a brief listing of the settings that show how this step was originally configured in one of the MDT task sequence templates. For more information about which script accomplishes this task and which properties you use, see LTISysprep.wsf.

The default configuration of the Copy Sysprep Files task sequence step is:

Properties
Name Value
Type Run Command Line
Name Copy Sysprep Files
Description Not specified
Settings
Name Value
Command line cscript.exe "%SCRIPTROOT%\LTISysprep.wsf"
Start in Not specified
Run this step as the following account Not specified
Options
Name Value
Disable this step Not selected
Success codes 0 3010
Continue on error Not selected
Conditional qualifier Not specified

Create BitLocker Partition

This task sequence step sets the BDEInstall property to True, indicating that BitLocker should be installed on the target computer. The unique properties and settings for the Create BitLocker Partition task sequence step type are:

Properties
Name Value
Type Set Task Sequence Variable
Name Create BitLocker Partition
Description None
Settings
Name Value
Task Sequence Variable BDE Install
Value True
Options
Name Value
Disable this step Not selected
Success codes 0 3010
Continue on error Not selected
Conditional qualifier Not specified

Create WIM

This task sequence step creates a backup of the target computer. The unique properties and settings for the Create WIM task sequence step type are:

Properties
Name Value
Type Run Command Line
Name Create WIM
Description None
Settings
Name Value
Command line cscript.exe "%SCRIPTROOT%\ZTIBackup.wsf"
Start in Not specified
Run this step as the following account Not specified
Options
Name Value
Disable this step Not selected
Success codes 0 3010
Continue on error Not selected
Conditional qualifier Not specified

Disable BDE Protectors

If BitLocker is installed on the target computer, this task sequence step disables the BitLocker protectors.

The unique properties and settings for the Disable BDE Protectors task sequence step type are:

Properties
Name Value
Type Run Command Line
Name Disable BDE Protectors
Description None
Settings
Name Value
Command line cscript.exe "%SCRIPTROOT%\ZTIDisableBDEProtectors.wsf"
Start in Not specified
Run this step as the following account Not specified
Options
Name Value
Disable this step Not selected
Success codes 0 3010
Continue on error Not selected
Conditional qualifier Not specified

Enable BitLocker

This task sequence step enables BitLocker on the target computer. Following is a brief listing of the settings that show how this step was originally configured in one of the MDT task sequence templates. For more information about which script accomplishes this task and what properties are used, see ZTIBde.wsf.

The default configuration of the Enable BitLocker task sequence step is:

Properties
Name Value
Type Enable BitLocker
Name Enable BitLocker
Description None
Settings
Name Value
Current operating system drive Selected
TPM only Selected
Startup key on USB only Not selected
TPM and startup key on USB Not selected
Specific drive Not selected
In Active Directory Selected
Do not create a recovery key Not selected
Wait for BitLocker to complete Not selected
Options
Name Value
Disable this step Not selected
Success codes 0 3010
Continue on error Not selected
Conditional qualifier BdeInstallSuppress does not equal YES

Enable OEM Disk Configuration

This task sequence step sets the DeploymentTypeproperty to NEWCOMPUTER, which allows the target computer’s disk to be partitioned and formatted.

The unique properties and settings for the Enable OEM Disk Configuration task sequence step type are:

Properties
Name Value
Type Set Task Sequence Variable
Name Enable OEM Disk Configuration
Description None
Settings
Name Value
Task Sequence Variable DeploymentType
Value NEWCOMPUTER
Options
Name Value
Disable this step Not selected
Success codes 0 3010
Continue on error Not selected
Conditional qualifier Not specified

End Phase

This task sequence step ends the current deployment phase and restarts the target computer. Following is a brief listing of the settings that show how this step was originally configured in one of the MDT task sequence templates.

The default configuration of the End Phase task sequence step is:

Properties
Name Value
Type Restart computer
Name End Phase
Description Not specified
Settings
Name Value
None None
Options
Name Value
Disable this step Not selected
Success codes 0 3010
Continue on error Not selected
Conditional qualifier Not specified

Execute Sysprep

This task sequence step starts Sysprep on the target computer. Following is a brief listing of the settings that show how this step was originally configured in one of the MDT task sequence templates. For more information about what script accomplishes this task and what properties are used, see LTISysprep.wsf.

The default configuration of the Execute Sysprep task sequence step is:

Properties
Name Value
Type Run Command Line
Name Execute Sysprep
Description None
Settings
Name Value
Command line cscript.exe "%SCRIPTROOT%\LTISysprep.wsf"
Start in Not specified
Run this step as the following account Not specified
Options
Name Value
Disable this step Not selected
Success codes 0 3010
Continue on error Not selected
Conditional qualifier Not specified

Force Diskpart Action

If the C:\oem.wsf file exists, this task sequence step deletes the C:\oem.wsf file, which will allow the Format and Partition Disk task sequence step to run. Following is a brief listing of the settings that show how this step was originally configured in one of the MDT task sequence templates.

The default configuration of the Force Diskpart Action task sequence step is:

Properties
Name Value
Type Run Command Line
Name Force Diskpart Action
Description Not specified
Settings
Name Value
Command line cmd.exe /c if exist c:\oem.wsf del /q c:\oem.wsf
Start in Not specified
Run this step as the following account Not specified
Options
Name Value
Disable this step Not selected
Success codes 0.1
Continue on error Selected
Conditional qualifier None

Format and Partition Disk

This task sequence step configures and formats disk partitions on the target computer. Following is a brief listing of the settings that show how this step was originally configured in one of the MDT task sequence templates.

For more information about what script accomplishes this task and what properties are used, see ZTIDiskpart.wsf.

The default configuration of the Format and Partition Disk task sequence step is:

Properties
Name Value
Type Format and Partition Disk
Name Format and Partition Disk
Description Not specified
Settings
Name Value
Disk number 0
Disk type Standard (MBR)
Volume Within the Volume setting, the following sub-settings are configured:

- Partition Name. OSDisk

- Partition Type. Primary

- Use a percentage of remaining space. Selected

- Size(%). 100

- Use specific drive size. Not selected

- Make this a boot partition. Selected

- File System. NTFS

- Quick Format. Selected

- Variable. Not specified
Options
Name Value
Disable this step Not selected
Success codes 0 3010
Continue on error Not selected
Conditional qualifier Not specified

Note

When using the CustomSettings.ini file to specify the hard disk and partition configurations, only the first hard disk and first two partitions will be configured. Edit ZTIGather.xml to configure additional hard disks or partitions.

Gather local only

This task sequence step gathers deployment configurations settings from local sources that apply to the target computer. Following is a brief listing of the settings that show how this step was originally configured in one of the MDT task sequence templates.

For more information about what script accomplishes this task and what properties are used, see ZTIGather.wsf.

The default configuration of the Gather local only task sequence step is:

Properties
Name Value
Type Gather
Name Gather local only
Description Not specified
Settings
Name Value
Gather only local data Selected
Gather local data and process rules Not selected
Rules file Not specified
Options
Name Value
Disable this step Not selected
Success codes 0 3010
Continue on error Not selected
Conditional qualifier None

Generate Application Migration File

This task sequence step generates the ZTIAppXmlGen.xml file, which contains a list of file associations that are installed on the target computer. Following is a brief listing of the settings that show how this step was originally configured in one of the MDT task sequence templates.

For more information about what script accomplishes this task and what properties are used, see ZTIAppXmlGen.wsf.

The default configuration of the Generate Application Migration File task sequence step is:

Properties
Name Value
Type Run Command Line
Name Generate Application Migration File
Description Not specified
Settings
Name Value
Command Line cscript.exe "%SCRIPTROOT%\ZTIAppXmlGen.wsf" /capture
Start in Not specified
Run this step as the following account Not specified
Options
Name Value
Disable this step Not selected
Success codes 0 3010
Continue on error Not selected
Conditional qualifier None

Inject Drivers

This task sequence step injects drivers that have been configured for deployment to the target computer. Following is a brief listing of the settings that show how this step was originally configured in one of the MDT task sequence templates.

For more information about what script accomplishes this task and what properties are used, see ZTIDrivers.wsf.

The default configuration of the Inject Drivers task sequence step is:

Properties
Name Value
Type Inject Drivers
Name Inject Drivers
Description Not specified
Settings
Name Value
Install only matching drivers Injects only the drivers which are required by the target computer and match with what is available in Out-of-Box Drivers
Install all drivers Injects all drivers
Selection profile Injects drivers which are associated with the selected profile
Options
Name Value
Disable this step Not selected
Success codes 0 3010
Continue on error Not selected
Conditional qualifier Not specified

Install Applications

This task sequence step installs applications on the target computer. Following is a brief listing of the settings that show how this step was originally configured in one of the MDT task sequence templates.

For more information about what script accomplishes this task and what properties are used, see ZTIApplications.wsf.

The default configuration of the Install Applications task sequence step is:

Properties
Name Value
Type Install Applications
Name Install Applications
Description Not specified
Settings
Name Value
Install multiple applications Selected
Install a single application Not selected
Options
Name Value
Disable this step Not selected
Success codes 0 3010
Continue on error Not selected
Conditional qualifier Not specified

Install Operating System

This task sequence step installs an operating system on the target computer. Following is a brief listing of the settings that show how this step was originally configured in one of the MDT task sequence templates.

The default configuration of the Install Operating System task sequence step is:

Properties
Name Value
Type Install Operating System
Name Install Operating System
Description Not specified
Settings
Name Value
Operating system to install This value corresponds to the operating system that was selected when the task sequence was created.
Disk The disk where the operating system is to be installed.
Partition The partition where the operating system is to be installed.
Options
Name Value
Disable this step Not selected
Success codes 0 3010
Continue on error Not selected
Conditional qualifier Not specified

Next Phase

This task sequence step updates the Phase property to the next phase in the deployment process. Following is a brief listing of the settings that show how this step was originally configured in one of the MDT task sequence templates.

For more information about what script accomplishes this task and what properties are used, see ZTINextPhase.wsf.

The default configuration of the Next Phase task sequence step is:

Properties
Name Value
Type Run Command Line
Name Next Phase
Description Not specified
Settings
Name Value
Command line cscript.exe "%SCRIPTROOT%\ZTINextPhase.wsf"
Start in Not specified
Run this step as the following account Not specified
Options
Name Value
Disable this step Not selected
Success codes 0 3010
Continue on error Not selected
Conditional qualifier Not specified

Post-Apply Cleanup

This task sequence step cleans up unnecessary files after the installation of an image on the target computer. Following is a brief listing of the settings that show how this step was originally configured in one of the MDT task sequence templates.

For more information about what script accomplishes this task and what properties are used, see LTIApply.wsf.

The default configuration of the Post-Apply Cleanup task sequence step is:

Properties
Name Value
Type Run Command Line
Name Post-Apply Cleanup
Description Not specified
Settings
Name Value
Command line cscript.exe "%SCRIPTROOT%\LTIApply.wsf" /post
Start in Not specified
Run this step as the following account Not specified
Options
Name Value
Disable this step Not selected
Success codes 0 3010
Continue on error Not selected
Conditional qualifier Not specified

Recover from Domain

This task sequence step will verify the target computer has joined a domain. For more information about which script accomplishes this task and which properties are used, see ZTIDomainJoin.wsf.

The unique properties and settings for the Recover from Domain task sequence step type are:

Properties
Name Description
Type This read-only type is set to Recover from Domain Join Failure.
Settings
Name Description
Auto recover The task sequence step will attempt to join the target computer to a domain.
Manual recover If the target computer fails to join a domain, the task sequence step will cause the task sequencer to pause, allowing the user attempts to join the target computer to a domain.
No recover If the target computer is not able to join a domain, the task sequence fails, stopping the task sequence.

Restart computer

This task sequence step restarts the target computer. Following is a brief listing of the settings that show how this step was originally configured in one of the MDT task sequence templates.

The default configuration of the Restart computer task sequence step is:

Properties
Name Value
Type Restart computer
Name Restart computer
Description Not specified
Settings
Name Value
None None
Options
Name Value
Disable this step Not selected
Success codes 0 3010
Continue on error Not selected
Conditional qualifier Not specified

Restore Groups

This task sequence step restores the previously captured group membership of local groups on the target computer. Following is a brief listing of the settings that show how this step was originally configured in one of the MDT task sequence templates.

For more information about what script accomplishes this task and what properties are used, see ZTIGroups.wsf.

The default configuration of the Restore Groups task sequence step is:

Properties
Name Value
Type Run Command Line
Name Restore Groups
Description Not specified
Settings
Name Value
Command line cscript.exe "%SCRIPTROOT%\ZTIGroups.wsf" /restore
Start in Not specified
Run this step as the following account Not specified
Options
Name Value
Disable this step Not selected
Success codes 0 3010
Continue on error Not selected
Conditional qualifier If all conditions are true:

- DoCapture does not equal YES

- DoCapture does not equal PREPARE

Restore User State

This task sequence step restores previously captured user state to the target computer. Following is a brief listing of the settings that show how this step was originally configured in one of the MDT task sequence templates.

For more information about what script accomplishes this task and what properties are used, see ZTIUserState.wsf.

For more information about this step type, see Restore User State.

The default configuration of the Restore User State task sequence step is:

Properties
Name Value
Type Run Command Line
Name Restore User State
Description Not specified
Settings
Name Value
Command Line cscript.exe "%SCRIPTROOT%\ZTIUserState.wsf" /restore
Start in Not specified
Run this step as the following account Not specified
Options
Name Value
Disable this step Not selected
Success codes 0 3010
Continue on error Not selected
Conditional qualifier If all conditions are true:

- If DoCapture does not equal YES

- If DoCapture does not equal PREPARE

Set Image Build

This task sequence step sets the ImageBuild property to the value contained in OSCurrentVersion. Following is a brief listing of the settings that show how this step was originally configured in one of the MDT task sequence templates.

The default configuration of the Set Image Build task sequence step is:

Properties
Name Value
Type Set Task Sequence Variable
Name Set Image Build
Description Not specified
Settings
Name Value
Task Sequence Variable ImageBuild
Value %OSCurrentVersion%
Options
Name Value
Disable this step Not selected
Success codes 0 3010
Continue on error Not selected
Conditional qualifier Not specified

Set Image Flags

This task sequence step sets the ImageFlags property to the value contained in OSSKU. Following is a brief listing of the settings that show how this step was originally configured in one of the MDT task sequence templates.

The default configuration of the Set Image Flags task sequence step is:

Properties
Name Value
Type Set Task Sequence Variable
Name Set Image Flags
Description Not specified
Settings
Name Value
Task Sequence Variable ImageFlags
Value %OSSKU%
Options
Name Value
Disable this step Not selected
Success codes 0 3010
Continue on error Not selected
Conditional qualifier Not specified

Tattoo

This task sequence step tattoos the target computer with identification and version information. Following is a brief listing of the settings that show how this step was originally configured in one of the MDT task sequence templates.

For more information about what script accomplishes this task and what properties are used, see ZTITatoo.wsf.

The default configuration of the Tattoo task sequence step is:

Properties
Name Value
Type Run Command Line
Name Tattoo
Description Not specified
Settings
Name Value
Command line cscript.exe "%SCRIPTROOT%\ZTITatoo.wsf"
Start in Not specified
Run this step as the following account Not specified
Options
Name Value
Disable this step Not selected
Success codes 0 3010
Continue on error Not selected
Conditional qualifier Not specified

Validate

This task sequence step validates that the target computer meets the specified deployment prerequisite conditions. Following is a brief listing of the settings that show how this step was originally configured in one of the MDT task sequence templates.

For more information about what script accomplishes this task and what properties are used, see ZTIValidate.wsf.

The default configuration of the Validate task sequence step is:

Properties
Name Value
Type Validate
Name Validate
Description Not specified
Settings
Name Value
Ensure minimum memory (MB) Selected. The value selector is set to 768.
Ensure minimum processor speed (MHz) Selected. The value selector is set to 800.
Ensure specified image size will fit (MB) Not selected.
Ensure current operating system to be refreshed Selected. The value selector is set to Server or Client, depending on the template used to create the task sequence.
Options
Name Value
Disable this step Not selected
Success codes 0 3010
Continue on error Not selected
Conditional qualifier Not specified

Windows Update (Pre-Application Installation)

This task sequence step installs updates to the target computer prior to the installation of applications. Following is a brief listing of the settings that show how this step was originally configured in one of the MDT task sequence templates.

For more information about what script accomplishes this task and what properties are used, see ZTIWindowsUpdate.wsf.

The default configuration of the Windows Update (Pre-Application Installation) task sequence step is:

Properties
Name Value
Type Run Command Line
Name Windows Update (Pre-Application Installation)
Description Not specified
Settings
Name Value
Command line cscript.exe "%SCRIPTROOT%\ZTIWindowsUpdate.wsf"
Start in Not specified
Run this step as the following account Not specified
Options
Name Value
Disable this step Not selected
Success codes 0 3010
Continue on error Not selected
Conditional qualifier Not specified

Windows Update (Post-Application Installation)

This task sequence step is the same as the Windows Update (Pre-Application Installation) task sequence step.

Wipe Disk

This task sequence step wipes all information from the disk using the Format command.

For more information about what script accomplishes this task and what properties are used, see ZTIWipeDisk.wsf.

The default configuration of the Wipe Disk task sequence step is:

Properties
Name Value
Type Run Command Line
Name Wipe Disk
Description This will only run if WipeDisk=TRUE in CustomSettings.ini
Settings
Name Value
Command line cscript.exe "%SCRIPTROOT%\ZTIWipeDisk.wsf"
Start in Not specified
Run this step as the following account Not specified
Options
Name Value
Disable this step Not selected
Success codes 0 3010
Continue on error Not selected
Conditional qualifier Not specified

Properties

The scripts used in Lite Touch Installation (LTI) and ZTI reference properties to determine the process steps and configuration settings used during the deployment process. The scripts create some of these properties automatically. Other properties must be configured in the CustomSettings.ini file. Some of these properties are:

  • Specific to ZTI only

  • Specific to LTI only

  • For use in both ZTI and LTI

    Use this reference to help determine the correct properties to configure and the valid values to include for each property.

    For each property the following information is provided:

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

    Note

    Unless explicitly specified for ZTI or LTI only, a property is valid for both ZTI and LTI.

  • Value and Description.Indicates the valid values to be specified for the property and a brief description of what each value means. (Values in italics indicate that a value is substituted—for example the value user1, user2 indicates that user1 and user2 would be replaced with the actual name of user accounts.)

  • Example.Provides an example of a property use as it might appear in the .ini files.

    For more information about these and other task sequence properties that might be referenced while performing a ZTI deployment, see Operating System Deployment Task Sequence Variables.

    The deployment scripts generally require values to be specified in upper case so that they are properly read. Therefore, when specifying property values, use uppercase letters.

Property Definition

The following sections describe the properties that are available for LTI and ZTI deployments in MDT.

Tip

The properties are sorted in alphabetical order.

_SMSTSOrgName

Customizes the Task Sequencer engine's display banner

Property configured by Property applies to
BootStrap.ini - LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
name The name that will be used in the Task Sequencer engine’s display banner
Example
[Settings] Priority=Default [Default] _SMSTSOrgName=Woodgrove Bank

ADDSLogPath

Fully qualified, non-UNC directory on a hard disk on the local computer to host the AD DS log files. If the directory exists it must be empty. If it does not exist, it will be created.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
log_path Fully qualified, non-UNC directory on a hard disk on the local computer to host the AD DS log files
Example
[Settings] Priority=Default [Default] ADDSLogPath=%DestinationLogicalDrive%\Windows\NTDS

ADDSPassword

Account credentials that can be used when promoting the server to a domain controller.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
password Account credentials that can be used for the promotion operation
Example
[Settings] Priority=Default [Default] ADDSUserName=Administrator ADDSUserDomain=WoodGroveBank ADDSPassword=<complex_password>

ADDSUserDomain

This is the domain the account specified by ADDSUserName should be taken from. If the operation is to create a new forest or to become a member server from a backup domain controller upgrade there is no default. If the operation is to create a new tree, the default is the DNS name of the forest the computer is currently joined to. If the operation is to create a new child domain or a replica then the default is the DNS name of the domain the computer is joined to. If the operation is to demote the computer and the computer is a domain controller in a child domain, the default is the DNS name of the parent domains. If the operation is to demote the computer, and the computer is a domain controller of a tree root domain, the default is the DNS name of the forest.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
domain Domain the UserName account should be taken from
Example
[Settings] Priority=Default [Default] ADDSUserName=Administrator ADDSUserDomain=WoodGroveBank ADDSPassword=<complex_password>

ADDSUserName

Account credentials that will be used when promoting the server to a domain controller.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
user_name Account credentials that will be used for the promotion operation
Example
[Settings] Priority=Default [Default] ADDSUserName=Administrator ADDSUserDomain=WoodGroveBank ADDSPassword=complex_password

Administrators

A list of user accounts and domain groups that will be added to the local Administrator group on the target computer. The Administrators property is a list of text values that can be any non-blank value. The Administrators property has a numeric suffix (for example, Administrators001 or Administrators002).

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
name The name of a user or group that is to be added to the local Administrator group
Example
[Settings] Priority=Default [Default] Administrators001=WOODGROVEBANK\NYC Help Desk Staff Administrators002=WOODGROVEBANK\North America East Help Desk Staff PowerUsers001=WOODGROVEBANK\User01 PowerUsers002=WOODGROVEBANK\User02

AdminPassword

Defines the password that will be assigned to the local Administrator user account on the target computer. If not specified, the pre-deployment password of the Administrator user account will be used.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
admin_password The password that is to be assigned to the Administrator user account on the target computer
Example
[Settings] Priority=Default [Default] Administrators001=WOODGROVEBANK\NYC Help Desk Staff AdminPassword=<admin_password>

Applications

A list of application GUIDs that should be installed on the target computer. These applications are specified on the Applications node in Deployment Workbench. These GUIDs are stored in the Applications.xml file. The Applications property is a list of text values that can be any non-blank value. The Applications property has a numeric suffix (for example, Applications001 or Applications002).

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
application_guid The GUID is specified by Deployment Workbench for the application to be deployed to the target computer. The GUID corresponds to the application GUID stored in the Applications.xml file.
Example
[Settings] Priority=Default [Default] Applications001={1D7DF331-47B7-472C-87B3-442597EC2F7D} Applications002={9d2b8999-5e4d-4f3d-bb05-edaaf4fe5628}

ApplicationSuccessCodes

A space-delimited list of error codes used by the ZTIApplications script that determine the successful installation of applications.

Note

This property is only applicable to the Install Application task sequence step type and when Install multiple applications is selected.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
error_codes The error codes that determine when applications have been successfully installed. Default values are 0 and 3010.
Example
[Settings] Priority=Default [Default] ApplicationSuccessCodes=0 3010

ApplyGPOPack

This property is used to determine whether the Apply Local GPO Package task sequence step is performed.

Note

The default value for this property always performs the Apply Local GPO Package task sequence step. You must explicitly provide a value of "NO" to override this behavior..

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
YES The Apply Local GPO Package task sequence step is performed. This is the default value.
NO The Apply Local GPO Package task sequence step is not performed.
Example
[Settings] Priority=Default [Default] ApplyGPOPack=NO

Architecture

The processor architecture of the processor that is currently running, which is not necessarily the processor architecture supported by the target computer. For example, when running a 32-bit–compatible operating system on a 64-bit processor, Architecture will indicate that the processor architecture is 32 bit.

Use the CapableArchitecture property to identify the actual processor architecture that the target computer supports.

Note

This property is dynamically set by MDT scripts and is not configured in CustomSettings.ini. Treat this property as read only. However, you can use this property within CustomSettings.ini, as shown in the following examples, to aid in defining the configuration of the target computer.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini
MDT DB ZTI -
Value Description
x86 Processor architecture is 32 bit.
x64 Processor architecture is 64 bit.
Example
None

AreaCode

The area code to be configured for the operating system on the target computer. This property allows only numeric characters. This value is inserted into the appropriate configuration settings in Unattend.xml.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
area_code The area code where the target computer is to be deployed
Example
[Settings] Priority=Default [Default] AreaCode=206 CountryCode=001 Dialing=TONE LongDistanceAccess=9

AssetTag

The asset tag number associated with the target computer. The format for asset tag numbers is undefined. Use this property to create a subsection that contains settings targeted to a specific computer.

Note

This property is dynamically set by MDT scripts and cannot have its value set in CustomSettings.ini or the MDT DB. Treat this property as read only. However, you can use this property within CustomSettings.ini or the MDT DB, as shown in the following examples, to aid in defining the configuration of the target computer.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini
MDT DB ZTI -
Value Description
asset_tag The format of the asset tag is undefined and is determined by the asset tag standard of each organization.
Example 1
[Settings] Priority=Default [Default] OSDComputerName=HP-%AssetTag%
Example 2
[Settings] Priority=AssetTag, Default [Default] OSInstall=YES [0034034931] OSDComputerName=HPD530-1 [0034003233] OSDNEWMACHINENAME=BVMXP

AutoConfigDNS

Specifies whether the Active Directory Installation Wizard configures DNS for the new domain if it detects that the DNS dynamic update protocol is not available.

Caution

This property value must be specified in uppercase so that the deployment scripts can properly read it.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
YES Configures DNS for the new domain if the DNS dynamic update protocol is not available
NO Does not configure DNS for the domain
Example
[Settings] Priority=Default [Default] AutoConfigDNS=YES

BackupDir

The folder in which backups of the target computer are stored. This folder exists beneath the UNC path specified in the BackupShare property. If the folder does not already exist, it will be created automatically.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
Folder The name of the folder that exists beneath the shared folder specified in the BackupShare property
Example
[Settings] Priority=Default [Default] DoCapture=YES BackupShare=\\NYC-AM-FIL-01\Backup$ BackupDir=%OSDComputerName% BackupDrive=C:

BackupDrive

The drive to include in the backup of the target computer. This property defaults to the drive that contains disk 0 partition 1. It can be also set to ALL.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
backup_drive The drive letter of the drive to back up
ALL Back up all drives on the target computer
Example
[Settings] Priority=Default [Default] DoCapture=YES BackupShare=\\NYC-AM-FIL-01\Backup$ BackupDir=%OSDComputerName% BackupDrive=C:

BackupFile

Specifies the WIM file that will be used by the ZTIBackup.wsf script. For more information about what script uses this property, see ZTIBackup.wsf.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
BackupDir The name of the Windows Imaging Format (WIM) file to be used during back up.
Example
[Settings] Priority=Default [Default] DoCapture=YES BackupShare=\\NYC-AM-FIL-01\Backup$ BackupDir=%OSDComputerName% BackupFile=%OSDComputerName%.wim

BackupShare

The shared folder in which backups of the target computer are stored.

The credentials used to access this shared folder for:

  • LTI are the credentials entered in the Deployment Wizard.

  • ZTI are the credentials used by the Configuration Manager Advanced Client Network Access account.

    The permissions required on this share are as follows:

  • Domain Computers. Allow the Create Folders/Append Data permission.

  • Domain Users. Allow the Create Folders/Append Data permission.

  • Creator Owner. Allow the Full Control permission.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
UNC_path The UNC path of the shared folder

Note:

The UNC path specified in this property must exist before deploying the target operating system.
Example
[Settings] Priority=Default [Default] DoCapture=YES BackupShare=\\NYC-AM-FIL-01\Backup$ BackupDir=%OSDComputerName% BackupDrive=C:

BDEAllowAlphaNumericPin

This property configures whether BitLocker PINs contain alphanumeric values.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
YES Alphanumeric characters are allowed in the PIN.

Note:

In addition to setting this property to YES, the Allow enhanced PINs for startup group policy setting must be enabled.
NO Only numeric characters are allowed in the PIN.
Example
[Settings] Priority=Default [Default] BDEInstallSuppress=NO BDEAllowAlphaNumericPin=YES BDEDriveLetter=S: BDEDriveSize=2000 BDEInstall=TPMKey BDERecoveryKey=AD BDEKeyLocation=C:

BDEDriveLetter

The drive letter for the partition that is not encrypted by BitLocker, also known as the System Volume. SYSVOL is the directory that contains the hardware-specific files needed to load Windows computers after the BIOS has booted the platform.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
drive_letter The letter designation for the logical drive for the System Volume (such as S or T). The default value is S.
Example
[Settings] Priority=Default [Default] BDEInstallSuppress=NO BDEDriveLetter=S: BDEDriveSize=2000 BDEInstall=TPMKey BDERecoveryKey=AD BDEKeyLocation=C:

BDEDriveSize

The size of the BitLocker system partition. The value is specified in megabytes. In the example, the size of the BitLocker partition to create is almost 2 GB (2,000 MB).

Property configured by Property applies to
Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
drive_size The size of the partition in megabytes; the default sizes are:

- Windows 7 and Windows Server 2008 R2: 300 MB
Example
[Settings] Priority=Default [Default] BDEInstallSuppress=NO BDEDriveLetter=S: BDEDriveSize=2000 BDEInstall=TPMKey BDERecoveryKey=AD BDEKeyLocation=C:

BDEInstall

The type of BitLocker installation to be performed. Protect the target computer using one of the following methods:

  • A TPM microcontroller

  • A TPM and an external startup key (using a key that is typically stored on a USB flash drive [UFD])

  • A TPM and PIN

  • An external startup key

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
TPM Protect the computer with TPM only. The TPM is a microcontroller that stores keys, passwords, and digital certificates. The microcontroller is typically an integral part of the computer motherboard.
TPMKey Protect the computer with TPM and a startup key. Use this option to create a startup key and to save it on a UFD. The startup key must be present in the port each time the computer starts.
TPMPin Protect the computer with TPM and a pin. Use this option in conjunction with the BDEPin property.
Key Protect the computer with an external key (the recovery key) that can be stored in a folder, in AD DS, or printed.
Example
[Settings] Priority=Default [Default] BDEInstallSuppress=NO BDEDriveLetter=S: BDEDriveSize=2000 BDEInstall=TPMKey BDERecoveryKey=AD BDEKeyLocation=C:

BDEInstallSuppress

Indicates whether the deployment process should skip the BitLocker installation.

Caution

This property value must be specified in uppercase so that the deployment scripts can read it properly.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
YES Do not attempt to install BitLocker.
NO Attempt to install BitLocker.
Example
[Settings] Priority=Default [Default] BDEInstallSuppress=YES

BDEKeyLocation

The location for storing the BitLocker recovery key and startup key.

Note

If this property is configured using the Deployment Wizard, the property must be the drive letter of a removable disk. If the SkipBitLocker property is set to TRUE so that the Specify the BitLocker configuration wizard page is skipped, this property can be set to a UNC path in CustomSettings.ini or in the MDT database (MDT DB).

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
Location Specifies where the recovery key will be stored; must be a UNC path or the drive letter of a removable disk. If not set, the first available removable drive will be used.
Example
[Settings] Priority=Default [Default] BDEInstallSuppress=NO BDEDriveLetter=S: BDEDriveSize=2000 BDEInstall=TPMKey BDERecoveryKey=AD BDEKeyLocation=C:

BDEPin

The PIN to be assigned to the target computer when configuring BitLocker and the BDEInstall or OSDBitLockerMode properties are set to TPMPin.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
Pin The PIN to be used for BitLocker. The PIN can be between 4 and 20 digits long.
Example
[Settings] Priority=Default [Default] BDEInstallSuppress=NO BDEDriveLetter=S: BDEDriveSize=2000 BDEInstall=TPMPin BDEPin=123456789

BDERecoveryKey

A Boolean value that indicates whether the process creates a recovery key for BitLocker. The key is used for recovering data encrypted on a BitLocker volume. This key is cryptographically equivalent to a startup key. If available, the recovery key decrypts the volume master key (VMK), which, in turn, decrypts the full volume encryption key (FVEK).

Note

The recovery key is stored in the location specified in the BDEKeyLocation property.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
AD A recovery key is created.
Not specified A recovery key is not created.
Example
[Settings] Priority=Default [Default] BDEInstallSuppress=NO BDEDriveLetter=S: BDEDriveSize=2000 BDEInstall=TPMKey BDERecoveryKey=AD BDEKeyLocation=C:

BDEWaitForEncryption

Specifies that the deployment process should not proceed until BitLocker has completed the encryption process for all specified drives. Specifying TRUE could dramatically increase the time required to complete the deployment process.

Caution

This property value must be specified in uppercase so that the deployment scripts can read it properly.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
TRUE Specifies that the deployment process should wait for drive encryption to complete.
FALSE Specifies that the deployment process should not wait for drive encryption to complete.
Example
[Settings] Priority=Default [Default] BDEInstallSuppress=NO BDEDriveLetter=S: BDEDriveSize=2000 OSDBitLockerMode=TPMKey OSDBitLockerStartupKeyDrive=C: OSDBitLockerCreateRecoveryPassword=AD BDEWaitForEncryption=TRUE

BitsPerPel

A setting for displaying colors on the target computer. The property can contain numeric digits and corresponds to the color quality setting. In the example, 32 indicates 32 bits per pixel for color quality. This value is inserted into the appropriate configuration settings in Unattend.xml.

Note

The default values (in the Unattend.xml template file) are 1,024 pixels horizontal resolution, 768 pixels vertical resolution, 32-bit color depth, and 60 Hertz (Hz) vertical refresh rate.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
bits_per_pixel The number of bits per pixel to use for color. The default value is the default for the operating system being deployed.
Example
[Settings] Priority=Default [Default] BitsPerPel=32 VRefresh=60 XResolution=1024 YResolution=768

BuildID

Identifies the operating system task sequence to be deployed to the target computer. You create the task sequence ID on the Task Sequences node in the Deployment Workbench. The BuildID property allows alphanumeric characters, hyphens (-), and underscores (_). The BuildID property cannot be blank or contain spaces.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
build_id Identifier of the operating system task sequence as defined in the Deployment Workbench for the target operating system being deployed

Note:

Make certain to use the TaskSequenceID specified in the Deployment Workbench user interface (UI) and not the GUID of the TaskSequenceID.
Example
[Settings] Priority=Default [Default] BuildID=BareMetal

CapableArchitecture

The processor architecture of the processor supported by the target computer, not the current processor architecture that is running. For example, when running a 32-bit-compatible operating system on a 64-bit processor, CapableArchitecture will indicate that the processor architecture is 64 bit.

Use the Architecture property to see the processor architecture that is currently running.

Note

This property is dynamically set by the MDT scripts and is not configured in CustomSettings.ini or the MDT DB. Treat this property as read only.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini
MDT DB ZTI -
Value Description
x86 Processor architecture is 32 bit.
x64 Processor architecture is 64 bit.
Example
None

CaptureGroups

Controls whether the group membership of local groups on the target computer is captured. This group membership is captured during the State Capture Phase and is restored during the State Restore Phase.

Note

This property value must be specified in uppercase so that the deployment scripts can read it properly.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
NO Captures no group membership information.
ALL Captures the membership of all local groups on the target computer.
YES Captures the membership of the Administrator and Power Users built-in groups and the groups listed in the groups’ properties. This is the default value if some other value is specified. (YES is the typical value.)
Example
[Settings] Priority=Default [Default] DeployRoot=\\NYC-AM-FIL-01\Distribution$ ResourceRoot=\\NYC-AM-FIL-01\Resource$ UDShare=\\NYC-AM-FIL-01\MigData$ CaptureGroups=YES Groups1=NYC Application Management Groups2=NYC Help Desk Users

ChildName

Specifies whether to append the DNS label at the beginning of the name of an existing directory service domain when installing a child domain.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
name The name of the child domain
Example
[Settings] Priority=Default [Default] ChildName=childdom.parentdom.WoodGroveBank.com

ComputerBackupLocation

The network shared folder where the computer backup is stored. If the target folder does not already exist, it is automatically created.

Caution

This property value must be specified in uppercase so that the deployment scripts can read it properly.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
blank Same as AUTO.
UNC_path The UNC path to the network shared folder where the backup is stored.
AUTO Creates a backup on a local hard disk if space is available. Otherwise, the backup is saved to a network location specified in the BackupShare and BackupDir properties.
NETWORK Creates a backup on a network location specified in BackupShare and BackupDir.
NONE No backup will be performed.
Example
[Settings] Priority=Default [Default] DeployRoot=\\NYC-AM-FIL-01\Distribution$ ResourceRoot=\\NYC-AM-FIL-01\Resource$ UDShare=\\NYC-AM-FIL-01\MigData$ ComputerBackupLocation=NETWORK BackupShare=\\NYC-AM-FIL-01\Backup$ BackupDir=%OSDComputerName% UDDir=%OSDComputerName% SLShare=\\NYC-AM-FIL-01\Logs$ UDProfiles=Administrator, User-01, ExtranetUser UserDataLocation=NONE

ComputerName

This property has been deprecated. Use OSDComputerName instead.

Property configured by Property applies to
BootStrap.ini LTI
CustomSettings.ini
MDT DB ZTI
Value Description
None None
Example
None

ConfigFileName

Specifies the name of the configuration file used during OEM deployments.

Note

This property is dynamically set by the MDT scripts and is not configured in CustomSettings.ini or the MDT DB. Treat this property as read only.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini
MDT DB ZTI -
Value Description
file_name Specifies the name of the configuration file used during OEM deployments
Example
None

ConfigFilePackage

Specifies the package ID for the configuration package used during OEM deployments.

Note

This property is dynamically set by the MDT scripts and is not configured in CustomSettings.ini or the MDT DB. Treat this property as read only.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini
MDT DB ZTI -
Value Description
package Specifies the package ID for the configuration package used during OEM deployments
Example
None

ConfirmGC

Specifies whether the replica is also a global catalog.

Caution

This property value must be specified in uppercase so that the deployment scripts can read it properly.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
YES Makes the replica a global catalog if the backup was a global catalog.
NO Does not make the replica a global catalog.
Example
[Settings] Priority=Default [Default] ConfirmGC=YES

CountryCode

The country code to be configured for the operating system on the target computer. This property allows only numeric characters. This value is inserted into the appropriate configuration settings in Unattend.xml.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
country_code The country code where the target computer is to be deployed
Example
[Settings] Priority=Default [Default] AreaCode=206 CountryCode=001 Dialing=TONE LongDistanceAccess=9

CriticalReplicationOnly

Specifies whether the promotion operation performs only critical replication and then continues, skipping the noncritical (and potentially lengthy) portion of replication.

Caution

This property value must be specified in uppercase so that the deployment scripts can read it properly.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
YES Skips noncritical replication
NO Does not skip noncritical replication
Example
[Settings] Priority=Default [Default] CriticalReplicationOnly=YES

CustomDriverSelectionProfile

Specifies the custom selection profile used during driver installation.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
profile Custom selection profile used during driver installation
Example
[Settings] Priority=Default [Default] CustomDriverSelectionProfile=CustomDrivers

CustomPackageSelectionProfile

Specifies the custom selection profile used during package installation.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
profile Custom selection profile used during package installation
Example
[Settings] Priority=Default [Default] CustomPackageSelectionProfile=CustomPackages

CustomWizardSelectionProfile

Specifies the custom selection profile used by the wizard for filtering the display of various items.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
profile Custom selection profile by the wizard for filtering the display of various items
Example
[Settings] Priority=Default [Default] CustomWizardSelectionProfile=CustomWizard

Database

The property that specifies the database to be used for querying property values from columns in the table specified in the Table property. The database resides on the computer specified in the SQLServer property. The instance of Microsoft SQL Server® on the computer is specified in the Instance property.

Property configured by Property applies to
BootStrap.ini - LTI -
CustomSettings.ini -
MDT DB ZTI -
Value Description
database The name of the database to be used for querying property values
Example
[Settings] Priority=Computers, Default [Default] OSInstall=YES [Computers] SQLServer=NYC-SQL-01 SQLShare=SQL$ Database=MDTDB Instance=SQLEnterprise2005 Table=Computers Parameters=SerialNumber, AssetTag ParameterCondition=OR

DatabasePath

Specifies the fully qualified, non-UNC path to a directory on a fixed disk of the target computer that contains the domain database.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
path Specifies the fully qualified, non-UNC path to a directory on a fixed disk of the local computer that contains the domain database
Example
[Settings] Priority=Default [Default] DatabasePath=%DestinationLogicalDrive%\Windows\NTSD

DBID

Specifies the user account used to connect to the computer running SQL Server (specified by the SQLServer property) using SQL Server authentication. The DBPwd property provides the password for the user account in the DBID property.

Note

SQL Server authentication is not as secure as Integrated Windows authentication. Integrated Windows authentication is the recommended authentication method. Using the DBID and DBPwd properties stores the credentials in clear text in the CustomSettings.ini file and therefore is not secure. For more information about using Integrated Windows authentication, see the SQLShare property.

Note

This property is configurable only by manually editing the CustomSettings.ini and BootStrap.ini files.

Property configured by Property applies to
BootStrap.ini - LTI -
CustomSettings.ini -
MDT DB ZTI -
Value Description
user_id The name of the user account credentials used to access the computer running SQL Server using SQL Server authentication
Example
[Settings] Priority=Computers, Default [Default] OSInstall=YES [Computers] SQLServer=NYC-SQL-01 DBID=SQL_User-01 DBPwd=<complex_password> NetLib=DBNMPNTW Database=MDTDB Instance=SQLEnterprise2005 Table=Computers Parameters=SerialNumber, AssetTag ParameterCondition=OR

DBPwd

Specifies the password for the user account specified in the DBID property. The DBID and DBPwd properties provide the credentials for performing SQL Server authentication to the computer running SQL Server (specified by the SQLServer property).

Note

SQL Server authentication is not as secure as Integrated Windows authentication. Integrated Windows authentication is the recommended authentication method. Using the DBID and DBPwd properties stores the credentials in clear text in the CustomSettings.ini file and therefore is not secure. For more information about using Integrated Windows authentication, see the SQLShare property.

Note

This property is configurable only by manually editing the CustomSettings.ini and BootStrap.ini files.

Property configured by Property applies to
BootStrap.ini - LTI -
CustomSettings.ini -
MDT DB ZTI -
Value Description
user_password The password for the user account credentials specified in the DBID property for using SQL Server authentication
Example
[Settings] Priority=Computers, Default [Default] OSInstall=YES [Computers] SQLServer=NYC-SQL-01 DBID=SQL_User-01 DBPwd=<complex_password> NetLib=DBNMPNTW Database=MDTDB Instance=SQLEnterprise2005 Table=Computers Parameters=SerialNumber, AssetTag ParameterCondition=OR

Debug

Controls the verbosity of messages written to the MDT log files. This property can be configured to help assist in troubleshooting deployments by providing extended information about the MDT deployment process.

You can set this property by starting the LiteTouch.vbs script with the /debug:true command-line parameter as follows:

cscript.exe LiteTouch.vbs /debug:true  

After the LiteTouch.vbs script is started, the Debug property’s value is set to TRUE, and all other scripts are automatically read the value of this property and provide verbose information.

Note

This property is dynamically set by the MDT scripts and is not configured in CustomSettings.ini or in the MDT DB. Treat this property as read only.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini
MDT DB ZTI -
Value Description
TRUE Debug logging is enabled, which includes the following:

- Verbose messages are logged.

- Deprecated messages are logged as errors.
FALSE Debug logging is not enabled. This is the default value.
Example
None

DefaultGateway

The IP address of the default gateway being used by the target computer. The format of the IP address returned by the property is standard dotted-decimal notation; for example, 192.168.1.1. Use this property to create a subsection that contains settings targeted to a group of computers based on the IP subnets on which they are located.

Note

This property is dynamically set by MDT scripts and cannot have its value set in CustomSettings.ini or the MDT DB. Treat this property as read only. However, you can use this property within CustomSettings.ini or the MDT DB, as shown in the following examples, to aid in defining the configuration of the target computer.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini
MDT DB ZTI -
Value Description
default_gateway The IP address of the default gateway in standard dotted-decimal notation
Example
[Settings] Priority=DefaultGateway, Default [Default] OSInstall=YES [DefaultGateway] 192.168.0.1=HOUSTON 11.1.1.11=REDMOND 172.28.20.1=REDMOND [REDMOND] Packages001=XXX00004:Program4 Packages002=XXX00005:Program5 [HOUSTON] Packages001=XXX00006:Program6 Packages002=XXX00007:Program7 Packages003=XXX00008:Program8

DeployDrive

The value used by the scripts to access files and run programs in the deployment share that the Deployment Workbench creates. The property returns the drive letter mapped to the DeployRoot property. ZTIApplications.wsf uses the DeployDrive property when running any command-line programs with a .cmd or .bat extension.

Note

This property is dynamically set by the MDT scripts and is not configured in CustomSettings.ini or the MDT DB. Treat this property as read only.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini
MDT DB ZTI -
Value Description
drive_letter The letter designation for the logical drive where the target operating system is to be installed (such as C or D)
Example
None

DeploymentMethod

The method being used for the deployment (UNC, media, or Configuration Manager).

Note

This property is dynamically set by the MDT scripts and is not configured in CustomSettings.ini or the MDT DB. Treat this property as read only.

Caution

This property value must be specified in uppercase so that the deployment scripts can read it properly.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini
MDT DB ZTI -
Value Description
UNC The deployment is made to the target computer over the network.
Media The deployment is made from local media (such as DVD or hard disk) at the target computer.
SCCM ZTI uses this method for Configuration Manager.
Example
None

DeploymentType

The type of deployment being performed based on the deployment scenario. For ZTI, this property is set dynamically by MDT scripts and is not configured in CustomSettings.ini. For LTI, you can bypass the page in the Deployment Wizard on which the deployment type is selected. In addition, you can specify the deployment type by passing one of the values listed below to the LiteTouch.wsf script as a command-line option.

Caution

This property value must be specified in uppercase so that the deployment scripts can read it properly.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB ZTI -
Value Description
NEWCOMPUTER The target computer is a new computer that has never been a member of the network.
REFRESH The target computer is an existing computer on the network that needs the desktop environment standard to be redeployed.
REPLACE An existing computer on the network is being replaced with a new computer. The user state migration data is transferred from the existing computer to a new computer.
Example
[Settings] Priority=Default [Default] DeploymentType=NEWCOMPUTER

DeployRoot

Specifies the UNC or local path to the folder that is the root of the folder structure that MDT uses. This folder structure contains configuration files, scripts, and other folders and files that MDT uses. The value of this property is set based on the following MDT deployment technologies:

  • LTI. This property is the UNC path to the deployment share that the Deployment Workbench creates. Use this property to select a specific deployment share. The most common use of this property is in the BootStrap.ini file to identify a deployment share before the connection to the deployment share is established. All other deployment share folders are relative to this property (such as device drivers, language packs, or operating systems).

  • ZTI. This property is the local path to the folder to which the MDT files package is copied. The Use Toolkit Package task sequence step copies the MDT files package to a local folder on the target computer, and then automatically sets this property to the local folder.

    Note

    For ZTI, this property is dynamically set by the MDT scripts and is not configured in CustomSettings.ini or in the MDT DB. Treat this property as read only.

Property configured by Property applies to
BootStrap.ini - LTI -
CustomSettings.ini
MDT DB ZTI -
Value Description
path The UNC or local path to the .
Example
[Settings] Priority=Default [Default] DeployRoot=\\NYC-AM-FIL-01\Distribution$ UserDataLocation=NONE

DestinationDisk

Disk number that the image will be deployed to.

Property configured by Property applies to
BootStrap.ini - LTI -
CustomSettings.ini -
MDT DB ZTI
Value Description
disk_number The number of the disk to which the image will be deployed
Example
[Settings] Priority=Default [Default] DestinationDisk=0

DestinationLogicalDrive

The logical drive to which the image will be deployed.

Property configured by Property applies to
Property configured by Property applies to
BootStrap.ini - LTI -
CustomSettings.ini -
MDT DB ZTI
Value Description
logical_drive_number The logical drive to which the image will be deployed
Example 1
[Settings] Priority=Default [Default] DestinationLogicalDrive=0
Example 2
[Settings] Priority=Default [Default] DestinationLogicalDrive=0

[Settings] Priority=Default [Default] InstallDNS=YES DomainNetBIOSName=WoodGroveBank NewDomain=Child DomainLevel=3 ForestLevel=3 NewDomainDNSName=newdom.WoodGroveBank.com ParentDomainDNSName=WoodGroveBank.com AutoConfigDNS=YES ConfirmGC=YES CriticalReplicationOnly=NO ADDSUserName=Administrator ADDSUserDomain=WoodGroveBank ADDSPassword=<complex_password> DatabasePath=%DestinationLogicalDrive%\Windows\NTDS ADDSLogPath=%DestinationLogicalDrive%\Windows\NTDS SysVolPath=%DestinationLogicalDrive%\Windows\SYSVOL SafeModeAdminPassword=<complex_password>

DestinationPartition

Disk partition to which the image will be deployed.

Property configured by Property applies to
BootStrap.ini - LTI -
CustomSettings.ini -
MDT DB ZTI
Value Description
partition_number The number of the partition to which the image will be deployed
Example
[Settings] Priority=Default [Default] DestinationPartition=1

DHCPScopes

Specifies the number of DHCP scopes to configure.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
scopes Specifies the number of DHCP scopes to configure
Example
[Settings] Priority=Default [Default] DHCPScopes=1

DHCPScopesxDescription

The description of the DHCP scope.

Note

The x in this properties name is a placeholder for a zero-based array that contains DHCP configurations.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
description The description of the DHCP scope
Example
[Settings] Priority=Default [Default] DHCPScopes0Description=DHCPScope0

DHCPScopesxEndIP

Specifies the ending IP address for the DHCP scope.

The x in this properties name is a placeholder for a zero-based array that contains DHCP configurations.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
end_IP Specifies the ending IP address for the DHCP scope
Example
[Settings] Priority=Default [Default] DHCPScopes0EndIP=192.168.0.30

DHCPScopesxExcludeEndIP

Specifies the ending IP address for the DHCP scope exclusion. IP addresses that are excluded from the scope are not offered by the DHCP server to clients obtaining leases from this scope.

Note

The x in this properties name is a placeholder for a zero-based array that contains DHCP configurations.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
exclude_end_IP Specifies the ending IP address for the DHCP scope exclusion
Example
[Settings] Priority=Default [Default] DHCPScopes0ExcludeEndIP=192.168.0.15

DHCPScopesxExcludeStartIP

Specifies the starting IP address for the DHCP scope exclusion. IP addresses that are excluded from the scope are not offered by the DHCP server to clients obtaining leases from this scope.

Note

The x in this properties name is a placeholder for a zero-based array that contains DHCP configurations.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
exclude_start_IP Specifies the starting IP address for the DHCP scope exclusion
Example
[Settings] Priority=Default [Default] DHCPScopes0ExcludeStartIP=192.168.0.10

DHCPScopesxIP

Specifies the IP subnet of the scope.

The x in this properties name is a placeholder for a zero-based array that contains DHCP configurations.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
IP Specifies the IP subnet of the scope
Example
[Settings] Priority=Default [Default] DHCPScopes0IP=192.168.0.0

DHCPScopesxName

A user-definable name to be assigned to the scope.

The x in this properties name is a placeholder for a zero-based array that contains DHCP configurations.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
name A user-definable name to be assigned to the scope
Example
[Settings] Priority=Default [Default] DHCPScopes0Name=DHCPScope0

DHCPScopesxOptionDNSDomainName

Specifies the domain name that the DHCP client should use when resolving unqualified domain names with the DNS.

Note

The x in this properties name is a placeholder for a zero-based array that contains DHCP configurations.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
DNS_domain_name Specifies the domain name that the DHCP client should use when resolving unqualified domain names with the DNS
Example
[Settings] Priority=Default [Default] DHCPScopes0OptionDNSDomainName=WoodGroveBank.com

DHCPScopesxOptionDNSServer

Specifies a list of IP addresses for DNS name servers available to the client. When more than one server is assigned, the client interprets and uses the addresses in the specified order.

Note

The x in this properties name is a placeholder for a zero-based array that contains DHCP configurations.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
DNS_server Specifies a list of IP addresses for DNS name servers available to the client
Example
[Settings] Priority=Default [Default] DHCPScopes0OptionDNSServer=192.168.0.2

DHCPScopesxOptionLease

The duration that the DHCP lease is valid for the client.

Note

The x in this properties name is a placeholder for a zero-based array that contains DHCP configurations.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
lease The duration that the DHCP lease is valid for the client
Example
[Settings] Priority=Default [Default] DHCPScopes0OptionLease=7

DHCPScopesxOptionNBTNodeType

Specifies the client node type for NetBT clients.

Note

The x in this properties name is a placeholder for a zero-based array that contains DHCP configurations.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
1 Configures the node type as b-node
2 Configures the node type as p-node
4 Configures the node type as m-node
8 Configures the node type as h-node
Example
[Settings] Priority=Default [Default] DHCPScopes0OptionNBTNodeType=4

DHCPScopesxOptionPXEClient

Specifies the IP address used for PXE client bootstrap code.

Note

The x in this properties name is a placeholder for a zero-based array that contains DHCP configurations.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
PXE_client Specifies the IP address used for PXE client bootstrap code
Example
[Settings] Priority=Default [Default] DHCPScopes0OptionPXEClient=192.168.0.252

DHCPScopesxOptionRouter

Specifies a list of IP addresses for routers on the client subnet. When more than one router is assigned, the client interprets and uses the addresses in the specified order. This option is normally used to assign a default gateway to DHCP clients on a subnet.

Note

The x in this properties name is a placeholder for a zero-based array that contains DHCP configurations.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
router Specifies a list of IP addresses for routers on the client subnet
Example
[Settings] Priority=Default [Default] DHCPScopes0OptionRouter=192.168.0.253

DHCPScopesxOptionWINSServer

Specifies the IP addresses to be used for NBNSes on the network.

Note

The x in this properties name is a placeholder for a zero-based array that contains DHCP configurations

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
WINS_server Specifies the IP addresses to be used for NBNSes on the network
Example
[Settings] Priority=Default [Default] DHCPScopes0OptionWINSServer=192.168.0.2

DHCPScopesxStartIP

The starting IP address for the range of IP addresses that are to be included in the scope.

Note

The x in this properties name is a placeholder for a zero-based array that contains DHCP configurations.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
start_IP The starting IP address for the range of IP addresses that are to be excluded from the scope
Example
[Settings] Priority=Default [Default] DHCPScopes0StartIP=192.168.0.20

DHCPScopesxSubnetMask

Specifies the subnet mask of the client subnet.

Note

The x in this properties name is a placeholder for a zero-based array that contains DHCP configurations.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
subnet_mask Specifies the subnet mask of the client IP subnet
Example
[Settings] Priority=Default [Default] DHCPScopes0SubnetMask=255.255.255.0

DHCPServerOptionDNSDomainName

Specifies the connection-specific DNS domain suffix of client computers.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
DNS_domain_name Specifies the connection-specific DNS domain suffix of client computers
Example
[Settings] Priority=Default [Default] DHCPServerOptionDNSDomainName=Fabrikam.com

DHCPServerOptionDNSServer

Specifies a list of IP addresses to be used as DNS name servers that are available to the client.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
DNS_server Specifies a list of IP addresses to be used as DNS name servers that are available to the client
Example
[Settings] Priority=Default [Default] DHCPServerOptionDNSServer=192.168.0.1,192.168.0.2

DHCPServerOptionNBTNodeType

Specifies the client node type for NetBT clients.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
1 Configures the node type as b-node
2 Configures the node type as p-node
4 Configures the node type as m-node
8 Configures the node type as h-node
Example
[Settings] Priority=Default [Default] DHCPServerOptionNBTNodeType=4

DHCPServerOptionPXEClient

Specifies the IP address used for PXE client bootstrap code.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
PXE_client Specifies the IP address used for PXE client bootstrap code
Example
[Settings] Priority=Default [Default] DHCPServerOptionPXEClient=192.168.0.252

DHCPServerOptionRouter

Specifies a list of IP addresses for routers on the client subnet. When more than one router is assigned, the client interprets and uses the addresses in the specified order. This option is normally used to assign a default gateway to DHCP clients on a subnet.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
router Specifies a list of IP addresses for routers on the client subnet
Example
[Settings] Priority=Default [Default] DHCPServerOptionRouter=192.168.0.253

DHCPServerOptionWINSServer

Specifies the IP addresses to be used for NBNSes on the network.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
WINS_server Specifies the IP addresses to be used for NBNSes on the network
Example
[Settings] Priority=Default [Default] DHCPServerOptionWINSServer=192.168.0.2

Dialing

The type of dialing supported by the telephony infrastructure where the target computer is located. This value is inserted into the appropriate configuration settings in Unattend.xml.

Caution

This property value must be specified in uppercase so that the deployment scripts can read it properly.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
PULSE The telephony infrastructure supports pulse dialing.
TONE The telephony infrastructure supports touch-tone dialing.
Example
[Settings] Priority=Default [Default] AreaCode=206 CountryCode=001 Dialing=TONE LongDistanceAccess=9

DisableTaskMgr

This property controls a user’s ability to start Task Manager by pressing CTRL+ALT+DEL. After the user starts Task Manager, he or she could interrupt the LTI task sequence while running in the new operating system on the target computer. This property is used in conjunction with the HideShell property and is only valid when the HideShell property is set to YES.

Note

This property and the HideShell property must both be set to YES to prevent the user pressing CTRL+ALT+DEL and interrupting the LTI task sequence.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
YES Prevent the user from being able to start Task Manager by pressing CTRL+ALT+DEL and subsequently interrupting the LTI task sequence.
NO Allow the user to start Task Manager by pressing CTRL+ALT+DEL and subsequently interrupt the LTI task sequence. This is the default value.
Example
[Settings] Priority=Default [Default] DisableTaskMgr=YES HideShell=YES

DNSServerOptionBINDSecondaries

Determines whether to use fast transfer format for transfer of a zone to DNS servers running legacy BIND implementations.

By default, all Windows-based DNS servers use a fast zone transfer format. This format uses compression, and it can include multiple records per TCP message during a connected transfer. This format is also compatible with more recent BIND-based DNS servers that run version 4.9.4 and later.

Caution

This property value must be specified in uppercase so that the deployment scripts can read it properly.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
TRUE Allows BIND secondaries
FALSE Does not allow to BIND secondaries
Example
[Settings] Priority=Default [Default] DNSServerOptionBINDSecondaries=TRUE

DNSServerOptionDisableRecursion

Determines whether or not the DNS server uses recursion. By default, the DNS Server service is enabled to use recursion.

Caution

This property value must be specified in uppercase so that the deployment scripts can read it properly.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
TRUE Disables recursion on the DNS server
FALSE Enables recursion on the DNS server
Example
[Settings] Priority=Default [Default] DNSServerOptionDisableRecursion=TRUE

DNSServerOptionEnableNetmaskOrdering

Determines whether the DNS server reorders address (A) resource records within the same resource record that is set in the server's response to a query based on the IP address of the source of the query.

By default, the DNS Server service uses local subnet priority to reorder A resource records.

Caution

This property value must be specified in uppercase so that the deployment scripts can read it properly.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
TRUE Enables netmask ordering
FALSE Disables netmask ordering
Example
[Settings] Priority=Default [Default] DNSServerOptionEnableNetmaskOrdering=TRUE

DNSServerOptionEnableRoundRobin

Determines whether the DNS server uses the round robin mechanism to rotate and reorder a list of resource records if multiple resource records exist of the same type that exist for a query answer.

By default, the DNS Server service uses round robin.

Caution

This property value must be specified in uppercase so that the deployment scripts can read it properly.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
TRUE Enables round robin
FALSE Disables round robin
Example
[Settings] Priority=Default [Default] DNSServerOptionEnableRoundRobin=TRUE

DNSServerOptionEnableSecureCache

Determines whether the DNS server attempts to clean up responses to avoid cache pollution. This setting is enabled by default. By default, DNS servers use a secure response option that eliminates adding unrelated resource records that are included in a referral answer to their cache. In most cases, any names that are added in referral answers are typically cached, and they help expedite the resolution of subsequent DNS queries.

With this feature, however, the server can determine that referred names are potentially polluting or insecure and then discard them. The server determines whether to cache the name that is offered in a referral on the basis of whether it is part of the exact, related, DNS domain name tree for which the original queried name was made.

Caution

This property value must be specified in uppercase so that the deployment scripts can read it properly.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
TRUE Enables cache security
FALSE Disables cache security
Example
[Settings] Priority=Default [Default] DNSServerOptionEnableSecureCache=TRUE

DNSServerOptionFailOnLoad

Specifies that loading of a zone should fail when bad data is found.

Caution

This property value must be specified in uppercase so that the deployment scripts can read it properly.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
TRUE Enable fail on load
FALSE Disable fail on load
Example
[Settings] Priority=Default [Default] DNSServerOptionFailOnLoad=TRUE

DNSServerOptionNameCheckFlag

Specifies which character standard is used when checking DNS names.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
0 Uses ANSI characters that comply with Internet Engineering Task Force (IETF) Request for Comments (RFCs). This value corresponds to the Strict RFC (ANSI) selection when configuring DNS in the Deployment Workbench.
1 Uses ANSI characters that do not necessarily comply with IETF RFCs. This value corresponds to the Non RFC (ANSI) selection when configuring DNS in the Deployment Workbench.
2 Uses multibyte UCS Transformation Format 8 (UTF-8) characters. This is the default setting. This value corresponds to the Multibyte (UTF-8) selection when configuring DNS in the Deployment Workbench.
3 Uses all characters. This value corresponds to the All names selection when configuring DNS in the Deployment Workbench.
Example
[Settings] Priority=Default [Default] DNSServerOptionNameCheckFlag=2

DNSZones

Specifies the number of DNS zones to configure.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
zones Specifies the number of DNS zones to configure
Example
[Settings] Priority=Default [Default] DNSZones=1 DNSZones0Name=MyNewZone DNSZones0DirectoryPartition=Forest DNSZones0FileName=MyNewZone.dns DNSZones0MasterIP=192.168.0.1,192.168.0.2 DNSZones0Type=Secondary

DNSZonesxDirectoryPartition

Specifies the directory partition on which to store the zone when configuring secondary or stub zones.

Note

The x in this properties name is a placeholder for a zero-based array that contains DNS configurations.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
Domain Replicates zone data to all DNS server in the AD DS domain
Forest Replicates zone data to all DNS server in the AD DS forest
Legacy Replicates zone data to all domain controllers in the AD DS domain
Example
[Settings] Priority=Default [Default] DNSZones0DirectoryPartition=Forest

DNSZonesxFileName

Specifies the name of the file that will store the zone information.

Note

The x in this properties name is a placeholder for a zero-based array that contains DNS configurations.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
file_name Specifies the name of the file that will store the zone information
Example
[Settings] Priority=Default [Default] DNSZones0FileName=MyNewZone.dns

DNSZonesxMasterIP

A comma delimited list of IP addresses of the master servers to be used by the DNS server when updating the specified secondary zones. This property must be specified when configuring a secondary or stub DNS zone.

Note

The x in this properties name is a placeholder for a zero-based array that contains DNS configurations.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
IP1,IP2 A comma-delimited list of IP addresses of the master servers
Example
[Settings] Priority=Default [Default] DNSZones0MasterIP=192.168.0.1,192.168.0.2

DNSZonesxName

Specifies the name of the zone.

Note

The x in this properties name is a placeholder for a zero-based array that contains DNS configurations.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
name Specifies the name of the zone
Example
[Settings] Priority=Default [Default] DNSZones0Name=MyNewZone

DNSZonesxScavenge

Configures the Primary DNS server to "scavenge" stale records—that is, to search the database for records that have aged and delete them.

Note

The x in this properties name is a placeholder for a zero-based array that contains DNS configurations.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
TRUE Allow stale DNS records to be scavenged.
FALSE Do not allow stale DNS records to be scavenged.
Example
[Settings] Priority=Default [Default] DNSZones0Scavenge=TRUE

DNSZonesxType

Specifies the type of zone to create.

Note

The x in this properties name is a placeholder for a zero-based array that contains DNS configurations.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
DSPrimary Creates a primary zone and specifying that it should be stored in AD DS on a DNS server configured as a domain controller
DSStub Creates a stub zone and specifying that it should be stored in AD DS on a DNS server configured as a domain controller
Primary Creates a primary zone
Secondary Creates a secondary zone
Stub Creates a stub zone
Example
[Settings] Priority=Default [Default] DNSZones0Type=Secondary

DNSZonesxUpdate

Configures the Primary DNS server to perform dynamic updates.

Note

The x in this properties name is a placeholder for a zero-based array that contains DNS configurations.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
0 Does not allow dynamic updates
1 Allows dynamic updates
2 Allows secure dynamic updates
Example
[Settings] Priority=Default [Default] DNSZones0Update=1

DoCapture

Indicator of whether an image of the target computer is to be captured. If it is, Sysprep is run on the target computer to prepare for image creation. After Sysprep has run, a new WIM image is created and stored in the folder within the shared folder designated for target computer backups (BackupDir and BackupShare, respectively).

Caution

This property value must be specified in uppercase so that the deployment scripts can read it properly.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
YES Copy the necessary files to run Sysprep on the target computer, run Sysprep on the target computer, and capture a WIM image.
NO Do not run Sysprep on the target computer, and do not capture a WIM image.
PREPARE Copy the necessary files to run Sysprep on the target computer, but do not run Sysprep or other image-capture processes.
SYSPREP Copy the necessary files to run Sysprep on the target computer, run Sysprep on the target computer, but do not capture a WIM image.

Note:

The primary purpose of this value is to allow the creation of a VHD that contains an operating system after Sysprep has been run and no image capture is necessary.
Example
[Settings] Priority=Default [Default] DoCapture=YES DeployRoot=\\NYC-AM-FIL-01\Distribution$ ResourceRoot=\\NYC-AM-FIL-01\Resource$ UDShare=\\NYC-AM-FIL-01\MigData$ UDDir=%OSDComputerName%

DomainAdmin

The user account credentials used to join the target computer to the domain specified in JoinDomain. Specify as UserName.

Note

For ZTI, the credentials that Configuration Manager specifies typically are used. If the DomainAdmin property is specified, the credentials in the DomainAdmin property override the credentials that Configuration Manager specifies.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
domain_admin The name of the user account credentials
Example
[Settings] Priority=Default [Default] DomainAdmin=NYCAdmin DomainAdminDomain=WOODGROVEBANK DomainAdminPassword=<complex_password>

DomainAdminDomain

The domain in which the user’s credentials specified in DomainAdmin reside.

Note

For ZTI, the credentials that Configuration Manager specifies typically are used. If the DomainAdmin property is specified, the credentials in the DomainAdmin property override the credentials that Configuration Manager specifies.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
domain_admin_domain The name of the domain where the user account credentials reside
Example
[Settings] Priority=Default [Default] DomainAdmin=NYCAdmin DomainAdminDomain=WOODGROVEBANK DomainAdminPassword=<complex_password>

DomainAdminPassword

The password used for the domain Administrator account specified in the DomainAdmin property to join the computer to the domain.

Note

For ZTI, the credentials that Configuration Manager specifies typically are used. If the DomainAdmin property is specified, the credentials in the DomainAdmin property override the credentials that Configuration Manager specifies.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
domain_admin_password The password for the domain Administrator account on the target computer
Example
[Settings] Priority=Default [Default] DomainAdmin=NYCAdmin DomainAdminDomain=WOODGROVEBANK DomainAdminPassword=<complex_password>

DomainLevel

This entry specifies the domain functional level. This entry is based on the levels that exist in the forest when a new domain is created in an existing forest.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
Level Sets the domain functional level to one of the following:

- 2, Windows Server 2003

- 3, Windows Server 2008

- 4, Windows Server 2008 R2

- 5, Windows Server 2012
Example
[Settings] Priority=Default [Default] DomainLevel=3

DomainNetBiosName

Assigns a NetBIOS name to the new domain.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
Name Assigns a NetBIOS name to the new domain
Example
[Settings] Priority=Default [Default] DomainNetBiosName=NewDom

DomainOUs

A list of AD DS organizational units (OUs) where the target computer account can be created. The DomainOUs property lists text values that can be any non-blank value. The DomainOUs property has a numeric suffix (for example, DomainOUs1 or DomainOUs2). The values specified by DomainOUs will be displayed in the Deployment Wizard and selectable by the user. The MachineObjectOU property will then be set to the OU selected.

In addition, the same functionality can be provided by configuring the DomainOUList.xml file. The format of the DomainOUList.xml file is as follows:

<?xml version="1.0" encoding="utf-8"?>  
<DomainOUs>  
<DomainOU>  
  OU=Computers,OU=Tellers,OU=NYC,DC=WOODGROVEBANK,DC=Com  
</DomainOU>  
<DomainOU>  
  OU=Computers,OU=Managers,OU=NYC,DC=WOODGROVEBANK,DC=Com  
</DomainOU>  
</DomainOUs>  
Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB ZTI
Value Description
OU The OU in which the target computer account can be created
Example
[Settings] Priority=Default [Default] OSInstall=Y DomainOUs1=OU=Computers, OU=Tellers, OU=NYC, DC=WOODGROVEBANK, DC=Com DomainOUs2=OU=Computers, OU=Managers, OU=NYC, DC=WOODGROVEBANK, DC=Com

DoNotCreateExtraPartition

Specifies that deployments of Windows 7 and Windows Server 2008 R2 will not create the 300 MB system partition.

Caution

This property value must be specified in uppercase so that the deployment scripts can read it properly.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
YES The additional system partition will not be created.
NO The additional system partition will be created.
Example
[Settings] Priority=Default [Default] OSInstall=Y DoNotCreateExtraPartition=YES

Note

Do not use this property in conjunction with properties to configure BitLocker settings.

DoNotFormatAndPartition

This property is used to configure whether MDT performs any of the partitioning and formatting task sequence steps in task sequences created using the MDT task sequence templates.

Caution

This property value must be specified in uppercase so that the deployment scripts can read it properly.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
YES The partitioning and formatting task sequence steps in an MDT task sequence will be performed.
Any other value The partitioning and formatting task sequence steps in an MDT task sequence will not be performed. This is the default value.
Example
[Settings] Priority=Default [Default] OSInstall=YES SkipUserData=YES USMTOfflineMigration=TRUE DoNotFormatAndPartition=YES OSDStateStorePath=\\WDG-MDT-01\StateStore$

DriverGroup

A list of text values that associates out-of-box drivers created in the Deployment Workbench with each other (typically based on the make and model of a computer). A driver can be associated with one or more driver groups. The DriverGroup property allows the drivers within one or more groups to be deployed to a target computer.

The text values in the list can be any non-blank value. The DriverGroup property value has a numeric suffix (for example, DriverGroup001 or DriverGroup002). After it is defined, a driver group is associated with a computer. A computer can be associated with more than one driver group.

For example, there are two sections for each of the computer manufacturers [Mfgr01] and [Mfgr02]. Two driver groups are defined for the manufacturer Mfgr01: Mfgr01 Video Drivers and Mfgr01 Network Drivers. For the manufacturer Mfgr02, one driver group is defined, Mfgr02 Drivers. One driver group, Shared Drivers, is applied to all computers found in the [Default] section.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
driver_group_name The name of the driver group defined in the Deployment Workbench
Example
[Settings] Priority=Make, Default [Default] DriverGroup001=Shared Drivers :: [Mfgr01] DriverGroup001=Mfgr01 Video Drivers DriverGroup002=Mfgr01 Network Drivers [Mfgr02] DriverGroup001=Mfgr02 Drivers

DriverInjectionMode

This property is used to control the device drivers that are injected by the Inject Drivers task sequence step.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
Auto Inject only matching drivers from the selection profile or folder. This is the same behavior as MDT 2008, which injects all drivers that matched one of the plug and play (PnP) identifiers (IDs) on the target computer.
All Inject all drivers in the selection profile or folder.
Example
[Settings] Priority=Default [Default] DriverInjectionMode=ALL DriverSelectionProfile=Nothing DriverPaths001=\\NYC-AM-FIL-01\Drivers$ DriverPaths002=\\NYC-AM-FIL-03\WinDrvs

DriverPaths

A list of UNC paths to shared folders where additional device drivers are located. These device drivers are installed with the target operating system on the target computer. The MDT scripts copy the contents of these folders to the C:\Drivers folder on the target computer. The DriverPaths property is a list of text values that can be any non-blank value. The DriverPaths property has a numeric suffix (for example, DriverPaths001 or DriverPaths002).

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB ZTI
Value Description
UNC_path UNC path to the shared folder in which the additional drivers reside
Example
[Settings] Priority=Default [Default] DriverPaths001=\\NYC-AM-FIL-01\Drivers$ DriverPaths002=\\NYC-AM-FIL-03\Win8Drvs

DriverSelectionProfile

Profile name used during driver installation.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
profile_name None
Example
[Settings] Priority=Default [Default] DriverSelectionProfile=MonitorDrivers

EventService

The EventService property specifies the URL where the MDT monitoring service is running. By default, the service uses TCP port 9800 to communicate. The MDT monitoring service collects deployment information on the deployment process that can be viewed in the Deployment Workbench and using the Get-MDTMonitorData cmdlet.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
url_path The URL to the MDT monitoring service.
Example
[Settings] Priority=Default [Default] EventService=http://WDG-MDT-01:9800 DeployRoot=\\NYC-AM-FIL-01\Distribution$ ResourceRoot=\\NYC-AM-FIL-01\Resource$

EventShare

The EventShare property points to a shared folder in which the MDT scripts record events.

By default, the shared folder is created in C:\Events.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
UNC_path The UNC path to the shared folder in which the MDT scripts record events. The default share name is Events.
Example
[Settings] Priority=Default [Default] EventShare=\\NYC-AM-FIL-01\Events DeployRoot=\\NYC-AM-FIL-01\Distribution$ ResourceRoot=\\NYC-AM-FIL-01\Resource$

FinishAction

Specifies the action to be taken when an LTI task sequence finishes, which is after the Summary wizard page in the Deployment Wizard.

Tip

Use this property in conjunction with the SkipFinalSummary property to skip the Summary wizard page in the Deployment Wizard and automatically perform the action.

Caution

This property value must be specified in uppercase so that the deployment scripts can read it properly.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
action Where action is one of the following:

- SHUTDOWN. Shuts down the target computer.

- REBOOT. Restarts the target computer.

- RESTART. Same as REBOOT.

- LOGOFF. Log off the current user. If the target computer is currently running Windows PE, then the target computer will be restarted.

- blank. Exit the Deployment Wizard without performing any additional actions. This is the default setting.
Example
[Settings] Priority=Default [Default] FinishAction=REBOOT

ForceApplyFallback

Controls the method used for installed Windows:

  • setup.exe. This method is the traditional method, initiated by running setup.exe from the installation media. MDT uses this method by default.

  • imagex.exe. This method installs the operating system image using imagex.exe with the /apply option. MDT uses this method when the setup.exe method cannot be used (i.e., MDT falls back to using imagex.exe).

    Besides controlling the method used to install these operating systems, this property affects which operating system task sequences are listed in the Deployment Wizard for a specific processor architecture boot image. When the value of this property is set to NEVER, only operating system task sequences that match the processor architecture of the boot image are displayed. If the value of this property is set to any other value or is blank, all task sequences that can use the imagex.exe installation method are shown, regardless of the processor architecture.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
NEVER MDT always uses the imagex.exe method if necessary. Only task sequences that deploy an operating system that matches the boot image are displayed in the Deployment Wizard.
Any other value, including blank Any task sequence that supports the imagex.exe method is displayed in the Deployment Wizard.
Example
[Settings] Priority=Default [Default] OSInstall=YES ForceApplyFallback=NEVER

ForestLevel

This entry specifies the forest functional level when a new domain is created in a new forest.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
level Sets the domain functional level to one of the following:

- 2, Windows Server 2003

- 3, Windows Server 2008

- 4, Windows Server 2008 R2

- 5, Windows Server 2012
Example
[Settings] Priority=Default [Default] ForestLevel=3

FullName

The full name of the user of the target computer provided during the installation of the operating system. This value is inserted into the appropriate configuration settings in Unattend.xml.

Note

This value is different from the user credentials created after the operating system is deployed. The FullName property is provided as information to systems administrators about the user running applications on the target computer.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
full_name The full name of the user of the target computer
Example
[Settings] Priority=MACAddress, Default Properties=CustomProperty, ApplicationInstall [Default] CustomProperty=TRUE OrgName=Woodgrove Bank [00:0F:20:35:DE:AC] OSDNEWMACHINENAME=HPD530-1 ApplicationInstall=Custom FullName=Woodgrove Bank User [00:03:FF:FE:FF:FF] OSDNEWMACHINENAME=BVMXP ApplicationInstall=Minimum FullName=Woodgrove Bank Manager

GPOPackPath

This property is used to override the default path to the folder in which the GPO packs reside. The path specified in this property is relative to the Templates\GPOPacks folder in a distribution share. MDT automatically scans a specific subfolder of this folder based on the operating system being deployed to the target computer, such as Templates\GPOPacks\operating_system (where operating_system is the operating system being deployed). Table 3 list the supported operating systems and the subfolders that correspond to each operating system.

Table 3. Windows Operating Systems and Corresponding GPO Pack Subfolder
Operating system GPO pack subfolder
Windows 7 with SP1 Win7SP1-MDTGPOPack
Windows Server 2008 R2 WS2008R2SP1-MDTGPOPack
Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
path The path relative to the distribution_share\Templates\GPOPacks folder (where distribution_share is the root folder of the distribution share. The default value is the distribution_share\Templates\GPOPacks\operating_system folder (where operating_system is a subfolder based on the operating system version).

In the example below, setting the GPOPackPath property to a value of "Win7-HighSecurity" configures MDT to use the distribution_share\Templates\GPOPacks\Win7-HighSecurity folder as the folder where the GPO packs are stored.
Example
[Settings] Priority=Default [Default] GPOPackPath=Win7-HighSecurity

Groups

The list of local groups on the target computer whose membership will be captured. This group membership is captured during the State Capture Phase and is restored during the State Restore Phase. (The default groups are Administrators and Power Users.) The Groups property is a list of text values that can be any non-blank value. The Groups property has a numeric suffix (for example, Groups001 or Groups002).

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB ZTI -
Value Description
group_name The name of the local group on the target computer for which group membership will be captured
Example
[Settings] Priority=Default [Default] DeployRoot=\\NYC-AM-FIL-01\Distribution$ ResourceRoot=\\NYC-AM-FIL-01\Resource$ UDShare=\\NYC-AM-FIL-01\MigData$ CaptureGroups=YES Groups001=NYC Application Management Groups002=NYC Help Desk Users

HideShell

This property controls the display of Windows Explorer while the LTI task sequence is running in the new operating system on the target computer. This property can be used in conjunction with the DisableTaskMgr property.

Note

This property can be used with the DisableTaskMgr property to help prevent users from interrupting the LTI task sequence. For more information, see the DisableTaskMgr property.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
YES Windows Explorer is hidden until the task sequence is complete.
NO Windows Explorer is visible while the task sequence is running. This is the default value.
Example
[Settings] Priority=Default [Default] DisableTaskMgr=YES HideShell=YES

OSHome_Page

The URL to be used as the Windows Internet Explorer® home page after the target operating system is deployed.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
URL The URL of the web page to be used as the home page for Internet Explorer on the target computer
Example
[Settings] Priority=Default [Default] Home_Page=http://portal.woodgrovebank.com

HostName

The IP host name of the target computer (the name assigned to the target computer).

Note

This is the computer name of the target computer, not the NetBIOS computer name of the target computer. The NetBIOS computer name can be shorter than the computer name. Also, this property is dynamically set by MDT scripts and cannot have its value set in CustomSettings.ini or the MDT DB. Treat this property as read only. However, you can use this property within CustomSettings.ini or the MDT DB, as shown in the following examples, to aid in defining the configuration of the target computer.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini
MDT DB ZTI -
Value Description
host_name The IP host name assigned to the target computer
Example
None

ImagePackageID

The package ID used for the operating system to install during OEM deployments.

Note

This property is dynamically set by the MDT scripts and is not configured in CustomSettings.ini or the MDT DB. Treat this property as read only.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini
MDT DB ZTI -
Value Description
None The package ID used for the operating system to install during OEM deployments
Example
None

InputLocale

A list of input locales to be used with the target operating system. More than one input locale can be specified for the target operating system. Each locale must be separated by a semicolon (;). If not specified, the Deployment Wizard uses the input locale configured in the image being deployed.

Exclude this setting in the Windows User State Migration Tool (USMT) when backing up and restoring user state information. Otherwise, the settings in the user state information will override the values specified in the InputLocale property.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
input_locale1; input_locale2 The locale for the keyboard attached to the target computer
Example
[Settings] Priority=Default [Default] UserLocale=en-us InputLocale=0409:00000409;0413:00020409;0413:00000409;0409:00020409

InstallPackageID

The package ID used for the operating system to install during OEM deployments.

Note

This property is dynamically set by the MDT scripts and is not configured in CustomSettings.ini or the MDT DB. Treat this property as read only.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini
MDT DB ZTI -
Value Description
None The package ID used for the operating system to install during OEM deployments
Example
None

Instance

The instance of SQL Server used for querying property values from columns in the table specified in the Table property. The database resides on the computer specified in the SQLServer property. The instance of SQL Server on the computer is specified in the Instance property.

Property configured by Property applies to
BootStrap.ini - LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
instance
Example
[Settings] Priority=Computers, Default [Default] OSInstall=YES [Computers] SQLServer=NYC-SQL-01 Database=MDTDB Instance=SQLEnterprise2005 Table=Computers Parameters=SerialNumber, AssetTag ParameterCondition=OR

IPAddress

The IP address of the target computer. The format of the IP address returned by the property is standard dotted-decimal notation; for example, 192.168.1.1. Use this property to create a subsection that contains settings targeted to a specific target computer based on the IP address.

Note

This property is dynamically set by the MDT scripts and is not configured in CustomSettings.ini or the MDT DB. Treat this property as read only.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini
MDT DB ZTI -
Value Description
ip_address The IP address of the target computer in standard dotted-decimal notation
Example
None

IsDesktop

Indicator of whether the computer is a desktop, because the Win32_SystemEnclosure ChassisType property value is 3, 4, 5, 6, 7, or 15.

Note

Only one of the following properties will be true at a time: IsDesktop, IsLaptop, IsServer.

Note

This property is dynamically set by the MDT scripts and is not configured in CustomSettings.ini or the MDT DB. Treat this property as read only.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini
MDT DB ZTI -
Value Description
TRUE The target computer is a desktop computer.
FALSE The target computer is not a desktop computer.
Example
None

IsHypervisorRunning

Specifies whether a hypervisor is present on the target computer. This property is set using information from the CPUID interface.

For further information collected about VMs and information returned from the CPUID interface, see the following properties:

  • IsVM

  • SupportsHyperVRole

  • SupportsNX

  • SupportsVT

  • Supports64Bit

  • VMPlatform

Note

This property is dynamically set by the MDT scripts and is not configured in CustomSettings.ini or the MDT DB. Treat this property as read only.

Note

The IsVM property should be used to determine whether the target computer is a virtual or physical machine.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini
MDT DB ZTI -
Value Description
TRUE A hypervisor is detected.
FALSE A hypervisor is not detected.
Example
None

IsLaptop

Indicator of whether the computer is a portable computer, because the Win32_SystemEnclosure ChassisType property value is 8, 10, 12, 14, 18, or 21.

Note

Only one of the following properties will be true at a time: IsDesktop, IsLaptop, IsServer.

Note

This property is dynamically set by the MDT scripts and is not configured in CustomSettings.ini or the MDT DB. Treat this property as read only.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini
MDT DB ZTI -
Value Description
TRUE The target computer is a portable computer.
FALSE The target computer is not a portable computer.
Example
None

IsServer

Indicator of whether the computer is a server, because the Win32_SystemEnclosure ChassisType property value is 23.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini
MDT DB ZTI -
Value Description
TRUE The target computer is a server.
FALSE The target computer is not a server.
Example
None

IsServerCoreOS

Indicator of whether the current operating system running on the target computer is the Server Core installation option of the Windows Server operating system.

Note

This property is dynamically set by the MDT scripts and is not configured in CustomSettings.ini or the MDT DB. Treat this property as read only.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini
MDT DB ZTI -
Value Description
TRUE The operating system on the target computer is the Server Core installation option of Windows Server.
FALSE The operating system on the target computer is not the Server Core installation option of Windows Server.
Example
None

IsServerOS

Indicator of whether the current operating system running on the target computer is a server operating system.

Note

This property is dynamically set by the MDT scripts and is not configured in CustomSettings.ini or the MDT DB. Treat this property as read only.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini
MDT DB ZTI -
Value Description
TRUE The operating system on the target computer is a server operating system.
FALSE The operating system on the target computer is not a server operating system.
Example
None

IsUEFI

Specifies whether the target computer is currently running with Unified Extensible Firmware Interface (UEFI). The UEFI is a specification that defines a software interface between an operating system and platform firmware. UEFI is a more secure replacement for the older BIOS firmware interface present in some personal computers. For more information on UEFI, go to http://www.uefi.org.

Note

This property is dynamically set by the MDT scripts and is not configured in CustomSettings.ini or the MDT DB. Treat this property as read only.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini
MDT DB ZTI -
Value Description
TRUE The target computer is currently running with UEFI.
FALSE The target computer is not currently running with UEFI.

Note:

It is possible that the target computer may support UEFI, but is running in a compatibility mode that emulates the older BIOS firmware interface. In this situation this value of this property will set to FALSE even though the target computer supports UEFI.
Example
None

IsVM

Specifies whether the target computer is a VM based on information gathered from the CPUID interface. You can determine the specific VM environment using the VMPlatform property.

For further information collected about VMs and information returned from the CPUID interface, see the following properties:

  • IsHypervisorRunning

  • SupportsHyperVRole

  • SupportsNX

  • SupportsVT

  • Supports64Bit

  • VMPlatform

Note

This property is dynamically set by the MDT scripts and is not configured in CustomSettings.ini or the MDT DB. Treat this property as read only.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini
MDT DB ZTI -
Value Description
TRUE The target computer is a VM.
FALSE The target computer is not a VM.
Example
None

JoinDomain

The domain that the target computer joins after the target operating system is deployed. This is the domain where the computer account for the target computer is created. The JoinDomain property can contain alphanumeric characters, hyphens (-), and underscores (_). The JoinDomain property cannot be blank or contain spaces.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
domain_name The name of the domain that the target computer joins
Example
[Settings] Priority=Default [Default] JoinDomain=WOODGROVEBANK MachineObjectOU=OU=Reception,OU=NYC,DC=Woodgrovebank,DC=com

JoinWorkgroup

The workgroup that the target computer joins after the target operating system is deployed. The JoinWorkgroup property can contain alphanumeric characters, hyphens (-), and underscores (_). The JoinWorkgroup property cannot be blank or contain spaces.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
workgroup_name The name of the workgroup that the target computer joins
Example
[Settings] Priority=Default [Default] JoinWorkgroup=WDGV_WORKGROUP

KeyboardLocale

A list of keyboard locales to be used with the target operating system. More than one keyboard locale can be specified for the target operating system. Each locale must be separated by a semicolon (;). If not specified, the Deployment Wizard uses the keyboard locale configured in the image being deployed.

Exclude this setting in USMT when backing up and restoring user state information. Otherwise, the settings in the user state information will override the values specified in the KeyboardLocale property.

Note

For this property to function properly, it must be configured in both CustomSettings.ini and BootStrap.ini. BootStrap.ini is processed before a deployment share (which contains CustomSettings.ini) has been selected.

Property configured by Property applies to
BootStrap.ini - LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
keyboard_locale1; keyboard_locale2 The locale of the keyboard attached to the target computer.

The value can be specified in the following formats:

- Text (en-us)

- Hexadecimal (0409:00000409)
Example 1
[Settings] Priority=Default [Default] UserLocale=en-us KeyboardLocale=en-us
Example 2
[Settings] Priority=Default [Default] UserLocale=en-us KeyboardLocale=0409:00000409;1809:00001809;041A:0000041A;083b:0001083b

KeyboardLocalePE

The name of the keyboard locale to be used while in Windows PE only.

Note

For this property to function properly, it must be configured in both CustomSettings.ini and BootStrap.ini. BootStrap.ini is processed before a deployment share (which contains CustomSettings.ini) has been selected.

Property configured by Property applies to
BootStrap.ini - LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
keyboard_locale The locale of the keyboard attached to the target computer.

The value can be specified in the following formats:

- Text (en-us)

- Hexadecimal (0409:00000409)
Example 1
[Settings] Priority=Default [Default] KeyboardLocalePE=en-us
Example 2
[Settings] Priority=Default [Default] KeyboardLocalePE=0409:00000409

LanguagePacks

A list of the GUIDs for the language packs to be deployed on the target computer. Deployment Workbench specifies these language packs on the OS Packages node. These GUIDs are stored in the Packages.xml file. The LanguagePacks property has a numeric suffix (for example, LanguagePacks001 or LanguagePacks002).

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB ZTI
Value Description
language_pack_guid The GUID that the Deployment Workbench specifies for the language packs to install on the target computer. The GUID corresponds to the language pack GUID stored in Packages.xml.
Example
[Settings] Priority=Default [Default] LanguagePacks001={a1923f8d-b07b-44c7-ac1e-353b7cc4c1ad}

LoadStateArgs

The arguments passed to the USMT Loadstate process. The ZTI script inserts the appropriate logging, progress, and state store parameters. If this value is not included in the settings file, the user state restore process is skipped.

If the Loadstate process finishes successfully, the user state information is deleted. In the event of a Loadstate failure (or non-zero return code), the local state store is moved to %WINDIR%\StateStore to prevent deletion and to ensure that no user state information is lost.

Note

Do not add any of the following command-line arguments when configuring this property: /hardlink, /nocompress, /decrypt, /key, or /keyfile. The MDT scripts will add these command-line arguments if applicable to the current deployment scenario.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
Arguments The command-line arguments passed to Loadstate.exe.

The default arguments specified by Deployment Workbench are as follows:

- /v. Enables verbose output in the Loadstate log. The default is 0. Specify any number from 0 to 15. The value 5 enables verbose and status output.

- /c. When specified, Loadstate will continue to run even if there are nonfatal errors. Without the /c option, Loadstate exits on the first error.

- /lac. Specifies that if the account being migrated is a local (non-domain) account, and it does not exist on the destination computer, then USMT will create the account but it will be disabled.

For more information about these and other arguments, see the USMT Help files.
Example
[Settings] Priority=Default [Default] OSInstall=YES ScanStateArgs=/v:5 /o /c LoadStateArgs=/v:5 /c /lac DeployRoot=\\NYC-AM-FIL-01\Distribution$ ResourceRoot=\\NYC-AM-FIL-01\Resource$ UDShare=\\NYC-AM-FIL-01\MigData$ UDDir=%OSDComputerName%

Location

The geographic location of the target computers. A list of IP addresses that correspond to the default gateways defined for the computers within that location defines the Location property. An IP address for a default gateway can be associated with more than one location.

Typically, the value for the Location property is set by performing a database query on the database managed using Deployment Workbench. Deployment Workbench can assist in creating the locations, defining property settings associated with the locations, and then in configuring CustomSettings.ini to perform the database query for the Location property and the property settings associated with the locations.

For example, a LocationSettings section in CustomSettings.ini can query the LocationSettings view in the database for a list of locations that contain the value specified in the DefaultGateway property listed in the Parameters property. The query returns all settings associated with each default gateway.

Then the scripts parse each section that corresponds to the locations returned in the query. For example, the value [Springfield]and the section [Springfield-123 Oak Street-4th Floor] in CustomSettings.ini can represent the corresponding locations. This is an example of how one computer can belong to two locations. The [Springfield]section is for all computers in a larger geographic area (an entire city), and the [Springfield-123 Oak Street-4th Floor] section is for all computers on the fourth floor at 123 Oak Street, in Springfield.

Property configured by Property applies to
BootStrap.ini - LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
location1,location2 The list of locations to be assigned to an individual computer or a group of computers
Example
[Settings] Priority=LSettings, Default [Default] UserDataLocation=AUTO DeployRoot=\\W2K3-SP1\Distribution$ OSInstall=YES ScanStateArgs=/v:15 /o /c LoadStateArgs=/v:7 /c [LSettings] SQLServer=w2k3-sp1 Instance=MDT2010 Database=MDTDB Netlib=DBNMPNTW SQLShare=SQL$ Table=LocationSettings Parameters=DefaultGateway [Springfield] UDDir=%OSDComputerName% UDShare=\\Springfield-FIL-01\UserData [Springfield-123 Oak Street-4th Floor] DeployRoot=\\Springfield-BDD-01\Distribution1$

LongDistanceAccess

The dialing digits to gain access to an outside line to dial long distance. The property can contain only numeric digits. This value is inserted into the appropriate configuration settings in Unattend.xml.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
language_pack_guid The GUID that the Deployment Workbench specifies for the language packs to install on the target computer. The GUID corresponds to the language pack GUID stored in Packages.xml.
Example
[Settings] Priority=Default [Default] AreaCode=206 CountryCode=001 Dialing=TONE LongDistanceAccess=9

MACAddress

The media access control (MAC) layer address of the primary network adapter of the target computer. The MACAddress property is included on the Priority line so that property values specific to a target computer can be provided. Create a section for each MAC address for each of the target computers (such as [00:0F:20:35:DE:AC]or [00:03:FF:FE:FF:FF]) that contain target computer–specific settings.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB ZTI -
Value Description
mac_address The MAC address of the target computer
Example
[Settings] Priority=MACAddress, Default [Default] CaptureGroups=YES Groups1=NYC Application Management Groups2=NYC Help Desk Users [00:0F:20:35:DE:AC] OSDNEWMACHINENAME=HPD530-1 [00:03:FF:FE:FF:FF] OSDNEWMACHINENAME=BVMXP

MachineObjectOU

The AD DS OU in the target domain where the computer account for the target computer is created.

Note

The OU specified in this property must exist before deploying the target operating system.

Note

If a computer object already exists in AD DS, specifying MachineObjectOU will not cause the computer object to be moved to the specified OU.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
OU_name The name of the OU where the computer account for the target computer will be created
Example
[Settings] Priority=Default [Default] JoinDomain=WOODGROVEBANK MachineObjectOU=OU=Reception,OU=NYC,DC=Woodgrovebank,DC=com

Make

The manufacturer of the target computer. The format for Make is undefined. Use this property to create a subsection that contains settings targeted to a specific computer manufacturer (most commonly in conjunction with the Model and Product properties).

Note

This property is dynamically set by MDT scripts and cannot have its value set in CustomSettings.ini or the MDT DB. Treat this property as read only. However, you can use this property within CustomSettings.ini or the MDT DB, as shown in the following examples, to aid in defining the configuration of the target computer.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini
MDT DB ZTI -
Value Description
make The manufacturer of the target computer
Example
[Settings] Priority=Make, Default [Default] [Dell Computer Corporation] Subsection=Dell-%Model% [Dell-Latitude D600] Packages001=XXX00009:Program9 Packages002=XXX0000A:Program10

MandatoryApplications

A list of application GUIDs that will be installed on the target computer. These applications are specified on the Applications node in the Deployment Workbench. The GUIDs are stored in the Applications.xml file. The MandatoryApplications property is a list of text values that can be any non-blank value. The MandatoryApplications property has a numeric suffix (for example, MandatoryApplications001 or MandatoryApplications002).

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB ZTI -
Value Description
application_guid The GUID specified by the Deployment Workbench for the application to be deployed to the target computer. The GUID corresponds to the application GUID stored in the Applications.xml file.
Example
[Settings] Priority=Default [Default] MandatoryApplications001={1D7DF331-47B7-472C-87B3-442597EC2F7D} MandatoryApplications002={9d2b8999-5e4d-4f3d-bb05-edaaf4fe5628} Administrators001=WOODGROVEBANK\NYC Help Desk Staff

Memory

The amount of memory installed on the target computer in megabytes. For example, the value 2038 indicates 2,038 MB (or 2 GB) of memory is installed on the target computer.

Note

This property is dynamically set by the MDT scripts and is not configured in CustomSettings.ini or the MDT DB. Treat this property as read only.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini
MDT DB ZTI -
Value Description
memory The amount of memory installed on the target computer in megabytes
Example
None

Model

The model of the target computer. The format for Model is undefined. Use this property to create a subsection that contains settings targeted to a specific computer model number for a specific computer manufacturer (most commonly in conjunction with the Make and Product properties).

Note

This property is dynamically set by MDT scripts and cannot have its value set in CustomSettings.ini or the MDT DB. Treat this property as read only. However, you can use this property within CustomSettings.ini or the MDT DB, as shown in the following examples, to aid in defining the configuration of the target computer.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini
MDT DB ZTI -
Value Description
model The model of the target computer
Example
[Settings] Priority=Make, Default [Default] [Dell Computer Corporation] Subsection=Dell-%Model% [Dell-Latitude D600] Packages001=XXX00009:Program9 Packages002=XXX0000A:Program10

NetLib

The protocol to be used to communicate with the computer running SQL Server specified in the SQLServer property.

Property configured by Property applies to
BootStrap.ini - LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
DBNMPNTW Use the named pipes protocol to communicate.
DBMSSOCN Use TCP/IP sockets to communicate.
Example
[Settings] Priority=Computers, Default [Default] ScanStateArgs=/v:5 /o /c LoadStateArgs=/v:5 /c /lac [Computers] SQLServer=NYC-SQL-01 SQLShare=SQL$ NetLib=DBNMPNTW Database=MDTDB Instance=SQLEnterprise2005 Table=Computers Parameters=SerialNumber, AssetTag ParameterCondition=OR

NewDomain

Indicates the type of a new domain: whether a new domain in a new forest, the root of a new tree in an existing forest, or a child of an existing domain.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
Child The new domain is a child of an existing domain.
Forest The new domain is the first domain in a new forest of domain trees.
Tree The new domain is the root of a new tree in an existing forest.
Example
[Settings] Priority=Default [Default] NewDomain=Tree

NewDomainDNSName

Specifies the required name of a new tree in an existing domain or when Setup installs a new forest of domains.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
name Specifies the required name of a new tree in an existing domain or when Setup installs a new forest of domains
Example
[Settings] Priority=Default [Default] NewDomainDNSName=newdom.WoodGroveBank.com

Order

The sorting order for the result set on a database query. The result set is based on the configuration settings of the Database, Table, SQLServer, Parameters, and ParameterCondition properties. More than one property can be provided to sort the results by more than one property.

For example, if Order=Sequence is specified in the CustomSettings.ini file, then an ORDER BY sequence clause is added to the query. Specifying Order=Make, Model adds an ORDER BY Make, Model clause to the query.

Property configured by Property applies to
BootStrap.ini - LTI -
CustomSettings.ini -
MDT DB ZTI -
Value Description
property1, property2, … Properties to define the sort order for the result set (where propertyn represents the properties in the sort criteria)
Example
[Settings] Priority=Computers, Default [Default] OSInstall=YES ScanStateArgs=/v:5 /o /c LoadStateArgs=/v:5 /c /lac [Computers] SQLServer=NYC-SQL-01 SQLShare=SQL$ NetLib=DBNMPNTW Database=MDTDB Instance=SQLEnterprise2005 Table=MakeModelSettings Parameters=SerialNumber, AssetTag ParameterCondition=OR Order=Make, Model

OrgName

The name of the organization that owns the target computer. This value is inserted into the appropriate configuration settings in Unattend.xml.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
org_name The name of the organization that owns the target computer
Example
[Settings] Priority=MACAddress, Default Properties=CustomProperty, ApplicationInstall [Default] OSInstall=YES ScanStateArgs=/v:5 /o /c LoadStateArgs=/v:5 /c /lac UserDataLocation=NONE CustomProperty=TRUE OrgName=Woodgrove Bank [00:0F:20:35:DE:AC] OSDNEWMACHINENAME=HPD530-1 ApplicationInstall=Custom FullName=Woodgrove Bank User [00:03:FF:FE:FF:FF] OSDNEWMACHINENAME=BVMXP ApplicationInstall=Minimum FullName=Woodgrove Bank Manager

OSArchitecture

The processor architecture type for the target operating system. This property is referenced during OEM deployments. Valid values are x86 and x64.

Note

This property is dynamically set by the MDT scripts and is not configured in CustomSettings.ini or the MDT DB. Treat this property as read only.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini
MDT DB ZTI
Value Description
x86 The processor architecture type for the operating system is 32 bit.
x64 The processor architecture type for the operating system is 64 bit.
Example
None

OSCurrentBuild

The build number of the currently running operating system.

Note

This property is dynamically set by the MDT scripts and is not configured in CustomSettings.ini or the MDT DB. Treat this property as read only.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini
MDT DB ZTI -
Value Description
7600 Windows 7
9600 Windows 8.1
Example
None

OSCurrentVersion

The version number of the currently running operating system.

Note

This property is dynamically set by the MDT scripts and is not configured in CustomSettings.ini or the MDT DB. Treat this property as read only.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini
MDT DB ZTI -
Value Description
version_number The operating system major version, minor version, and build numbers (major.minor.build). For example, 6.3.9600 would represent Windows 8.1.
Example
None

OSDAdapterxDescription

Specifies the name of the network connection as it appears in the Control Panel Network Connections item. The name can be between 0 and 255 characters in length.

This property is for LTI only. For the equivalent property for ZTI, see OSDAdapterxName.

Note

Thexin this properties name is a placeholder for a zero-based array that contains network adapter information, such as OSDAdapter0Description or OSDAdapter1Description.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini
MDT DB ZTI
Value Description
Description The name of the network connection as it appears in the Control Panel Network Connections item
Example
None

OSDAdapterxDNSDomain

Specifies the DNS domain name (DNS suffix) that will be assigned to the network connection. This property is for ZTI only. For LTI, see the OSDAdapterxDNSSuffix property.

Note

Thexin this properties name is a placeholder for a zero-based array that contains network adapter information, such as OSDAdapter0DNSDomain or OSDAdapter1DNSDomain.

Property configured by Property applies to
BootStrap.ini LTI
CustomSettings.ini -
MDT DB - ZTI -
Value Description
DNS_domain_name A DNS domain name (DNS suffix) that will be assigned to the network connection
Example
[Settings] Priority=Default [Default] OSDAdapter0DNSDomain=WoodGroveBank.com

OSDAdapterxDNSServerList

This is a comma-delimited list of DNS server IP addresses that will be assigned to the network connection.

Note

Thexin this properties name is a placeholder for a zero-based array that contains network adapter information, such as OSDAdapter0DNSServerList or OSDAdapter1DNSServerList.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
DNS_servers A comma-delimited list of DNS server IP addresses that will be assigned to the network connection
Example
[Settings] Priority=Default [Default] OSDAdapter0DNSServerList=192.168.0.254,192.168.100.254

OSDAdapterxDNSSuffix

A DNS suffix that will be assigned to the network connection. This property is for LTI only. For ZTI, see the OSDAdapterxDNSDomain property.

Note

Thexin this properties name is a placeholder for a zero-based array that contains network adapter information, such as OSDAdapter0DNSSuffix or OSDAdapter1DNSSuffix.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
DNS_suffix A DNS suffix that will be assigned to the network connection
Example
[Settings] Priority=Default [Default] OSDAdapter0DNSSuffix= WoodGroveBank.com

OSDAdapterxEnableDHCP

Specifies whether the network connection will be configured via DHCP.

Note

Thexin this properties name is a placeholder for a zero-based array that contains network adapter information, such as OSDAdapter0EnableDHCP or OSDAdapter1EnableDHCP.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
TRUE The network connection will be configured via DHCP.
FALSE The network connection will be configured with static configuration.
Example
[Settings] Priority=Default [Default] OSDAdapter0EnableDHCP=TRUE

OSDAdapterxEnableDNSRegistration

Specifies whether DNS registration is enabled on the network connection.

Note

Thexin this properties name is a placeholder for a zero-based array that contains network adapter information, such as OSDAdapter0EnableDNSRegistration or OSDAdapter1EnableDNSRegistration.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
TRUE Enables DNS registration
FALSE Disables DNS registration
Example
[Settings] Priority=Default [Default] OSDAdapter0EnableDNSRegistration=TRUE

OSDAdapterxEnableFullDNSRegistration

Specifies whether full DNS registration is enabled on the network connection.

Note

Thexin this properties name is a placeholder for a zero-based array that contains network adapter information, such as OSDAdapter0EnableFullDNSRegistration or OSDAdapter1EnableFullDNSRegistration.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
TRUE Enables full DNS registration
FALSE Disables full DNS registration
Example
[Settings] Priority=Default [Default] OSDAdapter0EnableFullDNSRegistration=TRUE

OSDAdapterxEnableLMHosts

Specifies whether LMHOSTS lookup is enabled on the network connection.

Note

Thexin this properties name is a placeholder for a zero-based array that contains network adapter information, such as OSDAdapter0EnableLMHosts or OSDAdapter1EnableLMHosts.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
TRUE Enables LMHOSTS lookup
FALSE Disables LMHOSTS lookup
Example
[Settings] Priority=Default [Default] OSDAdapter0EnableLMHosts=TRUE

OSDAdapterxEnableIPProtocolFiltering

This property specifies whether IP protocol filtering should be enabled on the network connection.

Thexin this property’s name is a placeholder for a zero-based array that contains network adapter information, such as OSDAdapter0EnableIPProtocolFiltering or OSDAdapter1EnableIPProtocolFiltering.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
TRUE Enables IP protocol filtering
FALSE Disables IP protocol filtering
Example
[Settings] Priority=Default [Default] OSDAdapter0EnableIPProtocolFiltering =TRUE

OSDAdapterxEnableTCPFiltering

Specifies whether TCP/IP filtering should be enabled on the network connection. This property is for ZTI only. For LTI, see the OSDAdapterxEnableTCPIPFiltering property.

Note

Thexin this property’s name is a placeholder for a zero-based array that contains network adapter information, such as OSDAdapter0EnableTCPFiltering or OSDAdapter1EnableTFiltering.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
TRUE Enables TCP/IP filtering
FALSE Disables TCP/IP filtering
Example
[Settings] Priority=Default [Default] OSDAdapter0EnableTCPFiltering=TRUE

OSDAdapterxEnableTCPIPFiltering

Specifies whether TCP/IP filtering should be enabled on the network connection. This property is for LTI only. For ZTI, see the OSDAdapterxEnableTCPFiltering property.

Note

Thexin this properties name is a placeholder for a zero-based array that contains network adapter information, such as OSDAdapter0EnableTCPIPFiltering or OSDAdapter1EnableTCPIPFiltering.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
TRUE Enables TCP/IP filtering
FALSE Disables TCP/IP filtering
Example
[Settings] Priority=Default [Default] OSDAdapter0EnableTCPIPFiltering=TRUE

OSDAdapterxEnableWINS

Specifies whether WINS will be enabled on the network connection.

Note

Thexin this properties name is a placeholder for a zero-based array that contains network adapter information, such as OSDAdapter0EnableWINS or OSDAdapter1EnableWINS.

Caution

This property value must be specified in uppercase letters so that the deployment scripts can properly read it.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
TRUE Enables WINS
FALSE Disables WINS
Example
[Settings] Priority=Default [Default] OSDAdapter0EnableWINS=TRUE OSDAdapter0WINSServerList=192.168.0.1,192.168.100.1

OSDAdapterxGatewayCostMetric

A comma-delimited list of Gateway Cost Metrics specified as either integers or the string "Automatic" (if empty, uses "Automatic") that will be configured on the connection.

Note

Thexin this properties name is a placeholder for a zero-based array that contains network adapter information, such as OSDAdapter0GatewayCostMetric or OSDAdapter1GatewayCostMetric.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
cost_metrics A comma-delimited list of Gateway Cost Metrics
Example
[Settings] Priority=Default [Default] OSDAdapter0GatewayCostMetrics=Automatic

OSDAdapterxGateways

A comma-delimited list of gateways to be assigned to the network connection.

Note

Thexin this properties name is a placeholder for a zero-based array that contains network adapter information, such as OSDAdapter0Gateways or OSDAdapter1Gateways.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
gateways A comma-delimited list of gateways
Example
[Settings] Priority=Default [Default] OSDAdapter0Gateways=192.168.0.1,192.168.100.1

OSDAdapterxIPAddressList

A comma-delimited list of IP addresses to be assigned to the network connection.

Note

Thexin this properties name is a placeholder for a zero-based array that contains network adapter information, such as OSDAdapter0IPAddressList or OSDAdapter1IPAddressList.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
IP_addresses A comma delimited list of IP addresses
Example
[Settings] Priority=Default [Default] OSDAdapter0IPAddressList=192.168.0.40,192.168.100.40 OSDAdapter0SubnetMask=255.255.255.0,255.255.255.0

OSDAdapterxIPProtocolFilterList

A comma-delimited list of IP protocol filters to be assigned to the network connection. This property can be configured using the CustomSettings.ini file or the MDT DB but not the Deployment Workbench. If using Configuration Manager it is also configurable using an Apply Network Settings task sequence step.

Note

Thexin this properties name is a placeholder for a zero-based array that contains network adapter information, such as OSDAdapter0IPProtocolFilterList or OSDAdapter1IPProtocolFilterList.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
protocol_filter_list A comma-delimited list of IP protocol filters
Example
[Settings] Priority=Default [Default] OSDAdapter0IPProtocolFilterList=a list of approved IP protocols

OSDAdapterxMacAddress

Assign the specified configuration settings to the network interface card that matches the specified MAC address.

Note

Thexin this properties name is a placeholder for a zero-based array that contains network adapter information, such as OSDAdapter0MacAddress or OSDAdapter1MacAddress.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
MAC_address Network adapter MAC address
Example
[Settings] Priority=Default [Default] OSDAdapter0MacAddress=00:0C:29:67:A3:6B

OSDAdapterxName

Assign the specified configuration settings to the network adapter that matches the specified name. This property is for ZTI only. For the equivalent property for LTI, see OSDAdapterxDescription.

Note

Thexin this properties name is a placeholder for a zero-based array that contains network adapter information, such as OSDAdapter0Name or OSDAdapter1Name.

Property configured by Property applies to
BootStrap.ini LTI
CustomSettings.ini -
MDT DB - ZTI -
Value Description
name Network adapter name
Example
[Settings] Priority=Default [Default] OSDAdapter0Name=3Com 3C920 Integrated Fast Ethernet Controller

OSDAdapterxSubnetMask

A comma-delimited list of IP subnet masks to be assigned to the network connection.

Note

Thexin this properties name is a placeholder for a zero-based array that contains network adapter information, such as OSDAdapter0SubnetMask or OSDAdapter1SubnetMask.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
subnet_masks A comma-delimited list of IP subnet masks
Example
[Settings] Priority=Default [Default] OSDAdapter0IPAddressList=192.168.0.40,192.168.100.40 OSDAdapter0SubnetMask=255.255.255.0,255.255.255.0

OSDAdapterxTCPFilterPortList

A comma-delimited list of TCP filter ports to be assigned to the network connection. This property can be configured using the CustomSettings.ini file or the MDT DB but not the Deployment Workbench. If using Configuration Manager it is also configurable using an Apply Network Settings task sequence step.

Note

Thexin this properties name is a placeholder for a zero-based array that contains network adapter information, such as OSDAdapter0TCPFilterPortList or OSDAdapter1TCPFilterPortList.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
port_list A comma-delimited list of TCP/IP filter ports
Example
[Settings] Priority=Default [Default] OSDAdapter0TCPFilterPortList=a list of approved TCP ports

OSDAdapterxTCPIPNetBiosOptions

Specifies the TCP/IP NetBIOS options to be assigned to the network connection.

Note

Thexin this properties name is a placeholder for a zero-based array that contains network adapter information, such as OSDAdapter0TCPIPNetBiosOptions or OSDAdapter1TCPIPNetBiosOptions.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
0 Disable IP forwarding.
1 Enable IP forwarding.
Example
[Settings] Priority=Default [Default] OSDAdapter0TCPIPNetBiosOptions=0

OSDAdapterxUDPFilterPortList

A comma-delimited list of User Datagram Protocol (UDP) filter ports to be assigned to the network connection. This property can be configured using the CustomSettings.ini file and the MDT DB but not the Deployment Workbench. If using Configuration Manager it is also configurable using an Apply Network Settings task sequence step.

Note

Thexin this properties name is a placeholder for a zero-based array that contains network adapter information, such as OSDAdapter0UDPFilterPortList or OSDAdapter1UDPFilterPortList.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
port_list A comma-delimited list of UDP filter ports
Example
[Settings] Priority=Default [Default] OSDAdapter0UDPFilterPortList=a list of approved UDP ports

OSDAdapterxWINSServerList

A two-element, comma-delimited list of WINS server IP addresses to be assigned to the network connection.

Note

Thexin this properties name is a placeholder for a zero-based array that contains network adapter information, such as OSDAdapter0WINSServerList or OSDAdapter1WINSServerList.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
WINS_server_list A comma-delimited list of WINS server IP addresses
Example
[Settings] Priority=Default [Default] OSDAdapter0EnableWINS=TRUE OSDAdapter0WINSServerList=192.168.0.1,192.168.100.1

OSDAdapterCount

Specifies the number of network connections that are to be configured.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
count The number of network adapters
Example
[Settings] Priority=Default [Default] OSDAdapterCount=1 OSDAdapter0EnableDHCP=FALSE OSDAdapter0IPAddressList=192.168.0.40,192.168.100.40 OSDAdapter0SubnetMask=255.255.255.0,255.255.255.0 OSDAdapter0Gateways=192.168.0.1,192.168.100.1 OSDAdapter0EnableWINS=TRUE OSDAdapter0WINSServerList=192.168.0.1,192.168.100.1 OSDAdapter0TCPIPNetBiosOptions=0 OSDAdapter0MacAddress=00:0C:29:67:A3:6B OSDAdapter0GatewayCostMetrics=Automatic OSDAdapter0EnableTCPIPFiltering=TRUE OSDAdapter0EnableLMHosts=TRUE OSDAdapter0EnableFullDNSRegistration=TRUE OSDAdapter0EnableDNSRegistration=TRUE OSDAdapter0DNSSuffix=WoodGroveBank.com

OSDAnswerFilePath

Specifies the path to the answer file to be used during OEM deployments.

Note

This property is dynamically set by the MDT scripts and is not configured in CustomSettings.ini or the MDT DB. Treat this property as read only.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini
MDT DB ZTI
Value Description
file_path Specifies the path to the answer file to be used during OEM deployments
Example
None

OSDBitLockerCreateRecoveryPassword

A Boolean value that indicates whether the process creates a recovery key for BitLocker. The key is used for recovering data encrypted on a BitLocker volume. This key is cryptographically equivalent to a startup key. If available, the recovery key decrypts the VMK, which, in turn, decrypts the FVEK.

Note

This property value must be specified in uppercase letters so that the deployment scripts can properly read it.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
AD A recovery key is created.
Not specified A recovery key is not created.
Example
[Settings] Priority=Default [Default] BDEInstallSuppress=NO BDEDriveLetter=S: BDEDriveSize=2000 OSDBitLockerMode=TPMKey OSDBitLockerCreateRecoveryPassword=AD OSDBitLockerStartupKeyDrive=C:

OSDBitLockerMode

The type of BitLocker installation to be performed. Protect the target computer using one of the following methods:

  • A TPM microcontroller

  • A TPM and an external startup key (using a key that is typically stored on a UFD)

  • A TPM and PIN

  • An external startup key

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
TPM Protect the computer with TPM only. The TPM is a microcontroller that stores keys, passwords, and digital certificates. The microcontroller is typically an integral part of the computer motherboard.
TPMKey Protect the computer with TPM and a startup key. Use this option to create a startup key and to save it on a UFD. The startup key must be present in the port each time the computer starts.
TPMPin Protect the computer with TPM and a pin. Use this option in conjunction with the BDEPin property.

Note:

This value is not valid when using ZTI.
Key Protect the computer with an external key (the recovery key) that can be stored in a folder, in AD DS, or printed.
Example
[Settings] Priority=Default [Default] BDEInstallSuppress=NO BDEDriveLetter=S: BDEDriveSize=2000 OSDBitLockerMode=TPM OSDBitLockerCreateRecoveryPassword=AD

OSDBitLockerRecoveryPassword

Instead of generating a random recovery password, the Enable BitLocker task sequence action uses the specified value as the recovery password. The value must be a valid numerical BitLocker recovery password.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
password A valid 48-digit password
Example
[Settings] Priority=Default [Default] BDEInstallSuppress=NO BDEDriveLetter=S: BDEDriveSize=2000 OSDBitLockerMode=TPMKey OSDBitLockerCreateRecoveryPassword=AD OSDBitLockerRecoveryPassword=621280128854709621167486709731081433315062587367 OSDBitLockerStartupKeyDrive=C:

OSDBitLockerStartupKey

Instead of generating a random startup key for the key management option Startup Key on USB only, the Enable BitLocker task sequence action uses the value as the startup key. The value must be a valid, Base64-encoded BitLocker startup key.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
startupkey Base64-encoded BitLocker startup key
Example
[Settings] Priority=Default [Default] BDEInstallSuppress=NO BDEDriveLetter=S: BDEDriveSize=2000 BDEInstall=KEY OSDBitLockerCreateRecoveryPassword=AD OSDBitLockerStartupKey=8F4922B8-2D8D-479E-B776-12629A361049

OSDBitLockerStartupKeyDrive

The location for storing the BitLocker recovery key and startup key.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
location The storage location for the recovery key and startup key (either local to the target computer or to a UNC that points to a shared network folder)
Example
[Settings] Priority=Default [Default] BDEInstallSuppress=NO BDEDriveLetter=S: BDEDriveSize=2000 OSDBitLockerMode=TPMKey OSDBitLocker CreateRecoveryPassword=AD OSDBitLockerStartupKeyDrive=C:

OSDBitLockerTargetDrive

Specifies the drive to be encrypted. The default drive is the drive that contains the operating system.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
drive The drive that is to be encrypted
Example
[Settings] Priority=Default [Default] BDEInstallSuppress=NO BDEDriveLetter=S: BDEDriveSize=2000 BDERecoveryPassword=TRUE OSDBitLockerMode=TPMKey OSDBitLockerCreateRecoveryPassword=AD OSDBitLockerTargetDrive=C:

OSDBitLockerWaitForEncryption

Specifies that the deployment process should not proceed until BitLocker has completed the encryption process for all specified drives. Specifying TRUE could dramatically increase the time required to complete the deployment process.

Caution

This property value must be specified in uppercase letters so that the deployment scripts can properly read it.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
TRUE Specifies that the deployment process should wait for drive encryption to finish
FALSE Specifies that the deployment process should not wait for drive encryption to finish
Example
[Settings] Priority=Default [Default] BDEInstallSuppress=NO BDEDriveLetter=S: BDEDriveSize=2000 OSDBitLockerMode=TPMKey OSDBitLockerStartupKeyDrive=C: OSDBitLockerCreateRecoveryPassword=AD OSDBitLockerWaitForEncryption=TRUE

OSDComputerName

The new computer name to assign to the target computer.

Note

This property can also be set within a task sequence using a customized Set Task Sequence Variable task sequence step.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
computer_name The new computer name to assign to the target computer
Example
[Default] OSDComputerName=%_SMSTSMachineName%

OSDDiskAlign

This property is used to pass a value to the align parameter of the create partition primary command in the DiskPart command. The align parameter is typically used with hardware RAID Logical Unit Number (LUN) arrays to improve performance when the logical units (LUs) are not cylinder aligned. The align parameter aligns a primary partition that is not cylinder aligned at the beginning of a disk and rounds the offset to the closest alignment boundary. For more information on the align parameter, see Create partition primary.

Note

This property can be used in conjunction with the OSDDiskOffset property to set the offset parameter for the create partition primary command in the DiskPart command. For more information, see the OSDDiskOffset property.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
alignment_value Specifies the number of kilobytes (KB) from the beginning of the disk to the closest alignment boundary.
Example
[Settings] Priority=Default [Default] OSDDiskAlign=1024 OSDDiskOffset=2048

OSDDiskIndex

Specifies the disk index that will be configured.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
disk_index Specifies the disk index that will be configured (The default value is 0.)
Example
[Settings] Priority=Default [Default] OSDDiskIndex=0

OSDDiskOffset

This property is used to pass a value to the offset parameter of the create partition primary command in the DiskPart command. For more information on the offset parameter, see Create partition primary.

This property can be used in conjunction with the OSDDiskAlign property to set the align parameter for the create partition primary command in the DiskPart command. For more information, see the OSDDiskAlign property.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
offset_value Specifies the byte offset at which to create the partition. For master boot record (MBR) disks, the offset rounds to the closest cylinder boundary.
Example
[Settings] Priority=Default [Default] OSDDiskAlign=1024 OSDDiskOffset=2048

OSDDiskPartBiosCompatibilityMode

This property specifies whether to disable cache alignment optimizations when partitioning the hard disk for compatibility with certain types of BIOS.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
TRUE Enables cache alignment optimizations when partitioning the hard disk for compatibility with certain types of BIOS
FALSE Disables cache alignment optimizations when partitioning the hard disk for compatibility with certain types of BIOS (This is the default value.)
Example
[Settings] Priority=Default [Default] OSDDiskPartBiosCompatibilityMode=TRUE

OSDImageCreator

Specifies the name of the installation account that will be used during OEM deployments.

Note

This property is dynamically set by the MDT scripts and is not configured in CustomSettings.ini or the MDT DB. Treat this property as read only.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini
MDT DB ZTI -
Value Description
image_creator Specifies the name of the installation account that will be used during OEM deployments
Example
None

OSDImageIndex

Specifies the index of the image in the .wim file. This property is referenced during OEM deployments.

Note

This property is dynamically set by the MDT scripts and is not configured in CustomSettings.ini or the MDT DB. Treat this property as read only.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini
MDT DB ZTI -
Value Description
index Specifies the index of the image in the WIM file
Example
None

OSDImagePackageID

Specifies the package ID for the image to install during OEM deployments.

Note

This property is dynamically set by the MDT scripts and is not configured in CustomSettings.ini or the MDT DB. Treat this property as read only.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini
MDT DB ZTI -
Value Description
package_ID Specifies the package ID for the image to install during OEM deployments
Example
None

OSDInstallEditionIndex

Specifies the index of the image in the WIM file. This property is referenced during OEM deployments.

Note

This property is dynamically set by the MDT scripts and is not configured in CustomSettings.ini or the MDT DB. Treat this property as read only.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini
MDT DB ZTI -
Value Description
index Specifies the index of the image in the WIM file
Example
None

OSDInstallType

Specifies the installation type used for OEM deployments. The default is Sysprep.

Note

This property is dynamically set by the MDT scripts and is not configured in CustomSettings.ini or the MDT DB. Treat this property as read only.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini
MDT DB ZTI -
Value Description
install_type Specifies the installation type used for OEM deployments
Example
None

OSDisk

Specifies the drive used to install the operating system during OEM deployments. The default value is C:.

Note

This property is dynamically set by the MDT scripts and is not configured in CustomSettings.ini or the MDT DB. Treat this property as read only.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini
MDT DB ZTI -
Value Description
disk Specifies the drive used to install the operating system during OEM deployments
Example
None

OSDPartitions

Specifies the number of defined partitions configurations. The maximum number of partitions that can be configured is two. The default is None.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
partitions Specifies the number of defined partitions configurations
Example
[Settings] Priority=Default [Default] OSDPartitions=1 OSDPartitions0Bootable=TRUE OSDPartitions0FileSystem=NTFS OSDPartitions0QuickFormat=TRUE OSDPartitions0Size=60 OSDPartitions0SizeUnits=GB OSDPartitions0Type=Primary OSDPartitions0VolumeName=OSDisk OSDPartitions0VolumeLetterVariable=NewDrive1

OSDPartitionsxBootable

The partition at the specified index should be set bootable. The default first partition is set bootable.

Note

Thex in this properties name is a placeholder for a zero-based array that contains partition configurations.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
TRUE The partition should be set to bootable.
FALSE Do not set the partition to bootable.
Example
[Settings] Priority=Default [Default] OSDPartitions0Bootable=TRUE

OSDPartitionsxFileSystem

The type of file system for the partition at the specified index. Valid values are NTFS or FAT32.

Note

Thex in this properties name is a placeholder for a zero-based array that contains partition configurations.

Caution

This property value must be specified in uppercase letters so that the deployment scripts can properly read it.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
file_system The type of file system for the partition
Example
[Settings] Priority=Default [Default] OSDPartitions0FileSystem=NTFS

OSDPartitionsxQuickFormat

The partition at the specified index should be quick formatted. The default is TRUE.

Note

Thex in this properties name is a placeholder for a zero-based array that contains partition configurations.

Caution

This property value must be specified in uppercase letters so that the deployment scripts can properly read it.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
TRUE Quick-format the partition.
FALSE Do not quick-format the partition.
Example
[Settings] Priority=Default [Default] OSDPartitions0QuickFormat=TRUE

OSDPartitionsxSize

The size of the partition at the specified index.

Note

Thex in this properties name is a placeholder for a zero-based array that contains partition configurations.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
Size Partition size
Example
[Settings] Priority=Default [Default] OSDPartitions0Size=60 OSDPartitions0SizeUnits=GB

OSDPartitionsxSizeUnits

The units of measure used when specifying the size of the partition. Valid values are MB, GB, or %. The default value is MB.

Note

Thex in this properties name is a placeholder for a zero-based array that contains partition configurations.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
size_units The units of measure used when specifying the size of the partition
Example
[Settings] Priority=Default [Default] OSDPartitions0Size=60 OSDPartitions0SizeUnits=GB

OSDPartitionsxType

The type of partition to be created at the specified index.

Note

Thex in this properties name is a placeholder for a zero-based array that contains partition configurations.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
Primary Create a primary partition. This is the default value.
Logical Create a logical partition.
Extended Create an extended partition.
Example
[Settings] Priority=Default [Default] OSDPartitions0Type=Primary

OSDPartitionsxVolumeLetterVariable

The property that receives the drive letter that is assigned to the partition being managed.

Note

Thex in this properties name is a placeholder for a zero-based array that contains partition configurations.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
volume_letter_variable The name of the variable that will be assigned the drive letter of the partition being managed
Example
[Settings] Priority=Default [Default] OSDPartitions0VolumeLetterVariable=NewDrive1

OSDPartitionsxVolumeName

The volume name that will be assigned to the partition at the specified index.

Note

Thex in this properties name is a placeholder for a zero-based array that contains partition configurations.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
volume_name The volume name that will be assigned to the partition
Example
[Settings] Priority=Default [Default] OSDPartitions0VolumeName=OSDisk

OSDPreserveDriveLetter

This property is used to determine whether the Apply OS task sequence step should preserve the drive letter in the operating system image file (.wim file) being deployed to the target computer.

Note

This property should only be set in a task sequence step, not in the CustomSettings.ini file or in the MDT DB.

Property configured by Property applies to
BootStrap.ini LTI
CustomSettings.ini
MDT DB ZTI -
Value Description
TRUE The drive letters in the operating system image file (.wim file) and the operating system drives letters after deployment are identical to the drive letters in the .wim file.
FALSE The drive letters in the operating system image file (.wim file) are ignored, which allows the task sequence to override the driver letters in the .wim file.

Note:

For MDT, this value should always be selected.
Example
None

OSDStateStorePath

LTI and ZTI use this property to set the path where the user state migration data will be stored, which can be a UNC path, a local path, or a relative path.

Note

The OSDStateStorePath property takes precedence over the StatePath or UserDataLocation property when those properties are also specified.

In a Replace Computer deployment scenario in ZTI, the Restore User State task sequence step is skipped if the OSDStateStorePath property is set to a valid local or UNC path. The workaround is to set the USMTLocal property to TRUE. Doing so forces ZTI UserState.wsf to recognize the path in the OSDStateStorePath property. This is caused by the Request State Store task sequence step being skipped and the previous value in the OSDStateStorePath property being retained.

In a Replace Computer deployment scenario in ZTI, where user state migration data and the entire computer are being backed up, the Backup.wim file is stored in the folder specified in the OSDStateStorePath property. This may be caused by specifying the wrong value for the ComputerBackupLocation property.

For example, the following CustomSettings.ini file will cause the Backup.wim file to be stored in the same folder specified in the OSDStateStorePath property:

USMTLocal=True  
OSDStateStorePath=\\fs1\Share\Replace  

ComputerBackupLocation=NETWORK  
BackupShare=\\fs1\Share\ComputerBackup  
BackupDir=Client01  
Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
Path The path where the user state migration data will be stored, which can be a UNC path, a local path, or a relative path
Example
[Settings] Priority=Default [Default] USMTLocal=True OSDStateStorePath=\\fs1\Share\Replace ComputerBackupLocation=\\fs1\Share\ComputerBackup\Client01

OSDTargetSystemDrive

Specifies the drive where the operating system will be installed during OEM deployments.

Note

This property is dynamically set by the MDT scripts and is not configured in CustomSettings.ini or the MDT DB. Treat this property as read-only.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini
MDT DB ZTI
Value Description
system_drive Specifies the drive where the operating system will be installed during OEM deployments
Example
None

OSDTargetSystemRoot

Specifies the install path where the operating system will be installed during OEM deployments.

Note

This property is dynamically set by the MDT scripts and is not configured in CustomSettings.ini or the MDT DB. Treat this property as read only.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini
MDT DB ZTI
Value Description
system_root Specifies the install path where the operating system will be installed during OEM deployments
Example
None

OSFeatures

A comma-delimited list of server feature IDs that will be installed on the target computer.

Note

Not all features listed in the ServerManager.xml file are compatible with all server operating systems.

Caution

This property value must be specified in uppercase letters so that the deployment scripts can properly read it.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
ID1,ID2 The server features that are to be installed on the target computer. Valid values are located in the program_files\Microsoft Deployment Toolkit\Bin\ServerManager.xml file on the MDT server.
Example
[Settings] Priority=Default [Default] OSFeatures=CMAK,MSMQ-Multicasting,RSAT

OSInstall

Indicates whether the target computer is authorized to have the target operating system installed. If the OSInstall property is not listed, the default is to allow deployment of operating systems to any target computer.

Caution

This property value must be specified in uppercase letters so that the deployment scripts can properly read it.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
YES Deployment of an operating system to the target computer is authorized. This is the default value.
NO Deployment of an operating system to the target computer is not authorized.
Example
[Settings] Priority=Default [Default] OSInstall=YES

OSRoles

A comma-delimited list of server role IDs that will be installed on the target computer.

Note

Not all roles are compatible with all server operating systems.

Caution

This property value must be specified in uppercase letters so that the deployment scripts can properly read it.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
ID1,ID2 The server role that is to be installed on the target computer.

See “C:\Program Files\Microsoft Deployment Toolkit\Bin\ServerManager.xml” for valid ID values.

Example
[Settings] Priority=Default [Default] OSRoles=ADDS

OSRoleServices

A comma-delimited list of server role service IDs that will be installed on the target computer.

Note

Not all server role service IDs are compatible with all server operating systems.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
ID The server role service that will be installed on the target computer. The valid value is:

- ADDS-Domain-Controller
Example
[Settings] Priority=Default [Default] OSRoleServices=ADDS-Domain-Controller

OSSKU

The edition of the currently running operating system. The operating system edition is determined by using the OperatingSystemSKU property of the Win32_OperatingSystem WMI class. For a list of the editions the OperatingSystemSKU property returns, see the section, "OperatingSystemSKU," at Win32_OperatingSystem class.

Note

This property is dynamically set by the MDT scripts and is not configured in CustomSettings.ini or the MDT DB. Treat this property as read only.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini
MDT DB ZTI -
Value Description
edition The operating system edition. For example, "BUSINESS" for a Business edition of an operating system or "ENTERPRISE" for an Enterprise edition of an operating system.
Example
None

OSVersion

The version of the currently running operating system. This property should only be used to detect if the currently running operating system is Windows PE. Use the OSVersionNumber property to detect other operating systems.

Note

This property is dynamically set by the MDT scripts and is not configured in CustomSettings.ini or the MDT DB. Treat this property as read only.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini
MDT DB ZTI -
Value Description
WinPE Windows PE
2008R2 Windows Server 2008 R2
Win7Client Windows 7
Other Operating systems other than those listed, including Windows 8 and Windows Server 2012
Example
None

OSVersionNumber

The operating system major and minor version number. This property is referenced during OEM deployments.

Note

This property is dynamically set by the MDT scripts and is not configured in CustomSettings.ini or the MDT DB. Treat this property as read only.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini
MDT DB ZTI -
Value Description
version_number The operating system major and minor version number
Example
None

OverrideProductKey

The Multiple Activation Key (MAK) string to be applied after the target operating is deployed to the target computer. The value specified in this property is used by the ZTILicensing.wsf script during the State Restore Phase to apply the MAK to the target operating system. The script also configures the volume licensing image to use MAK activation instead of Key Management Service (KMS). The operating system needs to be activated with Microsoft after the MAK is applied. This is used when the target computer is unable to access a server that is running KMS.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
MAK The MAK string to be provided to the target operating system
Example
[Settings] Priority=Default [Default] ProductKey=AAAAA-BBBBB-CCCCC-DDDDD-EEEEE-FFFFF OverrideProductKey=AAAAA-BBBBB-CCCCC-DDDDD-EEEEE-FFFFF

PackageGroup

A list of text values that associates operating system packages with each other (typically based on the type of operating system package). An operating system package can be associated with one or more package groups. The PackageGroup property allows the operating system packages within one or more groups to be deployed to a target computer.

The text values in the list can be any non-blank value. The PackageGroup property value has a numeric suffix (for example, PackageGroup001 or PackageGroup002). After it is defined, a package group is associated with a computer. A computer can be associated with more than one package group.

Note

Operating system packages are created on the OS Packages node in the Deployment Workbench.

Note

The PackageGroup property can be specified in the format PackageGroup1=Updates or PackageGroup001=Updates.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB ZTI
Value Description
package_group_name Name of the package group to be deployed to the target computer
Example
[Settings] Priority=Default [Default] PackageGroup001=Updates

Packages

The list of Configuration Manager packages to be deployed to the target computer. The Packages property has a numeric suffix (for example, Packages001 or Packages002).

Note

The PackageGroup property can be specified in the format PackageGroup1=Updates or PackageGroup001=Updates.

Property configured by Property applies to
BootStrap.ini LTI
CustomSettings.ini -
MDT DB - ZTI -
Value Description
package_id:program_name Name of the package to be deployed to the target computer
Example
[Settings] Priority=Default [Default] Packages001=NYC00010:Install Packages002=NYC00011:Install

PackageSelectionProfile

Profile name used during package installation.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
profile_name Profile name used during package installation
Example
[Settings] Priority=Default [Default] PackageSelectionProfile=CoreApplications

Parameters

The parameters to be passed to a database query that returns property values from columns in the table specified in the Table property. The table is located in the database specified in the Database property on the computer specified in the SQLServer property. The instance of SQL Server on the computer is specified in the Instance property.

Property configured by Property applies to
BootStrap.ini - LTI -
CustomSettings.ini -
MDT DB ZTI -
Value Description
parameter1, parameter2 The list of parameters to pass to the database query
Example
[Settings] Priority=Computers, Default [Default] OSInstall=YES [Computers] SQLServer=NYC-SQL-01 SQLShare=SQL$ Database=MDTDB Instance=SQLEnterprise2005 Table=Computers Parameters=SerialNumber, AssetTag ParameterCondition=OR

ParameterCondition

Indicator of whether a Boolean AND or OR operation is performed on the properties listed in the Parameters property.

Caution

This property value must be specified in uppercase letters so that the deployment scripts can properly read it.

Property configured by Property applies to
BootStrap.ini - LTI -
CustomSettings.ini -
MDT DB ZTI -
Value Description
AND A Boolean AND operation is performed on the properties listed in the Parameters property. Only results that match all properties specified in the Parameters property are returned. This is the default value.
OR A Boolean OR operation is performed on the properties listed in the Parameters property. Results that match any property specified in the Parameters property are returned.
Example
[Settings] Priority=Computers, Default [Default] OSInstall=YES [Computers] SQLServer=NYC-SQL-01 SQLShare=SQL$ Database=MDTDB Instance=SQLEnterprise2005 Table=Computers Parameters=SerialNumber, AssetTag ParameterCondition=OR

ParentDomainDNSName

Specifies the DNS domain name of an existing directory service domain when installing a child domain.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
name Specifies the DNS domain name of an existing directory service domain when installing a child domain
Example
[Settings] Priority=Default [Default] ParentDomainDNSName=WoodGroveBank.com

Password

Specifies the password for the user name (account credentials) to use for promoting the member server to a domain controller.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
password Specifies the password for the user name (account credentials) to use for promoting the member server to a domain controller
Example
[Settings] Priority=Default [Default] Password=<complex_password>

Phase

The current phase of the deployment process. The Task Sequencer uses these phases to determine which tasks must be completed.

Note

This property is dynamically set by the MDT scripts and is not configured in CustomSettings.ini or the MDT DB. Treat this property as read only.

Caution

This property value must be specified in uppercase letters so that the deployment scripts can properly read it.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini
MDT DB ZTI -
Value Description
VALIDATION Identifies that the target computer is capable of running the scripts necessary to complete the deployment process.
STATECAPTURE Saves any user state migration data before deploying the new target operating system.
PREINSTALL Completes any tasks that need to be done (such as creating new partitions) before the target operating system is deployed.
INSTALL Installs the target operating system on the target computer.
POSTINSTALL Completes 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 (such as installing updates or adding drivers).
STATERESTORE Restores the user state migration data saved during the State Capture Phase.
Example
None

Port

The number of the port that should be used when connecting to the SQL Server database instance that is used for querying property values from columns in the table specified in the Table property. The database resides on the computer specified in the SQLServer property. The instance of SQL Server on the computer is specified in the Instance property. The port used during connection is specified in the Port property.

Property configured by Property applies to
BootStrap.ini - LTI -
CustomSettings.ini -
MDT DB ZTI -
Value Description
port The number of the port used when connecting to SQL Server
Example
[Settings] Priority=Computers, Default [Default] OSInstall=YES [Computers] SQLServer=NYC-SQL-01 Database=MDTDB Instance=MDT2010 Port=1433 Table=Computers Parameters=SerialNumber, AssetTag ParameterCondition=OR

PowerUsers

A list of user accounts and domain groups to be added to the local Power Users group on the target computer. The PowerUsers property is a list of text values that can be any non-blank value. The PowerUsers property has a numeric suffix (for example, PowerUsers1 or PowerUsers2).

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
name Name of the user or group to be added to the local Power Users group
Example
[Settings] Priority=Default [Default] Administrators001=WOODGROVEBANK\NYC Help Desk Staff PowerUsers001=WOODGROVEBANK\User01 PowerUsers002=WOODGROVEBANK\User02

PrepareWinRE

This property specifies if the LiteTouchPE.wim file, which includes Windows RE and optionally DaRT, is applied to the system drive as the recovery partition. This allows the target computer to use the LiteTouchPE.wim image to perform recovery tasks. DaRT may optionally be included in the image, which makes DaRT recovery features available on the target computer.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB ZTI
Value Description
YES The LiteTouchPE.wim file, which includes Windows RE and optionally DaRT, is applied to the system drive as the recovery partition.
any other value The LiteTouchPE.wim file, which includes Windows RE and optionally DaRT, is not applied to the system drive as the recovery partition. This is the default value.
Example
[Settings] Priority=Default [Default] PrepareWinRE=YES

Priority

The reserved property that determines the sequence for finding configuration values. The Priority reserved property lists each section to be searched and the order in which the sections are searched. When a property value is found, the ZTIGather.wsf script quits searching for the property, and the remaining sections are not scanned for that property.

Property configured by Property applies to
BootStrap.ini - LTI -
CustomSettings.ini -
MDT DB ZTI -
Value Description
section1, section2 The sections to be searched in the order they are to be searched
Example
[Settings] Priority=MACAddress, Default [Default] UserDataLocation=NONE CustomProperty=TRUE [00:0F:20:35:DE:AC] OSDNEWMACHINENAME=HPD530-1 [00:03:FF:FE:FF:FF] OSDNEWMACHINENAME=BVMXP

ProcessorSpeed

The speed of the processor installed on the target computer in MHz. For example, the value 1995 indicates the processor on the target computer is running at 1,995 MHz or 2 gigahertz.

Note

This property is dynamically set by the MDT scripts and is not configured in CustomSettings.ini or the MDT DB. Treat this property as read only.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini
MDT DB ZTI -
Value Description
processor_speed The speed of the processor on the target computer in megahertz
Example
None

Product

The product name of the target computer. With some computer vendors, the make and model might not be sufficiently unique to identify the characteristics of a particular configuration (for example, hyperthreaded or non-hyperthreaded chipsets). The Product property can help to differentiate.

The format for Product is undefined. Use this property to create a subsection that contains settings targeted to a specific product name for a specific computer model number for a specific computer manufacturer (most commonly in conjunction with the Make and Model properties).

Note

This property is dynamically set by the MDT scripts and is not configured in CustomSettings.ini or the MDT DB. Treat this property as read only.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini
MDT DB ZTI -
Value Description
product The product name of the target computer
Example
None

ProductKey

The product key string to be configured for the target computer. Before the target operating system is deployed, the product key specified is automatically inserted into the appropriate location in Unattend.xml.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
product_key The product key to be assigned to the target computer
Example
[Settings] Priority=Default [Default] ProductKey=AAAAA-BBBBB-CCCCC-DDDDD-EEEEE-FFFFF

Properties

A reserved property that defines any custom, user-defined properties. These user-defined properties are located by the ZTIGather.wsf script in the CustomSettings.ini file, BootStrap.ini file, or the MDT DB. These properties are additions to the predefined properties in MDT.

Property configured by Property applies to
BootStrap.ini - LTI -
CustomSettings.ini -
MDT DB ZTI -
Value Description
custom_property1,custom_property2 Custom, user-defined properties to be resolved
Example
[Settings] Priority=MACAddress, Default Properties=CustomProperty, ApplicationInstall [Default] OSInstall=YES ScanStateArgs=/v:5 /o /c LoadStateArgs=/v:5 /c /lac UserDataLocation=NONE CustomProperty=TRUE [00:0F:20:35:DE:AC] OSDNEWMACHINENAME=HPD530-1 ApplicationInstall=Custom [00:03:FF:FE:FF:FF] OSDNEWMACHINENAME=BVMXP ApplicationInstall=Minimum

ReplicaDomainDNSName

Specifies the DNS domain name of the domain to replicate.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
name Specifies the DNS domain name of the domain to replicate
Example
[Settings] Priority=Default [Default] ReplicaDomainDNSName=WoodGroveBank.com

ReplicaOrNewDomain

Specifies whether to install a new domain controller as the first domain controller in a new directory service domain or to install it as a replica directory service domain controller.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
Replica Installs the new domain controller as a replica directory service domain controller.
Domain Installs the new domain controller as the first domain controller in a new directory service domain. You must specify the TreeOrChild entry with a valid value.
Example
[Settings] Priority=Default [Default] ReplicaOrNewDomain=Domain

ReplicationSourceDC

Indicates the full DNS name of the domain controller from which you replicate the domain information.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
name Indicates the full DNS name of the domain controller from which you replicate the domain information
Example
[Settings] Priority=Default [Default] ReplicationSourceDC=dc01.WoodGroveBank.com

ResourceDrive

The drive letter mapped to the ResourceRoot property for the ZTIDrivers.wsf and ZTIPatches.wsf scripts to use to install drivers and patches to the target computer.

Note

This property is dynamically set by the MDT scripts and is not configured in CustomSettings.ini or the MDT DB. Treat this property as read only.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini
MDT DB ZTI -
Value Description
drive_letter The letter designation for the logical drive that contains the resources
Example
None

ResourceRoot

The value of this property is used by the ZTIDrivers.wsf and ZTIPatches.wsf scripts to install drivers and patches to the target computer.

Note

For LTI, the scripts automatically set the ResourceRoot property to be the same as the DeployRoot property. For ZTI, the values in the DeployRoot and ResourceRoot properties can be unique.

Property configured by Property applies to
BootStrap.ini - LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
UNC_path The UNC path to the shared folder that contains the resources
Example
[Settings] Priority=Default [Default] DeployRoot=\\NYC-AM-FIL-01\Distribution$ ResourceDrive=R: ResourceRoot=\\NYC-AM-FIL-01\Resource$ UserDataLocation=NONE

Role

The purpose of a computer based on the tasks performed by the user on the target computer. The Role property lists text values that can be any non-blank value. The Role property value has a numeric suffix (for example, Role1 or Role2). When defined, a role is associated with a computer. A computer can perform more than one role.

Typically, the value for the Role property is set by performing a database query in the MDT DB. The Deployment Workbench can assist in creating the role and property settings associated with the role, and then the Deployment Workbench can configure CustomSettings.ini to perform the database query for the Role property and the property settings associated with the role.

Property configured by Property applies to
BootStrap.ini - LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
Role The roles to be assigned to an individual computer or a group of computers
Example 1
[Settings] Priority=RoleSettings, Default [Default] SkipCapture=NO UserDataLocation=AUTO DeployRoot=\\W2K3-SP1\Distribution$ OSInstall=YES ScanStateArgs=/v:15 /o /c LoadStateArgs=/v:7 /c [RoleSettings] SQLServer=w2k3-sp1 Instance=MDT2010 Database=MDTDB Netlib=DBNMPNTW SQLShare=SQL_Share Table=RoleSettings Parameters=Role
Example 2
[Settings] Priority=RoleSettings, Default [Default] SkipCapture=NO UserDataLocation=AUTO DeployRoot=\\W2K3-SP1\Distribution$ OSInstall=YES Role1=Teller Role2=Woodgrove User [RoleSettings] SQLServer=w2k3-sp1 Instance=MDT2010 Database=MDTDB Netlib=DBNMPNTW SQLShare=SQL_Share Table=RoleSettings Parameters=Role

SafeModeAdminPassword

Supplies the password for the administrator account when starting the computer in Safe mode or a variant of Safe mode, such as Directory Services Restore mode.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
password Supplies the password for the administrator account when starting the computer in Safe mode or a variant of Safe mode, such as Directory Services Restore mode
Example
[Settings] Priority=Default [Default] SafeModeAdminPassword=<complex_password>

ScanStateArgs

Arguments passed to the USMT Scanstate process. The scripts call Scanstate.exe, and then insert the appropriate logging, progress, and state store parameters. If this value is not included in the settings file, the user state backup process is skipped.

Note

Use the USMTMigFiles property to specify the .xml files to be used by Scanstate.exe instead of using the /I parameter in the ScanStateArgs property. This prevents the ZTIUserState.wsf script from potentially duplicating the same list of .xml files.

Note

Do not add any of the following command line arguments when configuring this property: /hardlink, /nocompress, /encrypt, /key, or /keyfile. The MDT scripts will add these command-line arguments if applicable to the current deployment scenario.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
arguments The command-line arguments passed to Scanstate.exe.

The default arguments specified by the Deployment Workbench are as follows:

- /v. Enables verbose output in the Scanstate log. The default is 0. Specify any number from 0 to 15. The value 5 enables verbose and status output.

- /o. Overwrites any existing data in the store. If not specified, Scanstate will fail if the store already contains data. This option cannot be specified more than once in a Command Prompt window.

- /c. When specified, Scanstate will continue to run even if there are nonfatal errors. Without the /c option, Scanstate exits on the first error.

For more information about these and other arguments, see the USMT Help files.
Example
[Settings] Priority=Default [Default] ScanStateArgs=/v:5 /o /c LoadStateArgs=/v:5 /c /lac DeployRoot=\\NYC-AM-FIL-01\Distribution$ ResourceRoot=\\NYC-AM-FIL-01\Resource$ UDShare=\\NYC-AM-FIL-01\MigData$ UDDir=%OSDComputerName%

SerialNumber

The serial number of the target computer. The format for serial numbers is undefined. Use this property to create a subsection that contains settings targeted to a specific computer.

Note

This property is dynamically set by the MDT scripts and is not configured in CustomSettings.ini or the MDT DB. Treat this property as read only.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini
MDT DB ZTI -
Value Description
serial_number The format of the serial number is undefined and is determined by the serial number standard of each computer manufacturer.
Example
None

SiteName

Specifies the name of an existing site where you can place the new domain controller.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
name Specifies the name of an existing site where you can place the new domain controller
Example
[Settings] Priority=Default [Default] SiteName=FirstSite

SkipAdminAccounts

Indicates whether the Local Administrators wizard page is skipped.

Note

This default value for this property is YES, which means that the Local Administrators wizard page will be skipped by default. To display this wizard page, you must specifically set the value of this property to NO in CustomSettings.ini or in the MDT DB.

For other properties that must be configured when this property is set to YES, see Providing Properties for Skipped Deployment Wizard Pages.

Caution

This property value must be specified in uppercase letters so that the deployment scripts can properly read it.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
YES Wizard page is not displayed, and the information on that page is not collected. This is the default value.
NO Wizard page is displayed, and the information on that page is collected.
Example
[Settings] Priority=Default [Default] SkipWizard=NO SkipCapture=NO SkipAdminAccounts=NO SkipAdminPassword=NO SkipApplications=NO SkipComputerBackup=NO SkipDomainMembership=NO SkipUserData=NO SkipPackageDisplay=NO SkipLocaleSelection=NO SkipProductKey=YES

SkipAdminPassword

Indicates whether the Administrator Password wizard page is skipped.

For other properties that must be configured when this property is set to YES, see Providing Properties for Skipped Deployment Wizard Pages.

Caution

This property value must be specified in uppercase letters so that the deployment scripts can properly read it.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
YES Wizard page is not displayed, and the information on that page is not collected.
NO Wizard page is displayed, and the information on that page is collected. This is the default value.
Example
[Settings] Priority=Default [Default] SkipWizard=NO SkipCapture=NO SkipAdminPassword=YES SkipApplications=NO SkipComputerBackup=NO SkipDomainMembership=NO SkipUserData=NO SkipPackageDisplay=NO SkipLocaleSelection=NO SkipProductKey=YES

SkipApplications

Indicates whether the Select one or more applications to install wizard page is skipped.

For other properties that must be configured when this property is set to YES, see Providing Properties for Skipped Deployment Wizard Pages.

Caution

This property value must be specified in uppercase letters so that the deployment scripts can properly read it.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
YES Wizard page is not displayed, and the information on that page is not collected.
NO Wizard page is displayed, and the information on that page is collected. This is the default value.
Example
[Settings] Priority=Default [Default] SkipWizard=NO SkipCapture=NO SkipAdminPassword=NO SkipApplications=YES SkipComputerBackup=NO SkipDomainMembership=NO SkipUserData=NO SkipPackageDisplay=NO SkipLocaleSelection=NO SkipProductKey=YES

SkipBDDWelcome

Indicates whether the Welcome to Windows Deployment wizard page is skipped.

For other properties that must be configured when this property is set to YES, see Providing Properties for Skipped Deployment Wizard Pages.

Note

For this property to function properly it must be configured in both CustomSettings.ini and BootStrap.ini. BootStrap.ini is processed before a deployment share (which contains CustomSettings.ini) has been selected.

Caution

This property value must be specified in uppercase letters so that the deployment scripts can properly read it.

Property configured by Property applies to
BootStrap.ini - LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
YES Wizard page is not displayed, and the information on that page is not collected.
NO Wizard page is displayed, and the information on that page is collected. This is the default value.
Example
[Settings] Priority=Default [Default] SkipWizard=NO SkipCapture=NO SkipAdminPassword=YES SkipApplications=NO SkipBDDWelcome=YES SkipComputerBackup=NO SkipDomainMembership=NO SkipUserData=NO SkipPackageDisplay=NO SkipLocaleSelection=NO SkipProductKey=YES

SkipBitLocker

Indicates whether the Specify the BitLocker configuration wizard page is skipped.

For other properties that must be configured when this property is set to YES, see Providing Properties for Skipped Deployment Wizard Pages.

Caution

This property value must be specified in uppercase letters so that the deployment scripts can properly read it.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
YES Wizard page is not displayed, and the information on that page is not collected.
NO Wizard page is displayed, and the information on that page is collected. This is the default value.
Example
[Settings] Priority=Default [Default] SkipWizard=NO SkipCapture=NO SkipApplications=NO SkipBDDWelcome=YES SkipBitLocker=YES SkipComputerBackup=NO SkipDomainMembership=NO SkipUserData=NO SkipPackageDisplay=NO SkipLocaleSelection=NO

SkipBuild

Indicates whether the Select a task sequence to execute on this computer wizard page is skipped.

For other properties that must be configured when this property is set to YES, see Providing Properties for Skipped Deployment Wizard Pages.

This property value must be specified in uppercase letters so that the deployment scripts can properly read it.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
YES Wizard page is not displayed, and the information on that page is not collected.
NO Wizard page is displayed, and the information on that page is collected. This is the default value.
Example
[Settings] Priority=Default [Default] SkipWizard=NO SkipCapture=NO SkipAdminPassword=YES SkipApplications=NO SkipBDDWelcome=YES SkipBuild=YES SkipComputerBackup=NO SkipComputerName=NO SkipDomainMembership=NO SkipFinalSummary=NO SkipSummary=NO SkipUserData=NO SkipPackageDisplay=NO SkipLocaleSelection=NO

SkipCapture

Indicates whether the Specify whether to capture an image wizard page is skipped.

For other properties that must be configured when this property is set to YES, see Providing Properties for Skipped Deployment Wizard Pages.

Caution

This property value must be specified in uppercase letters so that the deployment scripts can properly read it.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
YES The wizard page is not displayed, and the information on that page is not collected.
NO The wizard page is displayed, and the information on that page is collected. This is the default value.
Example
[Settings] Priority=Default [Default] SkipWizard=NO SkipCapture=YES SkipApplications=NO SkipComputerBackup=NO SkipDomainMembership=NO SkipUserData=NO SkipPackageDisplay=NO SkipLocaleSelection=NO

SkipComputerBackup

Indicates whether the Specify where to save a complete computer backup wizard page is skipped.

For other properties that must be configured when this property is set to YES, see Providing Properties for Skipped Deployment Wizard Pages.

Caution

This property value must be specified in uppercase letters so that the deployment scripts can properly read it.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
YES The wizard page is not displayed, and the information on that page is not collected.
NO The wizard page is displayed, and the information on that page is collected. This is the default value.
Example
[Settings] Priority=Default [Default] SkipWizard=NO SkipCapture=NO SkipAdminPassword=NO SkipApplications=NO SkipComputerBackup=YES SkipDomainMembership=NO SkipUserData=NO SkipPackageDisplay=NO SkipLocaleSelection=NO

SkipComputerName

Indicates whether the Configure the computer name wizard page is skipped.

For other properties that must be configured when this property is set to YES, see Providing Properties for Skipped Deployment Wizard Pages.

Caution

This property value must be specified in uppercase letters so that the deployment scripts can properly read it.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
YES Wizard page is not displayed, and the information on that page is not collected.
NO Wizard page is displayed, and the information on that page is collected. This is the default value.
Example
[Settings] Priority=Default [Default] SkipWizard=NO SkipCapture=NO SkipAdminPassword=NO SkipApplications=NO SkipComputerBackup=NO SkipComputerName=YES SkipDomainMembership=NO SkipUserData=NO SkipPackageDisplay=NO SkipLocaleSelection=NO

SkipDomainMembership

Indicates whether the Join the computer to a domain or workgroup wizard page is skipped.

For other properties that must be configured when this property is set to YES, see Providing Properties for Skipped Deployment Wizard Pages.

Caution

This property value must be specified in uppercase letters so that the deployment scripts can properly read it.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
YES The wizard page is not displayed, and the information on that page is not collected.
NO The wizard page is displayed, and the information on that page is collected. This is the default value.
Example
[Settings] Priority=Default [Default] SkipWizard=NO SkipCapture=NO SkipAdminPassword=NO SkipApplications=NO SkipComputerBackup=NO SkipUserData=NO SkipPackageDisplay=NO SkipLocaleSelection=NO SkipDomainMembership=NO

SkipFinalSummary

Indicates whether the Operating system deployment completed successfully wizard page is skipped.

For other properties that must be configured when this property is set to YES, see Providing Properties for Skipped Deployment Wizard Pages.

Note

This property value must be specified in uppercase letters so that the deployment scripts can properly read it.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
YES The wizard page is not displayed, and the information on that page is not collected.
NO The wizard page is displayed, and the information on that page is collected. This is the default value.
Example
[Settings] Priority=Default [Default] SkipWizard=NO SkipCapture=NO SkipApplications=NO SkipBDDWelcome=YES SkipComputerBackup=NO SkipComputerName=NO SkipDomainMembership=NO SkipFinalSummary=NO SkipUserData=NO SkipPackageDisplay=NO SkipLocaleSelection=NO SkipProductKey=YES

SkipGroupSubFolders

By default, when specifying folders to be included when injecting drivers, patches (packages), and so on, values are specified something like:

DriverGroup001=TopFolder\SecondFolder  
PackageGroup001=TopFolder\SecondFolder  

This would, by default, also include all sub-folders located under the "SecondFolder." If SkipGroupSubFolders is set to YES in CustomSettings.ini, this behavior will change so that the subfolders will be excluded and only the contents of "SecondFolder" will be added.

To exclude subfolders when matching against groups such as DriverGroup001, PackageGroup001, and so on, set SkipGroupSubFolders to YES.

Caution

This property value must be specified in uppercase letters so that the deployment scripts can properly read it.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
YES Do not include subfolders when matching against groups.
NO Include subfolders when matching against groups. This is the default behavior.
Example
[Settings] Priority=Default [Default] SkipGroupSubFolders=NO

SkipLocaleSelection

Indicates whether the Locale Selection wizard page is skipped.

For other properties that must be configured when this property is set to YES, see Providing Properties for Skipped Deployment Wizard Pages.

Caution

This property value must be specified in uppercase letters so that the deployment scripts can properly read it.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
YES The wizard page is not displayed, and the information on that page is not collected.
NO The wizard page is displayed, and the information on that page is collected. This is the default value.
Example
[Settings] Priority=Default [Default] SkipWizard=NO SkipCapture=NO SkipApplications=NO SkipComputerBackup=NO SkipDomainMembership=NO SkipUserData=NO SkipPackageDisplay=NO SkipLocaleSelection=NO

SkipPackageDisplay

Indicates whether the Packages wizard page is skipped.

For other properties that must be configured when this property is set to YES, see Providing Properties for Skipped Deployment Wizard Pages.

Caution

This property value must be specified in uppercase letters so that the deployment scripts can properly read it.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
YES The wizard page is not displayed, and the information on that page is not collected.
NO The wizard page is displayed, and the information on that page is collected. This is the default value.
Example
[Settings] Priority=Default [Default] SkipWizard=NO SkipCapture=NO SkipApplications=NO SkipComputerBackup=NO SkipDomainMembership=NO SkipUserData=NO SkipPackageDisplay=YES SkipLocaleSelection=NO

SkipProductKey

Indicates whether the Specify the product key needed to install this operating system wizard page is skipped.

For other properties that must be configured when this property is set to YES, see Providing Properties for Skipped Deployment Wizard Pages.

Caution

This property value must be specified in uppercase letters so that the deployment scripts can properly read it.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
YES The wizard page is not displayed, and the information on that page is not collected.
NO The wizard page is displayed, and the information on that page is collected. This is the default value.
Example
[Settings] Priority=Default [Default] SkipWizard=NO SkipCapture=NO SkipAdminPassword=YES SkipApplications=NO SkipComputerBackup=NO SkipDomainMembership=NO SkipUserData=NO SkipPackageDisplay=NO SkipLocaleSelection=NO SkipProductKey=YES

SkipRearm

This property is used to configure whether MDT rearms the Microsoft Office 2010 25-day activation grace period. If Microsoft Office 2010 is captured in a custom image, the user sees activation notification dialog boxes immediately after the image is deployed instead of 25-days after deployment.

By default, MDT rearms the Microsoft Office 2010 25-day activation grace period when running the LTISysprep.wsf script. You can set the value of this property to YES so that MDT skips the rearming of the Microsoft Office 2010 25-day activation grace period.

Caution

This property value must be specified in uppercase letters so that the deployment scripts can properly read it.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB ZTI
Value Description
YES MDT does not rearm the Microsoft Office 2010 25-day activation grace period.
NO MDT rearms the Microsoft Office 2010 25-day activation grace period. This is the default value.
Example
[Settings] Priority=Default [Default] OSInstall=Y SkipCapture=YES SkipAdminPassword=NO SkipProductKey=YES SkipRearm=YES DoCapture=YES

SkipRoles

Indicates whether the Roles and Features wizard page is skipped.

For other properties that must be configured when this property is set to YES, see Providing Properties for Skipped Deployment Wizard Pages.

Caution

This property value must be specified in uppercase letters so that the deployment scripts can properly read it.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
YES The wizard page is not displayed, and the information on that page is not collected.
NO The wizard page is displayed, and the information on that page is collected. This is the default value.
Example
[Settings] Priority=Default [Default] SkipWizard=NO SkipCapture=NO SkipAdminPassword=YES SkipApplications=NO SkipBDDWelcome=YES SkipTaskSequence=Yes SkipComputerBackup=NO SkipComputerName=NO SkipDomainMembership=NO SkipFinalSummary=NO SkipRoles=YES SkipSummary=NO SkipUserData=NO SkipPackageDisplay=NO SkipLocaleSelection=NO

SkipSummary

Indicates whether the Ready to begin wizard page is skipped.

For other properties that must be configured when this property is set to YES, see Providing Properties for Skipped Deployment Wizard Pages.

Caution

This property value must be specified in uppercase letters so that the deployment scripts can properly read it.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
YES The wizard page is not displayed, and the information on that page is not collected.
NO The wizard page is displayed, and the information on that page is collected. This is the default value.
Example
[Settings] Priority=Default [Default] SkipWizard=NO SkipCapture=NO SkipAdminPassword=YES SkipApplications=NO SkipBDDWelcome=YES SkipTaskSequence=Yes SkipComputerBackup=NO SkipComputerName=NO SkipDomainMembership=NO SkipFinalSummary=NO SkipSummary=NO SkipUserData=NO SkipPackageDisplay=NO SkipLocaleSelection=NO

SkipTaskSequence

Indicates whether the Select a task sequence to execute on this computer wizard page is skipped.

For other properties that must be configured when this property is set to YES, see Providing Properties for Skipped Deployment Wizard Pages.

Note

Specify the SkipBuild property when using the Deployment Workbench to configure the Deployment Wizard to skip the Select a task sequence to execute on this computer wizard page.

Caution

This property value must be specified in uppercase letters so that the deployment scripts can properly read it.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB ZTI
Value Description
YES The wizard page is not displayed, and the information on that page is not collected.
NO The wizard page is displayed, and the information on that page is collected. This is the default value.
Example
[Settings] Priority=Default [Default] SkipWizard=NO SkipCapture=NO SkipApplications=NO SkipBDDWelcome=YES SkipTaskSequence=NO SkipComputerBackup=NO SkipComputerName=NO SkipDomainMembership=NO SkipFinalSummary=NO SkipSummary=NO SkipUserData=NO SkipPackageDisplay=NO SkipLocaleSelection=NO

SkipTimeZone

Indicates whether the Set the Time Zone wizard page is skipped.

For other properties that must be configured when this property is set to YES, see Providing Properties for Skipped Deployment Wizard Pages.

Caution

This property value must be specified in uppercase letters so that the deployment scripts can properly read it.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
YES The wizard page is not displayed, and the information on that page is not collected.
NO The wizard page is displayed, and the information on that page is collected. This is the default value.
Example
[Settings] Priority=Default [Default] SkipWizard=NO SkipCapture=NO SkipAdminPassword=YES SkipApplications=NO SkipBDDWelcome=YES SkipTaskSequence=YES SkipComputerBackup=NO SkipComputerName=NO SkipDomainMembership=NO SkipFinalSummary=NO SkipSummary=NO SkipTimeZone=NO SkipUserData=NO SkipPackageDisplay=NO SkipLocaleSelection=NO

SkipUserData

Indicates whether the Specify whether to restore user data and Specify where to save your data and settings wizard page is skipped.

For other properties that must be configured when this property is set to YES, see Providing Properties for Skipped Deployment Wizard Pages.

Caution

This property value must be specified in uppercase letters so that the deployment scripts can properly read it.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
YES The wizard page is not displayed, and the information on that page is not collected.
NO The wizard page is displayed, and the information on that page is collected. This is the default value.
Example
[Settings] Priority=Default [Default] SkipWizard=NO SkipCapture=NO SkipAdminPassword=YES SkipApplications=NO SkipComputerBackup=NO SkipDomainMembership=NO SkipUserData=NO SkipPackageDisplay=NO SkipLocaleSelection=NO SkipProductKey=YES

SkipWizard

Indicates whether the entire Deployment Wizard is skipped.

For other properties that must be configured when this property is set to YES, see Providing Properties for Skipped Deployment Wizard Pages.

Caution

This property value must be specified in uppercase letters so that the deployment scripts can properly read it.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
YES The entire wizard is not displayed, and none of the information on the wizard pages is collected.
NO The wizard is displayed, and the information on the enabled wizard pages is collected. This is the default value.
Example
[Settings] Priority=Default [Default] SkipWizard=YES

SLShare

The network shared folder in which the deployment logs are stored at the end of the deployment process.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
shared_folder The name of the network shared folder in which script logs are stored
Example
[Settings] Priority=Default [Default] DeployRoot=\\NYC-AM-FIL-01\Distribution$ ResourceRoot=\\NYC-AM-FIL-01\Resource$ UDShare=\\NYC-AM-FIL-01\MigData$ UDDir=%OSDComputerName% SLShare=\\NYC-AM-FIL-01\Logs$ UDProfiles=Administrator, User-01, ExtranetUser UserDataLocation=NONE SkipCapture=NO SkipAdminPassword=YES SkipProductKey=YES

SLShareDynamicLogging

The network shared folder in which all MDT logs should be written during deployment. This is used for advanced real-time debugging only.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
shared_folder The name of the network shared folder in which script logs are stored
Example
[Settings] Priority=Default [Default] DeployRoot=\\NYC-AM-FIL-01\Distribution$ ResourceRoot=\\NYC-AM-FIL-01\Resource$ UDShare=\\NYC-AM-FIL-01\MigData$ UDDir=%OSDComputerName% SLShare=\\NYC-AM-FIL-01\Logs$ SLShareDynamicLogging=\\NYC-AM-FIL-01\Logs$ UDProfiles=Administrator, User-01, ExtranetUser UserDataLocation=NONE SkipCapture=NO SkipAdminPassword=YES SkipProductKey=YES

SMSTSAssignUserMode

Specifies whether user device affinity (UDA) should be enabled and whether approval is required. This property only works with the UDA feature in Configuration Manager.

Property configured by Property applies to
BootStrap.ini LTI
CustomSettings.ini -
MDT DB - ZTI -
Value Description
Auto The affinity between a user and the target device is established, and approval is automatically performed.
Pending The affinity between a user and the target device is established, and approval is submitted for Configuration Manager administrator approval.
Disable The affinity between a user and the target device is not established.
Example
[Settings] Priority=Default [Default] SMSTSAssignUserMode=Auto SMSTSUdaUsers=Fabrikam\Ken, Fabrikam\Pilar

SMSTSRunCommandLineUserName

Specifies the user name in Domain\User_Name format that should be used with a Run Command Line step that is configured to run as a user.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
user_name Specifies the user name in that should be used with a Run Command Line step
Example
[Settings] Priority=Default [Default] SMSTSRunCommandLineUserName=Fabrikam\Ken SMSTSRunCommandLineUserPassword=<complex_password>

SMSTSRunCommandLineUserPassword

Specifies the password that should be used with a Run Command Line step that is configured to run as a user.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
user_password Specifies the password that should be used with a Run Command Line step
Example
[Settings] Priority=Default [Default] SMSTSRunCommandLineUserName=Fabrikam\Ken SMSTSRunCommandLineUserPassword=<complex_password>

SMSTSUdaUsers

Specifies the users who will be assigned affinity with a specific device using the UDA feature, which is available only in Configuration Manager.

Property configured by Property applies to
BootStrap.ini LTI
CustomSettings.ini -
MDT DB - ZTI -
Value Description
user1, user2, … The comma-separated list of users in Domain\User_Name format that will be assigned affinity with the target device.

Note:

You can only use the NetBIOS domain name in this value, such as Fabrikam\Ken. You cannot use the fully qualified domain name (fabrikam.com\Ken) or the UPN notation (ken@fabrikam.com).
Example
[Settings] Priority=Default [Default] SMSTSAssignUserMode=Auto SMSTSUdaUsers=Fabrikam\Ken, Fabrikam\Pilar

SQLServer

The identity of the computer running SQL Server that performs a database query that returns property values from columns in the table specified in the Table property. The query is based on parameters specified in the Parameters and ParameterCondition properties. The instance of SQL Server on the computer is specified in the Instance property.

Property configured by Property applies to
BootStrap.ini - LTI -
CustomSettings.ini -
MDT DB ZTI -
Value Description
SQL_server The name of the computer running SQL Server
Example
[Settings] Priority=Computers, Default [Default] OSInstall=YES ScanStateArgs=/v:5 /o /c LoadStateArgs=/v:5 /c /lac [Computers] SQLServer=NYC-SQL-01 SQLShare=SQL$ Database=MDTDB Instance=SQLEnterprise2005 Table=Computers Parameters=SerialNumber, AssetTag ParameterCondition=OR

SQLShare

The name of a shared folder on the computer running SQL Server (specified by the SQLServer property). The credentials used for authentication are provided by the UserDomain, UserID, and UserPassword properties (for LTI and ZTI) or by the Configuration Manager Advanced Client account credentials (ZTI only).

Note

This property must be specified to perform Integrated Windows authentication. This is the recommended authentication method, rather than using the DBID and DBPwd properties (which support the SQL Server authentication method).

Property configured by Property applies to
BootStrap.ini - LTI -
CustomSettings.ini -
MDT DB ZTI -
Value Description
shared_folder The name of a shared folder on the computer running SQL Server
Example
[Settings] Priority=Computers, Default Properties=MyCustomProperty [Default] OSInstall=YES ScanStateArgs=/v:5 /o /c LoadStateArgs=/v:5 /c /lac [Computers] SQLServer=NYC-SQL-01 SQLShare=SQL$ Database=MDTDB Instance=MDT2010 Table=Computers Parameters=SerialNumber, AssetTag ParameterCondition=OR

StatePath

This property is used to set the path where the user state migration data will be stored, which can be a UNC path, a local path, or a relative path. The OSDStateStorePath property takes precedence over the StatePath or UserDataLocation property when those properties are also specified.

Note

This property is provided for backward compatibility with previous versions of MDT. Use the OSDStateStorePath property instead.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB ZTI
Value Description
Path The path where the user state migration data will be stored, which can be a UNC path, a local path, or a relative path
Example
[Settings] Priority=Default [Default] SitePath=\\fs1\Share\Replace ComputerBackupLocation=\\fs1\Share\ComputerBackup\Client01

StoredProcedure

The name of the stored procedure used when performing a database query that returns property values from columns in the table or view. The stored procedure is located in the database specified in the Database property. The computer running SQL Server is specified in the SQLServer property. The instance of SQL Server on the computer is specified in the Instance property. The name of the stored procedure is specified in the StoredProcedure property.

For more information about using a stored procedure to query a SQL Server database, see the section, "Deploying Applications Based on Earlier Application Versions", in the MDT document Microsoft Deployment Toolkit Samples Guide.

Property configured by Property applies to
BootStrap.ini - LTI -
CustomSettings.ini -
MDT DB ZTI -
Value Description
stored_procedure The name of the stored procedure used to query the SQL Server database
Example
[Settings] Priority=DynamicPackages, Default [Default] OSInstall=YES [DynamicPackages] SQLDefault=DB_DynamicPackages [DB_DynamicPackages] SQLServer=SERVER1 Database=MDTDB StoredProcedure=RetrievePackages Parameters=MacAddress SQLShare=Logs Instance=MDT2013 Port=1433 Netlib=DBNMPNTW

SupportsHyperVRole

Specifies whether the processor resources on the target computer can support the Hyper-V server role in Windows Server. This property is True if the value for the following properties is set to TRUE:

  • SupportsNX

  • SupportsVT

  • Supports64Bit

    Each of the previous properties is set using information from the CPUID interface. For further information collected about VMs and information returned from the CPUID interface, see the following properties:

  • IsHypervisorRunning

  • IsVM

  • SupportsNX

  • SupportsVT

  • Supports64Bit

  • VMPlatform

Note

This property is dynamically set by the MDT scripts and is not configured in CustomSettings.ini or the MDT DB. Treat this property as read only.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini
MDT DB ZTI -
Value Description
TRUE The processor resources of the target computer can support the Hyper-V server role in Windows Server.
FALSE The processor resources of the target computer cannot support the Hyper-V server role in Windows Server.
Example
None

SupportsNX

Specifies whether the processor resources on the target computer support the No Execute (NX) technology. The NX technology is used in processors to segregate areas of memory for use by either storage of processor instructions (code) or for storage of data. This property is set using information from the CPUID interface.

For further information collected about VMs and information returned from the CPUID interface, see the following properties:

  • IsHypervisorRunning

  • IsVM

  • SupportsHyperVRole

  • SupportsVT

  • Supports64Bit

  • VMPlatform

Note

This property is dynamically set by the MDT scripts and is not configured in CustomSettings.ini or the MDT DB. Treat this property as read only.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini
MDT DB ZTI -
Value Description
TRUE The processor resources of the target computer support NX technology.
FALSE The processor resources of the target computer do not support NX technology.
Example
None

SupportsVT

Specifies whether the processor resources on the target computer support the Virtualization Technology (VT) feature. VT is used to support current virtualized environments, such as Hyper-V. This property is set using information from the CPUID interface.

For further information collected about VMs and information returned from the CPUID interface, see the following properties:

  • IsHypervisorRunning

  • IsVM

  • SupportsHyperVRole

  • SupportsNX

  • Supports64Bit

  • VMPlatform

Note

This property is dynamically set by the MDT scripts and is not configured in CustomSettings.ini or the MDT DB. Treat this property as read only.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini
MDT DB ZTI -
Value Description
TRUE The processor resources of the target computer support VT technology.
FALSE The processor resources of the target computer do not support VT technology.
Example
None

Supports64Bit

Specifies whether the processor resources on the target computer support Windows 64-bit operating systems. Most modern virtualization environments require 64-bit processor architecture. This property is set using information from the CPUID interface.

For further information collected about VMs and information returned from the CPUID interface, see the following properties:

  • IsHypervisorRunning

  • IsVM

  • SupportsHyperVRole

  • SupportsNX

  • SupportsVT

  • VMPlatform

Note

This property is dynamically set by the MDT scripts and is not configured in CustomSettings.ini or the MDT DB. Treat this property as read only.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini
MDT DB ZTI -
Value Description
TRUE The processor resources of the target computer support a Windows 64-bit operating system.
FALSE The processor resources of the target computer do not support a Windows 64-bit operating system.
Example
None

SysVolPath

Specifies the fully qualified, non-UNC path to a directory on a fixed disk of the local computer.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
path Specifies the fully qualified, non-UNC path to a directory on a fixed disk of the local computer
Example
[Settings] Priority=Default [Default] SysVolPath=%DestinationLogicalDrive%\Windows\Sysvol

Table

The name of the table or view to be used in performing a database query that returns property values from columns in the table or view. The query is based on parameters specified in the Parameters and ParameterCondition properties. The table or view is located in the database specified in the Database property. The computer running SQL Server is specified in the SQLServer property. The instance of SQL Server on the computer is specified in the Instance property.

Property configured by Property applies to
BootStrap.ini - LTI -
CustomSettings.ini -
MDT DB ZTI -
Value Description
table_name The name of the table or view to be queried for property values
Example
[Settings] Priority=Computers, Default [Default] OSInstall=YES ScanStateArgs=/v:5 /o /c LoadStateArgs=/v:5 /c /lac [Computers] SQLServer=NYC-SQL-01 SQLShare=SQL$ Database=MDTDB Instance=MDT2010 Table=Computers Parameters=SerialNumber, AssetTag ParameterCondition=OR

TaskSequenceID

Identifies the operating system task sequence to be deployed to the target computer. The task sequence ID is created on the Task Sequences node in the Deployment Workbench. The TaskSequenceID property allows alphanumeric characters, hyphens (-), and underscores (_). The TaskSequenceID property cannot be blank or contain spaces.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
task_sequence_id Identifier of the operating system task sequence defined in the Deployment Workbench for the target operating system being deployed

Note:

Be sure to use the TaskSequenceID specified in the Deployment Workbench UI, not the GUID of the TaskSequenceID.
Example
[Settings] Priority=Default [Default] TaskSequenceID=BareMetal

TaskSequenceName

Specifies the name of the task sequence being run.

Note

This property is dynamically set by the MDT scripts and is not configured in CustomSettings.ini or the MDT DB. Treat this property as read only.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini
MDT DB ZTI
Value Description
task_sequence_name Name of the task sequence being run, such as Deploy Windows 8.1 to Reference Computer
Example
None

TaskSequenceVersion

Specifies the version of the task sequence being run.

Note

This property is dynamically set by the MDT scripts and is not configured in CustomSettings.ini or the MDT DB. Treat this property as read only.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini
MDT DB ZTI
Value Description
task_sequence_version Version of the task sequence being run, such as 1.00
Example
None

TimeZoneName

The time zone in which the target computer is located. This value is inserted into the appropriate configuration settings in Unattend.xml.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
time_zone_name The text value that indicates the time zone where the target computer is located
Example
[Settings] Priority=Default [Default] TimeZoneName=Pacific Standard Time DeployRoot=\\NYC-AM-FIL-01\Distribution$ ResourceRoot=\\NYC-AM-FIL-01\Resource$ UDShare=\\NYC-AM-FIL-01\MigData$ UDDir=%OSDComputerName% SLShare=\\NYC-AM-FIL-01\Logs$ UDProfiles=Administrator, User-01, ExtranetUser UserDataLocation=NONE

ToolRoot

Specifies the UNC path to the Tools\proc_arch folder (where proc_arch is the processor architecture of the currently running operating system and can have a value of x86 or x64), which is immediately beneath the root of the folder structure specified in the DeployRoot property. The Tools\proc_arch folder contains utilities that MDT uses during the deployment process.

Note

This property is dynamically set by the MDT scripts and is not configured in CustomSettings.ini or the MDT DB. Treat this property as read only.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini
MDT DB ZTI -
Value Description
path The UNC or local path to the Tools\proc_arch folder (where proc_arch is the processor architecture of the currently running operating system and can have a value of x86 or x64) immediately beneath the root of the folder structure specified by the DeployRoot property
Example
None

TPMOwnerPassword

The TPM password (also known as the TPM administration password) for the owner of the target computer. The password can be saved to a file or stored in AD DS.

Note

If the TPM ownership is already set or TPM ownership is not allowed, then the TPMOwnerPassword property is ignored. If the TPM password is needed and the TPMOwnerPassword property is not provided, the TPM password is set to the local Administrator password.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
password The TPM password for the owner of the target computer
Example
[Settings] Priority=Default [Default] BDEDriveLetter=S: BDEDriveSize=2000 BDEInstall=TPMKey BDERecoveryKey=TRUE BDEKeyLocation=C: TPMOwnerPassword=<complex_password> BackupShare=\\NYC-AM-FIL-01\Backup$ BackupDir=%OSDComputerName% DeployRoot=\\NYC-AM-FIL-01\Distribution$ ResourceRoot=\\NYC-AM-FIL-01\Resource$ UDShare=\\NYC-AM-FIL-01\MigData$ UDDir=%OSDComputerName%

UDDir

The folder in which the user state migration data is stored. This folder exists beneath the network shared folder specified in UDShare.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
folder The name of the folder that exists beneath the network shared folder
Example
[Settings] Priority=Default [Default] DeployRoot=\\NYC-AM-FIL-01\Distribution$ ResourceRoot=\\NYC-AM-FIL-01\Resource$ UDShare=\\NYC-AM-FIL-01\MigData$ UDDir=%OSDComputerName% SLShare=\\NYC-AM-FIL-01\Logs$ UDProfiles=Administrator, User-01, ExtranetUser UserDataLocation=NONE SkipCapture=NO

UDProfiles

A comma-delimited list of user profiles that need to be saved by Scanstate.exe during the State Capture Phase.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
user_profiles The list of user profiles to be saved, separated by commas
Example
[Settings] Priority=Default [Default] DeployRoot=\\NYC-AM-FIL-01\Distribution$ ResourceRoot=\\NYC-AM-FIL-01\Resource$ UDShare=\\NYC-AM-FIL-01\MigData$ UDDir=%OSDComputerName% SLShare=\\NYC-AM-FIL-01\Logs$ UDProfiles=Administrator, User-01, ExtranetUser UserDataLocation=NONE SkipCapture=NO

UDShare

The network share where user state migration data is stored.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
UNC_path The UNC path to the network share where user state migration data is stored
Example
[Settings] Priority=Default [Default] DeployRoot=\\NYC-AM-FIL-01\Distribution$ ResourceRoot=\\NYC-AM-FIL-01\Resource$ UDShare=\\NYC-AM-FIL-01\MigData$ UDDir=%OSDComputerName% SLShare=\\NYC-AM-FIL-01\Logs$ UDProfiles=Administrator, User-01, ExtranetUser UserDataLocation=NONE SkipCapture=NO

UILanguage

The default language to be used with the target operating system. If not specified, the Deployment Wizard uses the language configured in the image being deployed.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
UI_language The default language for the operating system on the target computer
Example
[Settings] Priority=Default [Default] UserLocale=en-us UILanguage=en-us KeyboardLocale=0409:00000409

UserDataLocation

The location in which USMT stores user state migration data.

Caution

This property value must be specified in uppercase letters so that the deployment scripts can properly read it.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
blank If UserDataLocationis not specified or is left blank, the Deployment Wizard will default to using the AUTO behavior.
UNC_path The UNC path to the network shared folder where the user state migration data is stored.
AUTO The deployment scripts store the user state migration data on a local hard disk if space is available. Otherwise, the user state migration data is saved to a network location, which is specified in the UDShare and UDDir properties.
NETWORK The user state migration data is stored in the location designated by the UDShare and UDDir properties.
NONE The user state migration data is not saved.
Example
[Settings] Priority=Default [Default] OSInstall=YES ScanStateArgs=/v:5 /o /c LoadStateArgs=/v:5 /c /lac DoCapture=YES BackupShare=\\NYC-AM-FIL-01\Backup$ BackupDir=%OSDComputerName% UserDataLocation=NETWORK DeployRoot=\\NYC-AM-FIL-01\Distribution$ ResourceRoot=\\NYC-AM-FIL-01\Resource$ UDShare=\\NYC-AM-FIL-01\MigData$ UDDir=%OSDComputerName%

UserDomain

The domain in which a user’s credentials (specified in the UserID property) reside.

Note

For a completely automated LTI deployment, provide this property in both CustomSettings.ini and BootStrap.ini. However, note that storing the user credentials in these files stores the credentials in clear text and therefore is not secure.

Property configured by Property applies to
BootStrap.ini - LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
domain The name of the domain where the user account credentials reside
Example
[Settings] Priority=Default [Default] OSInstall=YES ScanStateArgs=/v:5 /o /c LoadStateArgs=/v:5 /c /lac DeployRoot=\\NYC-AM-FIL-01\Distribution$ ResourceRoot=\\NYC-AM-FIL-01\Resource$ UserDataLocation=NONE UserDomain=WOODGROVEBANK UserID=NYC Help Desk Staff UserPassword=<complex_password>

UserID

The user credentials for accessing network resources.

Note

For a completely automated LTI deployment, provide this property in both CustomSettings.ini and BootStrap.ini. However, note that storing the user credentials in these files stores the credentials in clear text and therefore is not secure.

Property configured by Property applies to
BootStrap.ini - LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
user_id The name of the user account credentials used to access the network resources
Example
[Settings] Priority=Default [Default] OSInstall=YES ScanStateArgs=/v:5 /o /c LoadStateArgs=/v:5 /c /lac DeployRoot=\\NYC-AM-FIL-01\Distribution$ ResourceRoot=\\NYC-AM-FIL-01\Resource$ UserDataLocation=NONE UserDomain=WOODGROVEBANK UserID=NYC-HelpDesk UserPassword=<complex_password>

UserLocale

The user locale to be used with the target operating system. If not specified, the Deployment Wizard uses the user locale configured in the image being deployed.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
user_locale The locale for the user on the target computer. The value is specified as a text value (en-us).
Example 1
[Settings] Priority=Default [Default] UserLocale=en-us KeyboardLocale=0409:00000409
Example 2
[Settings] Priority=Default [Default] UserLocale=en-us KeyboardLocale=en-us

UserPassword

The password for user credentials specified in the UserID property.

Note

For a completely automated LTI deployment, provide this property in both CustomSettings.ini and BootStrap.ini. However, note that storing the user credentials in these files stores the credentials in clear text and therefore is not secure.

Property configured by Property applies to
BootStrap.ini - LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
user_password The password for the user account credentials
Example
[Settings] Priority=Default [Default] UserDataLocation=NONE UserDomain=WOODGROVEBANK UserID=NYC-HelpDesk UserPassword=<complex_password>

USMTConfigFile

The USMT configuration XML file that should be used when running Scanstate and Loadstate.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
USMTConfigFile The name of the XML configuration file that should be used when running Scanstate.exe and Loadstate.exe
Example
[Settings] Priority=Default [Default] OSInstall=YES ScanStateArgs=/v:5 /o /c LoadStateArgs=/v:5 /c /lac DeployRoot=\\NYC-AM-FIL-01\Distribution$ ResourceRoot=\\NYC-AM-FIL-01\Resource$ UDShare=\\NYC-AM-FIL-01\MigData$ UDDir=%OSDComputerName% SLShare=\\NYC-AM-FIL-01\Logs$ USMTMigFiles1=MigApp.xml USMTMigFiles2=MigUser.xml USMTMigFiles3=MigSys.xml USMTMigFiles4=MigCustom.xml USMTConfigFile=USMTConfig.xml UserDataLocation=NONE

USMTLocal

This property specifies whether the USMT user state information is stored locally on the target computer. This property is primarily used by the ZTIUserState.wsf and ZTIBackup.wsf scripts to indicate that the Request State Store and Release State Store task sequence steps for Configuration Manager deployments are skipped. For more information, see the OSDStateStorePath property.

Note

This property should only be used in the circumstance described in the OSDStateStorePath property).

Property configured by Property applies to
BootStrap.ini LTI
CustomSettings.ini
MDT DB ZTI -
Value Description
TRUE The USMT user state information is stored locally on the target computer, and the Request State Store and Release State Store task sequence steps are skipped.
FALSE The USMT user state information is not stored locally on the target computer, and the Request State Store and Release State Store task sequence steps are performed.
Example
[Settings] Priority=Default [Default] OSInstall=YES ScanStateArgs=/v:5 /o /c LoadStateArgs=/v:5 /c /lac DeployRoot=\\NYC-AM-FIL-01\Distribution$ ResourceRoot=\\NYC-AM-FIL-01\Resource$ UDShare=\\NYC-AM-FIL-01\MigData$ UDDir=%OSDComputerName% SLShare=\\NYC-AM-FIL-01\Logs$ USMTLocal=TRUE USMTMigFiles001=MigApp.xml USMTMigFiles002=MigUser.xml USMTMigFiles003=MigSys.xml USMTMigFiles004=MigCustom.xml UserDataLocation=NONE

USMTMigFiles

A list of files in XML format that are used by USMT (Scanstate.exe) to identify user state migration information to be saved. When this property is not specified, the ZTIUserState.wsf script uses MigApp.xml, MigUser.xml, and MigSys.xml. Otherwise, ZTIUserState.wsf uses the files explicitly referenced in this property. The USMTMigFiles property has a numeric suffix (for example, USMTMigFiles001 or USMTMigFiles002).

Note

Use this property to specify the XML files to be used by Scanstate.exe instead of using the /I parameter in the ScanStateArgs property. This prevents the ZTIUserState.wsf script from potentially duplicating the same list of XML files.

Note

This property name can be specified using single-digit nomenclature (USMTMigFiles1) or triple-digit nomenclature (USMTMigFiles001).

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB ZTI
Value Description
USMTMigFile The name of the .xml file to be used as input for Scanstate.exe, on separate lines. If not specified, the default is MigApp.xml, MigUser.xml, and MigSys.xml.

Note:

If this value is specified, the default files (MigApp.xml, MigUser.xml, and MigSys.xml) must also be added to the list if these files are to be included.
Example
[Settings] Priority=Default [Default] OSInstall=YES ScanStateArgs=/v:5 /o /c LoadStateArgs=/v:5 /c /lac DeployRoot=\\NYC-AM-FIL-01\Distribution$ ResourceRoot=\\NYC-AM-FIL-01\Resource$ UDShare=\\NYC-AM-FIL-01\MigData$ UDDir=%OSDComputerName% SLShare=\\NYC-AM-FIL-01\Logs$ USMTMigFiles001=MigApp.xml USMTMigFiles002=MigUser.xml USMTMigFiles003=MigSys.xml USMTMigFiles004=MigCustom.xml UserDataLocation=NONE

USMTOfflineMigration

This property determines whether MDT uses USMT to perform an offline user state migration. In an offline migration, the capture is performed in Windows PE instead of the existing operating system.

Offline migration is using USMT is performed for:

  • UDI always, regardless of the setting of the USMTOfflineMigration property

  • ZTI only for the MDT Refresh Computer deployment scenario and only when the USMTOfflineMigration property is set to "TRUE"

    Note

    You cannot perform USMT offline user state migration in the MDT New Computer deployment scenario using ZTI.

  • LTI for the:

    1. MDT New Computer deployment scenario using the Move Data and Settings wizard page in the Deployment Wizard

    2. MDT Refresh Computer deployment scenario and only when the USMTOfflineMigration property is set to "TRUE"

    For more information about using MDT and USMT to perform an offline user state migration, see "Configure USMT Offline User State Migration".

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB ZTI -
Value Description
TRUE MDT uses USMT to perform an offline user state migration.
Any other value MDT does not perform an offline user state migration. Instead, user state migration is captured in the existing operating system. This is the default value.
Example
[Settings] Priority=Default [Default] OSInstall=YES SkipUserData=YES USMTOfflineMigration=TRUE DoNotFormatAndPartition=YES OSDStateStorePath=\\WDG-MDT-01\StateStore$

UUID

The Universal Unique Identifier (UUID) stored in the System Management BIOS of the target computer.

The format for UUID is a 16-byte value using hexadecimal digits in the following format: 12345678-1234-1234-1234-123456789ABC. Use this property to create a subsection that contains settings targeted to a specific computer.

Note

This property is dynamically set by MDT scripts and cannot have its value set in CustomSettings.ini or the MDT DB. Treat this property as read only. However, you can use this property within CustomSettings.ini or the MDT DB, as shown in the following examples, to aid in defining the configuration of the target computer.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini
MDT DB ZTI -
Value Description
UUID The UUID of the target computer
Example
None

ValidateDomainCredentialsUNC

This property is used to specify a UNC path to a network shared folder that is used to validate the credentials provided for joining the target computer to a domain. The credentials being validated are specified in the DomainAdmin, DomainAdminDomain, and DomainAdminPassword properties.

Note

Ensure that no other properties in MDT use the server sharing the folder in this property. Using a server that is already referenced by other MDT properties could result in improper validation of the credentials.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
unc_path Specifies the fully qualified UNC path to a network shared folder
Example
[Settings] Priority=Default [Default] ValidateDomainCredentialsUNC=\\wdg-fs-01\Source$

VHDCreateDiffVHD

This property is used to specify the name of a differencing VHD (also known as a child VHD) file. A differencing VHD is similar to a dynamically expanding VHD but contains only the modified disk blocks of the associated parent VHD. The parent VHD is read only, so you must modify the differencing VHD. The differencing VHD file is created in the same folder as the parent VHD file, so only the file name is specified in this property. This property is only valid for the MDT New Computer deployment scenario.

Note

All parent VHD files created by MDT are stored in the VHD folder in the root of the parent drive.

This property is commonly set using a task sequence step created using the Create Virtual Hard Disk (VHD) task sequence type. You can override the value the Create Virtual Hard Disk (VHD) task sequence step sets by configuring this property in CustomSettings.ini.

Note

To configure this property in CustomSettings.ini, you must add this property to the Properties line in CustomSettings.ini.

For related properties that are used with VHD files, see:

  • VHDCreateFileName

  • VHDCreateSizeMax

  • VHDCreateSource

  • VHDCreateType

  • VHDDisks

  • VHDInputVariable

  • VHDOutputVariable

  • VHDTargetDisk

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB ZTI
Value Description
filename Specifies the name of the differencing VHD file, which is located in the same folder as the parent VHD file

The differencing VHD file cannot have the same name as the parent VHD file.
RANDOM Automatically generates a random name for the differencing VHD file, which is located in the same folder as the parent VHD file
Example
[Settings] Priority=Default [Default] VHDCreateDiffVHD=Win7Diff_C.vhd VHDInputVariable=VHDTargetDisk

VHDCreateFileName

This property is used to specify the name of a VHD file. The type of VHD file is based on the value of the VHDCreateType property. The property only includes the file name, not the path to the file name, and is valid only for the MDT New Computer deployment scenario.

Note

The VHD files created by MDT are stored in the VHD folder in the root of the parent drive.

This property is commonly set using a task sequence step created using the Create Virtual Hard Disk (VHD) task sequence type. You can override the value the Create Virtual Hard Disk (VHD) task sequence step sets by configuring this property in CustomSettings.ini.

Note

To configure this property in CustomSettings.ini, you must add this property to the Properties line in CustomSettings.ini.

For related properties that are used with VHD files, see:

  • VHDCreateDiffVHD

  • VHDCreateSizeMax

  • VHDCreateSource

  • VHDCreateType

  • VHDDisks

  • VHDInputVariable

  • VHDOutputVariable

  • VHDTargetDisk

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB ZTI
Value Description
file_name Specifies the name of the VHD file
RANDOM Automatically generates a random name for the VHD file, which is located in the VHD folder in the root of the parent drive
Blank Same a RANDOM
Example
[Settings] Priority=Default [Default] VHDCreateSizeMax=130048 VHDCreateType=EXPANDABLE VHDCreateFileName=Win7_C.vhd VHDInputVariable=VHDTargetDisk

VHDCreateSizeMax

This property is used to specify the maximum size of a VHD file in megabytes (MB). The size of the VHD file at creation time is based on the type of VHD file being created. For more information, see the VHDCreateType property. This property is valid only for the MDT New Computer deployment scenario.

Note

If this property is not specified, the default value for the maximum size of a VHD file is 90% of the available disk space on the parent disk.

This property is commonly set using a task sequence step created using the Create Virtual Hard Disk (VHD) task sequence type. You can override the value that the Create Virtual Hard Disk (VHD) task sequence step sets by configuring this property in CustomSettings.ini.

Note

To configure this property in CustomSettings.ini, you must add this property to the Properties line in CustomSettings.ini.

For related properties that are used with VHD files, see:

  • VHDCreateDiffVHD

  • VHDCreateFileName

  • VHDCreateSource

  • VHDCreateType

  • VHDDisks

  • VHDInputVariable

  • VHDOutputVariable

  • VHDTargetDisk

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB ZTI
Value Description
size The maximum size of the VHD file specified in MB. For example, 130,048 MB equals 127 GB. The default value is 90% of the available disk space on the parent disk.
Example
[Settings] Priority=Default [Default] VHDCreateSizeMax=130048 VHDCreateType=FIXED VHDCreateFileName=Win7_C.vhd VHDInputVariable=VHDTargetDisk

VHDCreateSource

This property is used to specify the name of a VHD file that is used as a template (source) for creating a new VHD file. You can specify the file name using a UNC path, local path, relative path, or just the file name. If just the file name is specified, then MDT attempts to find the VHD file on the target computer. This property is valid only for the MDT New Computer deployment scenario.

This property is commonly set using a task sequence step created using the Create Virtual Hard Disk (VHD) task sequence type. You can override the value that the Create Virtual Hard Disk (VHD)task sequence step sets by configuring this property in CustomSettings.ini.

Note

To configure this property in CustomSettings.ini, you must add this property to the Properties line in CustomSettings.ini.

For related properties that are used with VHD files, see:

  • VHDCreateDiffVHD

  • VHDCreateFileName

  • VHDCreateSizeMax

  • VHDCreateType

  • VHDDisks

  • VHDInputVariable

  • VHDOutputVariable

  • VHDTargetDisk

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB ZTI
Value Description
name The file name, which can be specified using a UNC path, local path, relative path, or just the file name. If just the file name is specified, then MDT attempts to find the VHD file on the target computer.
Example
[Settings] Priority=Default [Default] VHDCreateSizeMax=130048 VHDCreateSource=\\wdg-mdt-01\vhds\win7_template.vhd VHDCreateType=FIXED VHDCreateFileName=Win7_C.vhd VHDInputVariable=VHDTargetDisk

VHDCreateType

This property is used to specify the type of VHD file that is specified in the VHDCreateFileName property and can be one of the following VHD file types:

  • Fixed VHD file. For this VHD type, the size of the VHD specified at creation is allocated and does not change automatically after creation. For example, if you create a 24-gigabyte (GB) fixed VHD file, the file will be approximately 24 GB in size (with some space used for the internal VHD structure) regardless of how much information is stored in the VHD file.

  • Dynamically expanding VHD file. For this VHD type, only a small percentage of the size of the VHD specified at creation time is allocated. Then, the VHD file continues to grow as more and more information is stored in it. However, the VHD file cannot grow beyond the size specified at creation. For example, if you create a 24 GB dynamically expanding VHD, it will be small at creation. However, as information is stored in the VHD file, the file will continue to grow but never exceed the maximum size of 24 GB.

    This property is only valid for the MDT New Computer deployment scenario.

Note

The maximum size of the VHD file is specified in the VHDCreateSizeMax property.

This property is commonly set using a task sequence step created using the Create Virtual Hard Disk (VHD) task sequence type. You can override the value that the Create Virtual Hard Disk (VHD) task sequence step sets by configuring this property in CustomSettings.ini.

Note

To configure this property in CustomSettings.ini, you must add this property to the Properties line in CustomSettings.ini.

For related properties that are used with VHD files, see:

  • VHDCreateDiffVHD

  • VHDCreateFileName

  • VHDCreateSizeMax

  • VHDCreateSource

  • VHDDisks

  • VHDInputVariable

  • VHDOutputVariable

  • VHDTargetDisk

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB ZTI
Value Description
EXPANDABLE Creates a fixed VHD file
FIXED Creates a dynamically expanding VHD file
Example
[Settings] Priority=Default [Default] VHDCreateSizeMax=130048 VHDCreateType=EXPANDABLE VHDCreateFileName=Win7_C.vhd VHDInputVariable=VHDTargetDisk

VHDDisks

This property contains a list of the physical drive numbers assigned to VHD files separated by spaces. Each time a VHD file is created, MDT adds the disk index of the newly created disk to this property using the Index property of the Win32_DiskDrive WMI class.

Note

This property is dynamically set by the MDT scripts and is not configured in CustomSettings.ini or the MDT DB. Treat this property as read only.

This property is commonly set using a task sequence step created using the Create Virtual Hard Disk (VHD) task sequence type. You can override the value that the Create Virtual Hard Disk (VHD) task sequence step sets by configuring this property in CustomSettings.ini.

Note

To configure this property in CustomSettings.ini, you must add this property to the Properties line in CustomSettings.ini.

For related properties that are used with VHD files, see:

  • VHDCreateDiffVHD

  • VHDCreateFileName

  • VHDCreateSizeMax

  • VHDCreateSource

  • VHDCreateType

  • VHDInputVariable

  • VHDOutputVariable

  • VHDTargetDisk

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB ZTI
Value Description
index1 index2 index3 A list of the physical drive numbers assigned to the VHD files separated by spaces—for example, 1 2 5.
Example
None

VHDInputVariable

This property contains a variable that contains the drive on the target computer where the VHD files will be created. MDT creates the VHD files in the VHD folder in the root of this drive.

Note

If this property is omitted, MDT attempts to create the VHD files in the VHD folder in the root of the first system drive.

This property is commonly set using a task sequence step created using the Create Virtual Hard Disk (VHD) task sequence type. You can override the value that the Create Virtual Hard Disk (VHD) task sequence step sets by configuring this property in CustomSettings.ini.

Note

To configure this property in CustomSettings.ini, you must add this property to the Properties line in CustomSettings.ini.

For related properties that are used with VHD files, see:

  • VHDCreateDiffVHD

  • VHDCreateFileName

  • VHDCreateSizeMax

  • VHDCreateSource

  • VHDCreateType

  • VHDDrives

  • VHDOutputVariable

  • VHDTargetDisk

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB ZTI
Value Description
variable Variable that contains the drive letter on the target computer where the VHD files will be created. MDT creates the VHD files in the VHD folder in the root of this drive. For example, if this property has a value of VHDTargetDisk, the VHDTargetDisk property contains the drive letter (such as H).
Example
VHDCreateSizeMax=130048 VHDCreateType=EXPANDABLE VHDCreateFileName=Win7_C.vhd VHDInputVariable=VHDTargetDisk

VHDOutputVariable

This property contains a variable that contains the physical drive number that was assigned to the newly created VHD file. Each time a VHD file is created, MDT sets this property to the disk index of the newly created disk using the Index property of the Win32_DiskDrive WMI class.

This property is commonly set using a task sequence step created using the Create Virtual Hard Disk (VHD) task sequence type. You can override the value that the Create Virtual Hard Disk (VHD) task sequence step sets by configuring this property in CustomSettings.ini.

Note

To configure this property in CustomSettings.ini, you must add this property to the Properties line in CustomSettings.ini.

For related properties that are used with VHD files, see:

  • VHDCreateDiffVHD

  • VHDCreateFileName

  • VHDCreateSizeMax

  • VHDCreateSource

  • VHDCreateType

  • VHDDisks

  • VHDInputVariable

  • VHDTargetDisk

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB ZTI
Value Description
Variable Variable will contains the physical drive number assigned to the newly created VHD file. For example, if this property has a value of OSDDiskIndex, the OSDDiskIndex property will contain the physical drive number assigned to the newly created VHD file (such as 4).
Example
None

VHDTargetDisk

Specifies the drive on the target computer where the VHD is to be created. This property is later referenced in the VHDInputVariable property.

Note

This property is dynamically set by the MDT scripts and is not configured in CustomSettings.ini or the MDT DB. Treat this property as read only.

For related properties that are used with VHD files, see:

  • VHDCreateDiffVHD

  • VHDCreateFileName

  • VHDCreateSizeMax

  • VHDCreateSource

  • VHDCreateType

  • VHDDisks

  • VHDInputVariable

  • VHDOutputVariable

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini
MDT DB ZTI
Value Description
Disk Specifies the drive where the VHD is to be created
Example
None

VMHost

Specifies the name of the Hyper-V host running the VM where MDT is running. This property is available only when the Hyper-V Integration Components are installed and running.

Note

This property is dynamically set by the MDT scripts and is not configured in CustomSettings.ini or the MDT DB. Treat this property as read only.

Table 4 lists the Windows operating systems that MDT supports and their corresponding Hyper-V Integration Components support.

Table 4. Windows Operating Systems and Hyper-V Integration Components Support

Operating system Hyper-V Integration Components
Windows PE Integration Components are unavailable.
Windows 7 Available by default in Enterprise, Ultimate, and Professional editions.
Windows Server 2008 R2 Available by default in all editions.
Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini
MDT DB ZTI -
Value Description
Name The name of the Hyper-V host running the VM where MDT is running
Example
None

VMName

Specifies the name of the VM where MDT is running. This property is only available when the Hyper-V Integration Components are installed and running.

Table 5 lists the Windows operating systems supported by MDT and their corresponding Hyper-V Integration Components support.

Note

This property is dynamically set by the MDT scripts and is not configured in CustomSettings.ini or the MDT DB. Treat this property as read only.

Table 5. Windows Operating Systems and Hyper-V Integration Components Support

Operating system Hyper-V Integration Components
Windows PE Integration Components are unavailable.
Windows 7 Available by default in Enterprise, Ultimate, and Professional editions.
Windows Server 2008 R2 Available by default in all editions.
Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini
MDT DB ZTI -
Value Description
name The name of the VM where MDT is running
Example
None

VMPlatform

Specifies specific information about the virtualization environment for the target computer when the target computer is a VM. The VM platform is determined by using WMI.

Note

This property is dynamically set by the MDT scripts and is not configured in CustomSettings.ini or the MDT DB. Treat this property as read only.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini
MDT DB ZTI -
Value Description
Hyper-V Hyper-V
VirtualBox Virtual Box
VMware VMware virtualization platform
Xen Citrix Xen Server
Example
None

VRefresh

The vertical refresh rate for the monitor on the target computer. The vertical refresh rate is specified in Hertz. In the example, the value 60 indicates that the vertical refresh rate of the monitor is 60 Hz. This value is inserted into the appropriate configuration settings in Unattend.xml.

Note

The default values (in the Unattend.xml template file) are 1,024 pixels horizontal resolution, 768 pixels vertical resolution, 32-bit color depth, and 60 Hz vertical refresh rate.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
refresh_rate The vertical refresh rate for the monitor on the target computer in Hertz
Example
[Settings] Priority=Default [Default] BitsPerPel=32 VRefresh=60 XResolution=1024 YResolution=768

VSSMaxSize

This property is used to pass a value to the maxsize parameter of the vssadmin resize shadowstorage command in the Vssadmin command. The maxsize parameter is used to specify the maximum amount of space on the target volume that can be used for storing shadow copies. For more information on the maxsize parameter, see Vssadmin resize shadowstorage.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
maxsize_value Specifies the maximum amount of space that can be used for storing shadow copies. The value can be specified in bytes or as a percentage of the target volume.

To specify the value:

- In bytes, the value must be 300 MB or greater and accept the following suffixes: KB, MB, GB, TB, PB and EB. You can also use B, K, M, G, T, P, and E as suffixes—for example:

VSSMaxSize=60G

- As a percentage, use the % character as the suffix to the numeric value—for example:

VSSMaxSize=20%

Note:

If a suffix is not supplied, the default suffix is bytes. For example, VSSMaxSize=1024 indicates that the VSSMaxSize will be set to 1,024 bytes.

If the value is set to UNBOUNDED, then there is no limit placed on the amount of storage space that can be used—for example:

VSSMaxSize=UNBOUNDED
Example
[Settings] Priority=Default [Default] VSSMaxSize=25%

WDSServer

The computer running Windows Deployment Services that is used for installing Windows Deployment Services images. The default value is the server running Windows Deployment Services from which the image was initiated.

Note

This property is dynamically set by the MDT scripts and is not configured in CustomSettings.ini or the MDT DB. Treat this property as read only.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini
MDT DB ZTI
Value Description
WDS_server The name of the computer running Windows Deployment Services
Example
None

WindowsSource

MDT uses this property to set the location of the sources\sxs folder in a network shared folder that contains the operating system source files. This property is used when:

  • MDT is running a custom task sequence or deploying a custom image

  • MDT is installing roles or features in Windows 8 and Windows Server 2012

  • The computer does not have access to the Internet

    When the situation described in the bulleted list above occurs, MDT may be unable to find the operating system source files locally, and the installation will attempt to download the files from the Internet. Because the computer does not have Internet access, the process will fail. Setting this property to the appropriate value helps prevent this problem from occurring.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB ZTI -
Value Description
folder_unc A UNC path to the Sources\sxs folder for the operating system being deployed.

Note:

The UNC path must include the Sources\sxs folder.
Example
[Settings] Priority=Default [Default] WindowsSource=%DeployRoot%\Operating Systems\Windows 8\Sources\sxs

WipeDisk

Specifies whether the disk should be wiped. If WipeDisk is TRUE, the ZTIWipeDisk.wsf script will clean the disk using the Format command. The Format command is not the most "secure" way of wiping the disk.

Securely wiping the disk should be done so in a manner that follows the U.S. Department of Defense standard 5220.22-M, which states, "To clear magnetic disks, overwrite all locations three times (first time with a character, second time with its complement, and the third time with a random character)."

When MDT wipes the disk, it uses the Format command with the /P:3 switch, which instructs Format to zero every sector on the volume and to perform the operation three times. There is no way to tell the Format command to use a particular character or a random character.

Note

If the disk must be securely wiped, a non-Microsoft secure disk wipe tool should be added to the task sequence using the Run Command Line task sequence step.

Caution

This property value must be specified in uppercase letters so that the deployment scripts can properly read it.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
TRUE If WipeDisk is set to TRUE, the Win32_DiskPartition at DiskIndex 0 and Index 0 will be formatted.
FALSE The disk will not be formatted.
Example
[Settings] Priority=Default [Default] WipeDisk=TRUE

WizardSelectionProfile

Profile name used by the wizard for filtering the display of various items.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI
Value Description
profile_name Profile name used by the wizard for filtering the display of various items
Example
[Settings] Priority=Default [Default] WizardSelectionProfile=SelectTaskSequenceOnly

WSUSServer

This is the name of the Windows Server Update Services (WSUS) server that the target computer should use when scanning for, downloading, and installing updates.

For more information about what script uses this property, see ZTIWindowsUpdate.wsf.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
server_name The name of the WSUS server, specified in HTTP format
Example
[Settings] Priority=Default [Default] WSUSServer=http://WSUSServerName[Settings] Priority=Default [Default] WSUSServer=http://WSUSServerName

WUMU_ExcludeKB

The list of Windows Update/Microsoft Update software updates to ignore (by associated Knowledge Base articles).

Deployment project team members will want to periodically review the list of updates being installed by the ZTIWindowsUpdate.wsf script to verify that each update meets the project’s needs and expectations. All updates are logged and recorded in the ZTIWindowsUpdate.log file, which is generated during deployment. Each update will indicate its status as INSTALL or SKIP and lists the UpdateID, the update name, and the QNumber associated with each update. If an update needs to be excluded, that update should be added to the CustomSettings.ini file (for LTI deployments).

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB ZTI
Value Description
WUMU_ExcludeKB The list of Windows Update/Microsoft Update software updates to ignore by QNumber
Example
[Settings] Priority=Default [Default] WUMU_ExcludeKB1=925471

WUMU_ExcludeID

The list of Windows Update/Microsoft Update software updates to ignore (by associated update ID).

Deployment project team members will want to periodically review the list of updates being installed by the ZTIWindowsUpdate.wsf script to verify that each update meets the project’s needs and expectations. All updates are logged and recorded in the ZTIWindowsUpdate.log file, which is generated during deployment. Each update will indicate its status as INSTALL or SKIP and lists the UpdateID, the update name, and the QNumber associated with each update. If an update should be excluded, that update should be added to the CustomSettings.ini file (for LTI deployments).

For example, if the installation of the Windows Malicious Software Removal Tool should be excluded, look up the line in the ZTIWindowsUpdate.log that shows where the update was identified and installed, and then select the UpdateID number. For example, the UpdateID number for the Windows Malicious Software Removal Tool is adbe6425-6560-4d40-9478-1e35b3cdab4f.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB ZTI
Value Description
WUMU_ExcludeID The list of Windows Update/Microsoft Update software updates to ignore, by UpdateID number
Example
[Settings] Priority=Default [Default] WUMU_ExcludeID1={adbe6425-6560-4d40-9478-1e35b3cdab4f}[Settings] Priority=Default [Default] WUMU_ExcludeID1={adbe6425-6560-4d40-9478-1e35b3cdab4f}

XResolution

The horizontal resolution of the monitor on the target computer, specified in pixels. In the example, the value 1024 indicates the horizontal resolution of the monitor is 1,024 pixels. This value is inserted into the appropriate configuration settings in Unattend.xml.

Note

The default values (in the Unattend.xml template file) are 1,024 pixels horizontal resolution, 768 pixels vertical resolution, 32-bit color depth, and 60 Hz vertical refresh rate.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
horizontal_resolution The horizontal resolution of the monitor on the target computer in pixels
Example
[Settings] Priority=Default [Default] BitsPerPel=32 VRefresh=60 XResolution=1024 YResolution=768[Settings] Priority=Default [Default] BitsPerPel=32 VRefresh=60 XResolution=1024 YResolution=768

YResolution

The vertical resolution of the monitor on the target computer, specified in pixels. In the example, the value 768 indicates the vertical resolution of the monitor is 768 pixels. This value gets inserted into the appropriate configuration settings in Unattend.xml.

Note

The default values (in the Unattend.xml template file) are 1,024 pixels horizontal resolution, 768 pixels vertical resolution, 32-bit color depth, and 60 Hz vertical refresh rate.

Property configured by Property applies to
BootStrap.ini LTI -
CustomSettings.ini -
MDT DB - ZTI -
Value Description
vertical_resolution The vertical resolution of the monitor on the target computer in pixels
Example
[Settings] Priority=Default [Default] BitsPerPel=32 VRefresh=60 XResolution=1024 YResolution=768[Settings] Priority=Default [Default] BitsPerPel=32 VRefresh=60 XResolution=1024 YResolution=768

Providing Properties for Skipped Deployment Wizard Pages

Table 6 lists the individual Deployment Wizard pages, the property to skip the corresponding wizard page, and the properties that must be configured when skipping the wizard page.

If the SkipWizard property is used to skip all the Deployment Wizard pages, provide all the properties in the Configure these propertiescolumn. For examples of various deployment scenarios that skip Deployment Wizard pages, see the section, "Fully Automated LTI Deployment Scenario", in the MDT document Microsoft Deployment Toolkit Samples Guide.

Note

In instances where the Configure These Properties column is blank, no properties need to be configured when skipping the corresponding wizard page.

Table 6. Deployment Wizard Pages

Skip this wizard page Using this property Configure these properties
Welcome SkipBDDWelcome
Specify credentials for connecting to network shares Skipped by providing properties in next column - UserID

- UserDomain

- UserPassword
Task Sequence SkipTaskSequence - TaskSequenceID
Computer Details SkipComputerName,

SkipDomainMembership
- OSDComputerName

- JoinWorkgroup

–or–

- JoinDomain

- DomainAdmin
User Data SkipUserData - UDDir

- UDShare

- UserDataLocation
Move Data and Settings SkipUserData - UDDir

- UDShare

- UserDataLocation
User Data (Restore) SkipUserData - UDDir

- UDShare

- UserDataLocation
Computer Backup SkipComputerBackup - BackupDir

- BackupShare

- ComputerBackupLocation
Product Key SkipProductKey - ProductKey

–or–

- OverrideProductKey
Language Packs SkipPackageDisplay LanguagePacks
Locale and Time SkipLocaleSelection, SkipTimeZone - KeyboardLocale

- UserLocale

- UILanguage

- TimeZoneName
Roles and Features SkipRoles - OSRoles

- OSRoleServices

- OSFeatures
Applications SkipApplications Applications
Administrator Password SkipAdminPassword AdminPassword
Local Administrators SkipAdminAccounts - Administrators
Capture Image SkipCapture - ComputerBackupLocation
Bitlocker SkipBitLocker - BDEDriveLetter

- BDEDriveSize

- BDEInstall

- BDEInstallSuppress

- BDERecoveryKey

- TPMOwnerPassword

- OSDBitLockerStartupKeyDrive

- OSDBitLockerWaitForEncryption
Ready to begin SkipSummary
Operating system deployment completed successfully SkipFinalSummary
Operating system deployment did not complete successfully SkipFinalSummary

Scripts

The scripts used in LTI and ZTI deployments reference properties that determine the process steps and configuration settings used during the deployment process. Use this reference section to help it 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 MDT is installed.

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

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

  • Use.Provides the commands and options that you can specify.

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

BDD_Autorun.wsf

This script displays a dialog box that indicates the user inserted deployment media created by the MDT 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 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 LiteTouch.vbs. Initiates LTI
Location distribution\Scripts
Use None

Arguments

Value 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

- Wizard.hta. Displays the Deployment Wizard pages

- WPEUtil.exe. Initializes Windows PE and network connections; initiates LTI
Location distribution\Tools\platform
Use mshta.exeWizard.hta BDD_Welcome_ENU.xml

Arguments

Value Description
None None

Properties

Name Read Write
KeyboardLocalePE -
WelcomeWizardCommand -
WizardComplete -

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. Contains user credential support functions
Location distribution\Scripts
Use mshta.exe Wizard.hta /NotWizard /definition:Credentials_ENU.xml [/ValidateAgainstDomain:domain &#124; /ValidateAgainstUNCPath:uncpath] </DoNotSave> </LeaveShareOpen>

Arguments

Value Description
None None

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

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 MDT scripts
References None
Location distribution\Scripts
Use <script language="VBScript" src="Credentials_scripts.vbs"/>

Arguments

Value Description
None None

Properties

Name Read Write
UserCredentials -
UserDomain -

DeployWiz_Definition_ENU.xml

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

  • Welcome

  • Specify credentials for connecting to network shares

  • Task Sequence

  • Computer Details

  • User Data

  • Move Data and Settings

  • User Data (Restore)

  • Computer Backup

  • Product Key

  • Language Packs

  • Locale and Time

  • Roles and Features

  • Applications

  • Administrator Password

  • Local Administrators

  • Capture Image

  • BitLocker

  • 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

- ZTIBackup.wsf. Creates a backup of the target computer

- ZTIPatches.wsf. Installs updates (language packs, security updates, and so on)

- ZTIUserState.wsf. Initializes user state migration to capture and restore user state on the target computer
Location distribution\Scripts
Use None

Arguments

Value Description
None None

Properties

Name Read Write
DeploymentMethod -
DeploymentType -
DoCapture -
ImageBuild -
ImageFlags -
IsBDE -
IsServerOS -
JoinDomain -
OSDComputerName -
OSVersion -
SkipAdminAccounts -
SkipAdminPassword -
SkipApplications -
SkipBitLocker -
SkipCapture -
SkipComputerBackup -
SkipComputerName -
SkipDomainMembership -
SkipLocaleSelection -
SkipPackageDisplay -
SkipProductKey -
SkipRoles -
SkipSummary -
SkipTaskSequence -
SkipTimeZone -
SkipUserData -
TaskSequenceTemplate -
UserDomain -
UserID -
UserPassword -
USMTOfflineMigration -

DeployWiz_Initialization.vbs

This script initializes the pages in the Deployment Wizard (stored in DeployWiz_Definition_ENU.xml). It also contains functions and subroutines that the Deployment Wizard calls during an LTI deployment.

Value Description
Input - DomainOUList.xml. Contains a list of domain OUs

- ListOfLanguages.xml

- LocationServer.xml. Contains a list of available deployment shares

- Environment variables. Contains the list of property values, custom properties, database connections, deployment rules, and other information that the scripts require 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 MDT scripts
References ZTIApplications.wsf. Initiates application installation
Location distribution\Scripts
Use <script language="VBScript" src="DeployWiz_Initialization.vbs"/>

Arguments

Value Description
None None

Properties

Name Read Write
Architecture -
Applications -
BackupDir -
BackupFile -
BackupShare -
BDEInstall -
BDEKeyLocation -
BDERecoveryKey -
BDEWaitForEncryption -
CapableArchitecture -
ComputerBackupLocation -
CustomWizardSelectionProfile -
DeploymentType -
DeployRoot -
DomainAdmin -
DomainAdminDomain -
DomainAdminPassword -
DomainOUs -
ImageBuild -
ImageFlags -
ImageLanguage -
ImageLanguage001 -
ImageProcessor -
IsServerOS -
KeyboardLocale -
KeyboardLocale_Edit -
LanguagePacks -
LanguagePacks001 -
LocalDeployRoot -
MandatoryApplications -
OSDComputerName -
OSCurrentBuild -
OSDBitLockerCreateRecoveryPassword -
OSDBitLockerMode -
OSDBitLockerStartupKeyDrive -
OSDBitLockerWaitForEncryption -
OSSKU -
OSVersion -
OverrideProductKey -
ProductKey -
SkipCapture -
SkipDomainMembership -
TaskSequenceID -
TimeZoneName -
TSGUID -
UDDir -
UDShare -
UILanguage -
UserDataLocation -
UserDomain -
UserID -
UserLocale -
UserPassword -
WizardSelectionProfile -

DeployWiz_Validation.vbs

This script initializes and validates the information typed in the pages of the Deployment Wizard (stored in DeployWiz_Definition_ENU.xml). This script contains functions and subroutines that the Deployment Wizard calls during an LTI deployment.

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

- ZTIGather.wsf. Gathers properties and processing rules
Location distribution\Scripts
Use <script language="VBScript" src="DeployWiz_Validation.vbs"/>

Arguments

Value Description
None None

Properties

Name Read Write
Architecture -
DeploymentType - -
DeployTemplate -
ImageBuild -
ImageProcessor - -
OSVersion -
TaskSequenceID -
TSGUID -
UserCredentials -
UserDomain -
UserID -
UserPassword -

LiteTouch.vbs

This script is called by the 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 Deployment Wizard by calling ZTIPrereq.vbs

  • Starts the Deployment Wizard by running LiteTouch.wsf

Value Description
Input None
Output None
References - BDDRun.exe

- ZTIPrereq.vbs. Used to determine whether 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 is responsible for controlling the LTI deployment process. This includes:

  • Running the Deployment Wizard

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

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 that this script generates

- BDD.log. Log file that contains events that all MDT scripts generate
References - BDD_Welcome_ENU.xml. Displays the Deployment Wizard Welcome page for LTI 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 finishes

- LTICopyScripts.wsf. Copies the deployment scripts to a local hard drive on the target computer

- MSHTA.exe. HTML application host

- RecEnv.exe. If this utility exists, the user is prompted to determine whether to launch Windows Recovery Environment.

- 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

- Wizard.hta. Displays the Deployment Wizard pages

- WPEUtil.exe. Initializes Windows PE and network connections; initiates LTI

- ZTIGather.wsf. Gathers properties and processing rules

- ZTIPrereq.vbs. Checks that the target computer meets the requirements for running the Deployment Wizard

- ZTINICConfig.wsf. Configures activated network adapters

- ZTIUtility.vbs. Includes support functions and subroutines the script uses
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)
/Start Creates a shortcut in the new operating system that runs once the shell starts

Properties

Name Read Write
_DoNotCleanLiteTouch -
_SMSTSPackageName -
AdminPassword -
Architecture - -
BootPE - -
ComputerBackupLocation -
ComputerName -
DeployDrive - -
DeploymentMethod - -
DeploymentType - -
DeployRoot - -
DestinationLogicalDrive -
DomainAdmin -
DomainAdminDomain -
DomainAdminPassword -
FinishAction -
HostName -
IsServerCoreOS -
JoinDomain -
JoinWorkgroup - -
KeyboardLocalePE -
LTISuspend -
OSDAdapterCount -
OSDComputerName - -
Phase - -
ResourceDrive - -
ResourceRoot - -
RetVal -
SkipBDDWelcome -
SkipFinalSummary - -
SkipWizard -
SMSTSLocalDataDrive -
TaskSequenceID -
TimeZoneName -
UserDataLocation - -
UserDomain -
UserID -
UserPassword -
WelcomeWizardCommand -
WizardComplete -

LTIApply.wsf

This script is responsible for installing a Windows PE 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 Environment variables. Contains the property values, custom property values, database connections, deployment rules, and other information the scripts require to complete the deployment process
Output - LTIApply.log. Log file that contains events that this script generates

- LTIApply_wdsmcast.log. Log file that contains events that the Wdsmcast utility generates

- BDD.log. Log file that contains events that all MDT scripts generate
References - CMD.exe. Allows the running of command-line tools

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

- ImageX.exe. A utility used to create and manage WIM files

- ZTIBCDUtility.vbs. Includes utility functions used when performing Boot Manager tasks

- ZTIConfigFile.vbs. Includes routines for processing XML files

- ZTIDiskUtility.vbs. Includes support functions and subroutines the script uses

- ZTIUtility.vbs. Includes support functions and subroutines the script uses

- Wdsmcast.exe. A utility that target computers use 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 -
BootPE -
DeployRoot -
DestinationLogicalDrive - -
OSGUID -
OSCurrentVersion -
OSVersion -
ImageBuild -
ImageFlags -
ImageProcessor -
ISBDE -
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 finishes.

Value Description
Input Environment variables. Contains the list of property values, custom properties, database connections, deployment rules, and other information that the scripts require to complete the deployment process. The environment variables are populated by ZTIGather.wsf.
Output - LTICleanup.log. Log file that contains events that this script generates

- BDD.log. Log file that contains events that all MDT scripts generate
References - Bootsect.exe. Applies a boot sector to the hard disk

- Net.exe. Performs network management tasks

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

- ZTIBCDUtility.vbs. Includes utility functions used when performing Boot Manager tasks

- ZTIUtility.vbs. Includes support functions and subroutines the script uses
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
_DoNotCleanLiteTouch -
DeployRoot -
DestinationLogicalDrive -
OSVersion -

LTICopyScripts.wsf

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

Value Description
Input - Summary_Definition_ENU.xml. Displays the summary results for the LTI deployment

- Environment variables. Contains the property values, custom property values, database connections, deployment rules, and other information that the scripts require to complete the deployment process
Output - LTICopyScripts.log. Log file that contains events that this script generates

- BDD.log. Log file that contains events that all MDT scripts generate
References ZTIUtility.vbs. Includes support functions and subroutines the script uses
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 that the scripts require to complete the deployment process. The environment variables are populated by ZTIGather.wsf.
Output None
References - ZTIUtility.vbs. Includes support functions and subroutines that the script uses

- WizUtility.vbs. Includes support functions and subroutines that the UI uses (such as wizard pages)
Location - distribution\Scripts

- program_files\Microsoft Deployment Toolkit\Scripts
Use cscript LTIGetFolder.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
DefaultFolderPath -
FolderPath -

LTIOEM.wsf

This script is used by an OEM during an LTI OEM scenario to copy the contents of a media deployment share to the target computer’s hard disk to prepare it for duplication.

Value Description
Input Environment variables. Contains the list of property values, custom properties, database connections, deployment rules, and other information that the scripts require to complete the deployment process. The environment variables are populated by ZTIGather.wsf.
Output - LTIOEM.log. Log file that contains events that this script generates

- BDD.log. Log file that contains events that all MDT scripts generate
References - RoboCopy.exe. File and folder copy tool

- ZTIUtility.vbs. Includes support functions and subroutines that the script uses
Location distribution\Scripts
Use cscript LTIOEM.wsf </BITLOCKER &#124; /BDE> </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)
/BITLOCKER Enables BitLocker
/BDE Enables BitLocker

Properties

Name Read Write
_DoNotCleanLiteTouch -
DeployDrive -
DeployRoot -
TSGUID -

LTISuspend.wsf

This script suspends a task sequence to allow manual tasks to be performed. When this script runs, it creates a Resume Task Sequence shortcut on the user’s desktop that allows the user to restart the task sequence after all manual tasks are completed.

Note

This script is only supported while in the full operating system.

Value Description
Input Environment variables. Contains the list of property values, custom properties, database connections, deployment rules, and other information the scripts require to complete the deployment process. The environment variables are populated by ZTIGather.wsf.
Output - LTISuspend.log. Log file that contains events that this script generates

- BDD.log. Log file that contains events that all MDT scripts generate
References - LiteTouch.wsf. Controls the LTI deployment process

- LTICopyScripts.wsf. Copies the deployment scripts to a local hard drive on the target computer

- ZTIUtility.vbs. Includes support functions and subroutines that the script uses
Location distribution\Scripts
Use cscript LTISuspend.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)
/Resume

Properties

Name Read Write
LTISuspend -
SMSTSRebootRequested -

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 that the scripts require to complete the deployment process. The environment variables are populated by ZTIGather.wsf.
Output - LTISysprep.log. Log file that contains events that this script generates

- BDD.log. Log file that contains events that all MDT scripts generate
References - Expand.exe. Expands compressed files

- Sysprep.exe. Prepares computers for duplication

- ZTIConfigFile.vbs. Contains routines for processing XML files

- ZTIUtility.vbs. Includes support functions and subroutines that the script uses
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 -
DeployRoot -
DestinationLogicalDrive -
DoCapture -
OSCurrentBuild -
OSDAnswerFilePath -
OSGUID -
SourcePath - -
TaskSequenceID -

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 Deployment Wizard. During an LTI deployment, Wizard.hta reads this file and runs the embedded wizard page that prompts for the required network addressing configuration. If no static IP addressing configuration is supplied, 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 that the script uses
Location distribution\Scripts
Use None

Arguments

Value Description
None None

Properties

Name Read Write
OSDAdapterxDNSServerList -
OSDAdapterxDNSSuffix -
OSDAdapterxGateways -
OSDAdapterxIPAddressList -
OSDAdapterxMacAddress -
OSDAdapterxSubnetMask -
OSDAdapterxWINSServerList -
OSDAdapterCount -

Note

Thexin the property names listed above is a placeholder for a zero-based array that contains network adapter information.

Summary_Definition_ENU.xml

This XML file contains the script code and HTML layout for the Deployment Summary wizard page in the Deployment Wizard. During an LTI deployment, Wizard.hta reads this 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 that the wizard pages embedded in this XML file use
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 Deployment Wizard. It contains functions and subroutines used for initialization and validation.

Value Description
Input Environment variables. Contains the property values, custom property values, database connections, deployment rules, and other information that the scripts require to complete the deployment process
Output Event message are written to these log files:

- Summary_scripts.log. Log file that contains events that this script generates

- BDD.log. Log file that contains events that all MDT scripts generate
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 displays the Deployment Wizard pages.

Value Description
Input Environment variables. Contains the list of property values, custom properties, database connections, deployment rules, and other information that the scripts require to complete the deployment process. The environment variables are populated by ZTIGather.wsf.
Output - Wizard.log. Log file that contains events that this script generates

- BDD.log. Log file that contains events that all MDT scripts generate
References - LTIGetFolder.wsf. Script file that initiates a BrowseForFolder dialog box

- ZTIConfigFile.vbs. Includes routines for processing XML files

- ZTIUtility.vbs. Includes support functions and subroutines that the script uses

- WizUtility.vbs. Includes support functions and subroutines that the script uses
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
Definition -
DefaultFolderPath -
FolderPath -
WizardComplete -

WizUtility.vbs

This script contains functions and subroutines that the various Deployment Wizard scripts reference.

Value Description
Input Environment variables. Contains the property values, custom property values, database connections, deployment rules, and other information that the scripts require to complete the deployment process
Output - WizUtility.log. Log file that contains events that this script generates

- BDD.log. Log file that contains events that all MDT scripts generate
References LTIGetFolder.wsf. Script file that initiates a BrowseForFolderdialog box
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 -
DefaultDestinationDisk -
DefaultDestinationIsDirty -
DefaultDestinationPartition -
DeploymentType -
DestinationDisk -
FolderPath -
OSVersion -
UserDomain -
UserCredentials -

ZTIApplications.wsf

This script initiates an installation of applications that have been configured in the Applications node in Deployment Workbench. 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 dependent applications defined, this script attempts to install those dependent applications before installing the listed application.

Value Description
Input Environment variables. Contains the property values, custom property values, database connections, deployment rules, and other information that the scripts require to complete the deployment process
Output - ZTIApplications.log. Log file that contains events that this script generates

- BDD.log. Log file that contains events that all MDT scripts generate
References - ZTIConfigFile.vbs. Includes routines for processing XML files

- ZTIUtility.vbs. Includes support functions and subroutines that the script uses

- 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
ApplicationGUID -
ApplicationSuccessCodes -
DependentApplications -
DeploymentMethod -
InstalledApplications - -
ResourceDrive -
ResourceRoot - -
SMSTSRebootRequested -
SMSTSRetryRequested -

ZTIAppXmlGen.wsf

This script generates an XML file—ZTIAppXmlGen.xml—to use when automatically capturing user data (documents) associated with installed applications. It does so through the HKEY_CLASSES_ROOT\Software\Classes registry key and captures any applications that:

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

  • Are not associated with Microsoft Office, such as the 2007 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 that the scripts require to complete the deployment process
Output - ZTIAppXmlGen.xml.Contains a list of applications installed on the target computer

- ZTIAppXmlGen.log. Log file that contains events that this script generates

- BDD.log. Log file that contains events that all MDT scripts generate
References ZTIUtility.vbs. Includes support functions and subroutines that the script uses
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
DeploymentMethod -
DeploymentType -
ImageBuild -
OSCurrentVersion -
USMTMigFiles - -

ZTIAuthorizeDHCP.wsf

This script uses the Netsh tool to configure the target computer so that it is an authorized DHCP server in AD DS.

For more information about authorizing DHCP servers, see How to Use Netsh.exe to Authorize, Unauthorize and List DHCP Servers in Active Directory.

Value Description
Input Environment variables. Contains the property values, custom property values, database connections, deployment rules, and other information that the scripts require to complete the deployment process
Output - ZTIAuthorizeDHCP.log. Log file that contains events that this script generates

- BDD.log. Log file that contains events that all MDT scripts generate
References - Netsh.exe. A utility used to automate the configuration of networking components

- ZTIUtility.vbs. Includes support functions and subroutines that the script uses
Location distribution\Scripts
Use cscript ZTIAuthorizeDHCP.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 -

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.

Value Description
Input Environment variables. Contains the property values, custom property values, database connections, deployment rules, and other information that the scripts require to complete the deployment process
Output - ZTIBackup.log. Log file that contains events that this script generates

- ZTIBackup_imagex.log. Log file that contains events that ImageX generates

- BDD.log. Log file that contains events that all MDT scripts generate
References - ImageX.exe. A utility used to create and manage WIM files

- ZTIBCDUtility.vbs. Includes utility functions used when performing Boot Manager tasks

- ZTIDiskUtility.vbs. Includes support functions and subroutines that the script uses

- ZTIUtility.vbs. Includes support functions and subroutines that the script uses
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 -
BackupScriptComplete -
BackupShare -
ComputerBackupLocation -
DeploymentMethod -
DeploymentType -
DestinationLogicalDrive - -
DoCapture -
ImageBuild -
ImageFlags -
OSDStateStorePath -
Phase -
TaskSequenceID -
USMTLocal -

ZTIBCDUtility.vbs

This script contains utility functions that some MDT scripts use when performing Boot Manager tasks.

Value Description
Input Environment variables. Contains the property values, custom property values, database connections, deployment rules, and other information that the scripts require to complete the deployment process
Output None
References BCDEdit.exe. A tool for editing the Windows boot configuration
Location - distribution\Scripts

- program_files\Microsoft Deployment Toolkit\Scripts
Use <script language="VBScript" src="ZTIBCDUtility.vbs"/>

Arguments

Value Description
None None

Properties

Name Read Write
None

ZTIBde.wsf

This script installs and configures BitLocker on the target computer. BitLocker configuration is limited to New Computer scenarios that have hard disks configured with a single partition.

Note

For ZTI and UDI deployments, the UILanguage property must be set in CustomSettings.ini or in the MDT DB, because ZTIBde.wsf tries to read the locale from the UILanguage property.

Value Description
Input Environment variables. Contains the property values, custom property values, database connections, deployment rules, and other information that the scripts require to complete the deployment process
Output - ZTIBde.log. Log file that contains events that this script generates

- ZTIBdeFix_diskpart.log. Log file that contains events that the Diskpart tool generates

- BDD.log. Log file that contains events that all MDT scripts generate
References - CMD.exe. Allows running of command-line tools

- Defrag.exe. Defragments the hard disk

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

- ServerManagerCmd.exe

- ZTIDiskUtility.vbs. Includes support functions and subroutines that the script uses

- ZTIOSRole.wsf. Installs server roles

- ZTIUtility.vbs. Includes support functions and subroutines that the script uses
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 -
BDESecondPass - -
BdeWaitForEncryption -
BitlockerInstalled - -
DeploymentMethod -
ISBDE -
OSDBitLockerCreateRecoveryPassword -
OSDBitLockerMode -
OSDBitLockerStartupKey -
OSDBitLockerStartupKeyDrive -
OSDBitLockerTargetDrive -
OSDBitLockerWaitForEncryption -
OSCurrentBuild -
OSCurrentVersion -
OSFeatures - -
OSRoles - -
OSRoleServices - -
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. The list of incompatible BIOSes is stored in the ZTIBIOSCheck.xml file.

If the BIOS on the target computer is listed in the ZTIBIOSCheck.xml file, then the script returns a status that indicates the BIOS is incompatible with Windows and the deployment process should be terminated. For information on populating the list of incompatible BIOSes, see ZTIBIOSCheck.xml.

Value Description
Input - ZTIBIOSCheck.xml. Contains a list of BIOSes that are known to be incompatible with Windows

- Environment variables. Contains the property values, custom property values, database connections, deployment rules, and other information that the scripts require to complete the deployment process
Output - ZTIBIOSCheck.log. Log file that contains events that this script generates

- BDD.log. Log file that contains events that all MDT scripts generate
References ZTIUtility.vbs. Includes support functions and subroutines that the script uses
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

ZTICoalesce.wsf

Configuration Manager requires packages to be numbered sequentially starting with PACKAGES001, with no gaps in the number sequence. Otherwise, installation will fail.

This script allows you to define and name variables using identifying information about the program to run—for example, ComputerPackages100, ComputerPackages110, or CollectionPackages150. Then, when this script is run, Configuration Manager finds all variables that match a pattern (for example, all variable names that contain the string Packages) and builds a sequential list, without gaps, using the base name PACKAGES.

For example, if the following variables were defined (using computer variables, collection variables, or in CustomSettings.ini or the MDT DB, for example):

  • ComputerPackages100=XXX00001:Program

  • ComputerPackages110=XXX00002:Program

  • CollectionPackages150=XXX00003:Program

  • Packages001=XXX00004:Program

    After the script runs, the list would be:

  • PACKAGES001=XXX00004:Program

  • PACKAGES002=XXX00001:Program

  • PACKAGES003=XXX00002:Program

  • PACKAGES004=XXX00003:Program

    Configuration Manager would then be able to run all four programs.

Value Description
Input Environment variables. Contains the property values, custom property values, database connections, deployment rules, and other information that the scripts require to complete the deployment process
Output - ZTICoalesce.log. Log file that contains events that this script generates

- BDD.log. Log file that contains events that all MDT scripts generate
References ZTIUtility.vbs. Includes support functions and subroutines that the script uses
Location distribution\Scripts
Use cscript ZTICoalesce.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.)
/CoalesceDigits:*value* Specifies the number of digits that need to be provided when creating the numbering sequence. For example, a value of:

- 2 would create PACKAGE03

- 3would create PACKAGE003

The default value if this argument is not provided is 3.

Properties

Name Read Write
CoalescePattern -
CoalesceTarget -

ZTIConfigFile.vbs

This script contains common routines for processing MDT XML files.

Value Description
Input Environment variables. Contains the property values, custom property values, database connections, deployment rules, and other information that the scripts require to complete the deployment process
Output - ZTIConfigFile.log. Log file that contains events that this script generates

- BDD.log. Log file that contains events that all MDT scripts generate
References Net.exe
Location distribution\Scripts
Use <script language="VBScript" src="ZTIConfigFile.vbs"/>

Arguments

Value Description
None None

Properties

Name Read Write
IsSafeForWizardHTML -
MandatoryApplications -
SkipGroupSubFolders -

ZTIConfigure.wsf

This script configures the Unattend.xml file with the property values specified earlier in the MDT 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 file 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 file.

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 that the scripts require to complete the deployment process
Output - ZTIConfigure.log. Log file that contains events that this script generates

- BDD.log. Log file that contains events that all MDT scripts generate
References ZTIUtility.vbs. Includes support functions and subroutines that the script uses
Location distribution\Scripts
Use cscript ZTIConfigure.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
ComputerName - -
DeploymentType -
DeploymentMethod -
DeployRoot -
DestinationLogicalDrive -
DomainAdminDomain -
ImageBuild -
OSDAnswerFilePath -
OSDAnswerFilePathSysprep -
OSDComputerName -
Phase -
TaskSequenceID -

ZTIConfigureADDS.wsf

Value Description
Input Environment variables. Contains the property values, custom property values, database connections, deployment rules, and other information that the scripts require to complete the deployment process
Output - ZTIConfigureADDS.log. Log file that contains events that this script generates

- BDD.log. Log file that contains events that all MDT scripts generate
References - Dcpromo.exe. Installs and removes AD DS

- Net.exe. Performs network management tasks

- ZTIUtility.vbs. Includes support functions and subroutines that the script uses
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
ADDSLogPath -
ADDSPassword -
ADDSUserDomain -
ADDSUserName -
AutoConfigDNS -
ChildName -
ConfirmGC -
DatabasePath -
DomainLevel -
DomainNetBiosName -
ForestLevel -
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 before running this script.

Value Description
Input Environment variables. Contains the property values, custom property values, database connections, deployment rules, and other information that the scripts require to complete the deployment process
Output - ZTIConfigureDHCP.log. Log file that contains events that this script generates

- BDD.log. Log file that contains events that all MDT scripts generate
References - Netsh.exe. A utility that permits automating the configuration of networking components

- ZTIUtility.vbs. Includes support functions and subroutines that the script uses
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
DHCPScopesxDescription -
DHCPScopesxEndIP -
DHCPScopesxExcludeStartIP -
DHCPScopesxExcludeEndIP -
DHCPScopesxIP -
DHCPScopesxName -
DHCPScopesxOptionRouter -
DHCPScopesxOptionDNSDomainName -
DHCPScopesxOptionDNSServer -
DHCPScopesxOptionLease -
DHCPScopesxOptionNBTNodeType -
DHCPScopesxOptionPXEClient -
DHCPScopesxOptionWINSServer -
DHCPScopesxStartIP -
DHCPScopesxSubnetmask -
DHCPServerOptionDNSDomainName -
DHCPServerOptionDNSServer -
DHCPServerOptionNBTNodeType -
DHCPServerOptionPXEClient -
DHCPServerOptionRouter -
DHCPServerOptionWINSServer -

Note

The xin the properties listed here is a placeholder for a zero-based array that contains DHCP configuration information.

ZTIConfigureDNS.wsf

This script configures DNS on the target computer. To perform the actual configuration tasks, the script uses the Dnscmd utility.

For more information about Dnscmd.exe, see Dnscmd Overview.

Note

DNS should already be installed on the target computer before running this script.

Value Description
Input Environment variables. Contains the property values, custom property values, database connections, deployment rules, and other information that the scripts require to complete the deployment process
Output - ZTIConfigureDNS.log. Log file that contains events that this script generates

- BDD.log. Log file that contains events that all MDT scripts generate
References - Dnscmd.exe. Assists administrators with DNS management

- ZTIUtility.vbs. Includes support functions and subroutines that the script uses
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
DNSServerOptionDisableRecursion -
DNSServerOptionBINDSecondaries -
DNSServerOptionFailOnLoad -
DNSServerOptionEnableRoundRobin -
DNSServerOptionEnableNetmaskOrdering -
DNSServerOptionEnableSecureCache -
DNSServerOptionNameCheckFlag -
DNSZonesxName -
DNSZonesxType -
DNSZonesxMasterIP -
DNSZonesxDirectoryPartition -
DNSZonesxFileName -
DNSZonesxScavenge -
DNSZonesxUpdate -

Note

The xin the properties listed here is a placeholder for a zero-based array that contains DNS configuration information.

ZTIConnect.wsf

The MDT 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 that the scripts require to complete the deployment process
Output - ZTIConnect.log. Log file that contains events that this script generates

- BDD.log. Log file that contains events that all MDT scripts generate
References ZTIUtility.vbs. Includes support functions and subroutines that the script uses
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 that the SLShare property specifies. The subfolder takes the name that OSDComputerName, _SMSTSMachineName, or HostName specifies.

Value Description
Input Environment variables. Contains the property values, custom property values, database connections, deployment rules, and other information that the scripts require to complete the deployment process
Output - ZTICopyLogs.log. Log file that contains events that this script generates

- BDD.log. Log file that contains events that all MDT scripts generate
References ZTIUtility.vbs. Includes support functions and subroutines that the script uses
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
None

ZTIDataAccess.vbs

This script contains common routines for database access.

Value Description
Input Environment variables. Contains the property values, custom property values, database connections, deployment rules, and other information that the scripts require to complete the deployment process
Output - ZTIDataAccess.log. Log file that contains events that this script generates

- BDD.log. Log file that contains events that all MDT scripts generate
References None
Location distribution\Scripts
Use <script language="VBScript" src="ZTIDataAccess.vbs"/>

Arguments

Value Description
None None

Properties

Name Read Write
_SMSTSReserved1 -
_SMSTSReserved2 -
RulesFile -
UserDomain - -
UserID - -
UserPassword - -

ZTIDisableBDEProtectors.wsf

If BitLocker is enabled, this script suspends the BitLocker protectors configured on the system.

Value Description
Input Environment variables. Contains the property values, custom property values, database connections, deployment rules, and other information that the scripts require to complete the deployment process
Output - ZTIDisableBDEProtectors.log. Log file that contains events that this script generates

- BDD.log. Log file that contains events that all MDT scripts generate
References ZTIUtility.vbs. Includes support functions and subroutines that the script uses
Location distribution\Scripts
Use cscript ZTIDisableBDEProtectors.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
ImageBuild -
ISBDE -
OSCurrentBuild -
OSCurrentVersion -
OSVersion -

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 by the Task Sequencer or in CustomSettings.ini. ZTIDiskpart.wsf is primarily run in New Computer scenarios. The process works like this:

  1. The MDT 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 Diskpart.exe and provides a .txt file as a command-line parameter.

  4. The disk is initially cleaned by sending Diskpart the CLEAN command.

  5. If this is the first disk and no disk configuration has been specified by the Task Sequencer or in CustomSettings.ini, a single partition is created to store the operating system. However, if a disk configuration has been specified, the disk will be configured according to the specified configuration.

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

  7. All format commands are queued until after Diskpart has finished. If not explicitly specified by the Task Sequencer or in CustomSettings.ini, ZTIDiskpart.wsf performs a quick format of drive C using the following command: 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.

    Customize the disk configuration of the target computer by providing the required information in the Task Sequencer or in CustomSettings.ini.

    For more information about configuring disks, see the MDT document Using the Microsoft Deployment Toolkit.

Value Description
Input Environment variables. Contains the property values, custom property values, database connections, deployment rules, and other information that the scripts require to complete the deployment process
Output - ZTIDiskpart.log. Log file that contains events that this script generates

- BDD.log. Log file that contains events that all MDT scripts generate
References - Diskpart.exe. Utility that allows for the automated management of disks, partitions, and volumes

- Format.com. Formats the hard disk

- ZTIDiskUtility.vbs. Includes support functions and subroutines that the script uses

- ZTIUtility.vbs. Includes support functions and subroutines that the script uses
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 -
DeployDrive -
DeploymentType -
DestinationDisk -
DestinationLogicalDrive -
DoNotCreateExtraPartition -
ImageBuild -
OSDDiskIndex -
OSDDiskpartBiosCompatibilityMode - -
OSDDiskType -
OSDPartitions -
OSDPartitionStyle -
SMSTSLocalDataDrive -
VolumeLetterVariable -

ZTIDiskUtility.vbs

This script contains disk-related functions and subroutines that the various scripts in the MDT deployment process call.

Value Description
Input None
Output - ZTIDiskUtility.log. Log file that contains events that this script generates

- BDD.log. Log file that contains events that all MDT scripts generate
References - BcdBoot.exe. Configures the system partition

- DiskPart.exe. Utility that allows for the automated management of disks, partitions, and volumes
Location distribution\Scripts
Use <script language="VBScript" src="ZTIDiskUtility.vbs"/>

Arguments

Value Description
None None

Properties

Name Read Write
DestinationLogicalDrive -
UILanguage - -

ZTIDomainJoin.wsf

During the State Restore deployment phase, this script verifies that the computer is joined to a domain and recovers from failed attempts to join a domain.

Value Description
Input Environment variables. Contains the property values, custom property values, database connections, deployment rules, and other information that the scripts require to complete the deployment process
Output - ZTIDomainJoin.log. Log file that contains events that this script generates

- BDD.log. Log file that contains events that all MDT scripts generate
References - LTISuspend.wsf

- ZTIUtility.vbs. Includes support functions and subroutines that the script uses
Location distribution\Scripts
Use cscript ZTIDomainJoin.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.)
/DomainErrorRecovery: *value* Attempts to join the computer to the domain. If the value specified in value is:

- AUTO. Retry the domain join process. Restart and retry. This is the default script behavior.

- FAIL. Stops all processing. All task sequence processing stops.

- MANUAL. Stop processing; allows the user to manually join the computer to the domain.

Properties

Name Read Write
DomainAdmin -
DomainAdminDomain -
DomainAdminPassword -
DomainErrorRecovery -
DomainJoinAttempts - -
JoinDomain -
JoinWorkgroup -
LTISuspend -
MachineObjectOU -
SMSTSRebootRequested -
SMSTSRetryRequested -

ZTIDrivers.wsf

This script installs additional device drivers onto the target computer before 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 by and managed in the Drivers node in the Deployment Workbench) to the target computer.

Value Description
Input Environment variables. Contains the property values, custom property values, database connections, deployment rules, and other information that the scripts require 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 that this script generates

- BDD.log. Log file that contains events that all MDT scripts generate
References - Attrib.exe. Sets file and folder attributes

- CMD.exe. Allows running of command-line tools

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

- Reg.exe. The console registry tool for reading and modifying registry data

- ZTIConfigFile.vbs. Includes routines for processing XML files

- ZTIUtility.vbs. Includes support functions and subroutines that the script uses
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 -
CustomDriverSelectionProfile -
DeploymentMethod -
DeploymentType -
DestinationLogicalDrive - -
DoCapture -
DriverPaths -
DriverSelectionProfile -
ImageBuild -
InstallFromPath -
OSDAnswerFilePath -
OSDAnswerFilePathSysPrep -
OSDPlatformArch -
Phase -
ResourceRoot -

ZTIExecuteRunbook.wsf

This script runs Orchestrator runbooks on the target computer. An Orchestrator runbook is the sequence of activities that orchestrate actions on computers and networks. You can initiate Orchestrator runbooks in MDT using the Execute Runbook task sequence step type, which in turn runs this script.

Value Description
Input Environment variables contain the property values, custom property values, database connections, deployment rules, and other information that the scripts require to complete the deployment process.
Output - BDD.log contains events that all MDT scripts generate.

- Return status of the runbook completion.

- Return parameters from the runbook output.
References - ZTIUtility.vbs includes support functions and subroutines that the script uses.
Location distribution\Scripts
Use cscript ZTIExecuteRunbook.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
OrchestratorServer -
RunbookName -
RunbookID -
RunbookParameterMode -
RunbookParametersxParameterID -
RunbookParametersxParameterValue -
RunbookOutputParameters

Note:

If a runbook returns output parameters, a task sequence variable is created for each parameter and the return value of the parameter is assigned to the task sequence variable.
-

This script creates the task sequence variables listed in the following table for internal script use. Do not set these task sequence variables in CustomSettings.ini or in the MDT DB.

Name Description
OrchestratorServer Name of the server running Orchestrator specified in Orchestrator Server in the Execute Runbook task sequence step
RunbookName Name of the runbook specified in Runbook in the Execute Runbook task sequence step
RunbookID Identifier assigned to the runbook on the Orchestrator server
RunbookParametersxParameterID Identifier assigned to a specific runbook parameter on the Orchestrator server
RunbookParametersxParameterName Name assigned to a specific runbook parameter on the Orchestrator server
RunbookParametersxParameterValue Value assigned to a specific runbook parameter on the Orchestrator server

ZTIGather.wsf

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

Value Description
Input Environment variables. Contains the property values, custom property values, database connections, deployment rules, and other information that the scripts require to complete the deployment process
Output - ZTIGather.log. Log file that contains events that this script generates

- BDD.log. Log file that contains events that all MDT scripts generate
References - Wpeutil.exe. Initializes Windows PE and network connections; initiates LTI

- ZTIDataAccess.vbs. Contains routines for database access

- ZTIUtility.vbs. Includes support functions and subroutines that the script uses
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 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); returns properties and rules specified in the .ini file

If not specified, the script returns information about the target computer and the currently installed operating system; parses 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 processIf not specified, the script uses the default value in 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 that script backs up. The script is called with the/restore argument to restore the group membership after the operating system is deployed. When performing a restore operation, it restores 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 that the scripts require to complete the deployment process
Output - ZTIGroups.log. Log file that contains events that this script generates

- BDD.log. Log file that contains events that all MDT scripts generates
References ZTIUtility.vbs. Includes support functions and subroutines that the script uses
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

This script installs language packs for Windows operating systems.

Value Description
Input Environment variables. Contains the property values, custom property values, database connections, deployment rules, and other information that the scripts require to complete the deployment process
Output - ZTILangPacksOnline.log. Log file that contains events that this script generates

- BDD.log. Log file that contains events that all MDT scripts generate
References - CMD.exe. Allows running of command-line tools

- Lpksetup.exe. The Language Pack Setup tool used to add or remove language packs

- ZTIUtility.vbs. Includes support functions and subroutines that the script uses
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 -

ZTIModifyVol.wsf

This script modifies a volume to set the GPT ID and attributes for utility volumes, which is necessary for creating Windows RE partitions on computers with UEFI. This script needs to be called when deploying to computers with UEFI for these situations:

  • LTI deployments where custom partition (volume) structures are being created, such as creating five partition instead of the standard four partitions that are typicaly created for use with UEFI

  • All ZTI and UDI deployments

Note

This script is intended to be called only when creating partitions structures for use with UEFI. This script should not be called when creating partition structures to be used in deployments without UEFI.

Value Description
Input Environment variables. Contains the property values, custom property values, database connections, deployment rules, and other information that the scripts require to complete the deployment process
Output BDD.log contains events that all MDT scripts generate.
References ZTIUtility.vbs includes support functions and subroutines that the script uses.
Location distribution\Scripts
Use cscript ZTIModifyVol.wsf /UtilityVol:value </debug:value>

Arguments

Value Description
/UtilityVol:*value* Provides the drive letter of the volume that needs to be configured for a Windows RE Tools partition for use with computers with UEFI (for example, "E:")
/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
UtilityVol -

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 Configuration Manager.

Value Description
Input Environment variables. Contains the property values, custom property values, database connections, deployment rules, and other information that the scripts require to complete the deployment process
Output - ZTIMoveStateStore.log. Log file that contains events that this script generates

- BDD.log. Log file that contains events that all MDT scripts generate
References ZTIUtility.vbs. Includes support functions and subroutines that the script uses
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 Properties.

Value Description
Input Environment variables. Contains the property values, custom property values, database connections, deployment rules, and other information that the scripts require to complete the deployment process
Output - ZTINextPhase.log. Log file that contains events that this script generates

- BDD.log. Log file that contains events that all MDT scripts generate
References ZTIUtility.vbs. Includes support functions and subroutines that the script uses
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 ZTIGather.wsf captured based on the properties listed in the CustomSettings.ini file or the MDT DB (created in the Database node in the Deployment Workbench).

Value Description
Input Environment variables. Contains the property values, custom property values, database connections, deployment rules, and other information that the scripts require to complete the deployment process
Output - ZTINICConfig.log. Log file that contains events that this script generates

- BDD.log. Log file that contains events that all MDT scripts generate
References - ZTIUtility.vbs. Includes support functions and subroutines that the script uses

- ZTINicUtility.vbs. Includes support functions and subroutines that the script uses
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 captures those settings and saves 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 computers for automation.
/RestoreWithinWinPE When specified, applies any saved static IP network settings to the local computer, when appropriate; used for internal processing only.

Properties

Name Read Write
DeployDrive - -
DeploymentMethod -
DeploymentType -
DeployRoot -
OSDAdapterCount - -
OSGuid -
OSDMigrateAdapterSettings -
Phase -

ZTINICUtility.vbs

This script contains network adapter–related functions and subroutines that the various scripts in the MDT deployment process call.

Value Description
Input None
Output None
References - CMD.exe. Allows running of command-line tools

- Netsh.exe. A utility used to automate the configuration of networking components
Location distribution\Scripts
Use <script language="VBScript" src="ZTINicUtility.vbs"/>

Arguments

Value Description
None None

Properties

Name Read Write
OSDAdapter*AdapterIndexAdapterName* - -

Note

AdapterIndexin this property is a placeholder for a zero-based array that contains network adapter information.

ZTIOSRole.wsf

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

Note

This script is intended to be called only by the Install Roles and Features andUninstall Roles and Features task sequence steps. Calling this script directly is not supported.

Value Description
Input Environment variables. Contains the property values, custom property values, database connections, deployment rules, and other information that the scripts require to complete the deployment process
Output - ZTIOSRole.log. Log file that contains events that this script generates

- BDD.log. Log file that contains events that all MDT scripts generate
References - CMD.exe. Allows running of command-line tools

- OCSetup.exe. Adds or to removes Windows optional components

- ServerManagerCmd.exe. Installs, configures, and manages Windows Server roles and features

- Sysocmgr.exe. Adds or removes Windows components

- ZTIUtility.vbs. Includes support functions and subroutines that the script uses
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.)
/Uninstall If provided, this argument indicates that the roles and features will be uninstalled. If not provided, the script assumes the roles and features will be installed.

Properties

Name Read Write
IsServerCoreOS -
OSFeatures -
OSRoles -
OSRoleServices -
OSVersion -
SMSTSRebootRequested -

ZTIPatches.wsf

This script installs updates (language packs, security updates, and so on) that are listed in the Packages.xml file. The script self-terminates if the deployment is not in one of the following states:

  • Phase equals PREINSTALL

  • DeploymentMethod equals SCCM

    The script starts Pkgmgr if DeploymentMethod equals SCCM.

Value Description
Input Environment variables. Contains the property values, custom property values, database connections, deployment rules, and other information that the scripts require to complete the deployment process
Output - ZTIPatches.log. Log file that contains events that this script generates

- BDD.log. Log file that contains events that all MDT scripts generate
References - Expand.exe. Expands compressed files

- Pkgmgr.exe. Installs or updates Windows Vista offline

- ZTIConfigFile.vbs. Includes routines for processing XML files

- ZTIUtility.vbs. Includes support functions and subroutines that the script uses
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 -
CustomPackageSelectionProfile -
DeployRoot -
DeploymentMethod -
DeploymentType -
DestinationLogicalDrive -
LanguagePacks -
OSDAnswerFilePath -
OSDPlatformArch -
PackageSelectionProfile -
Phase -
ResourceRoot -

ZTIPowerShell.wsf

This script runs a Windows PowerShell script using a custom Windows PowerShell host.

Value Description
Input Environment variables. Contains the property values, custom property values, database connections, deployment rules, and other information that the scripts require to complete the deployment process
Output - ZTIPowerShell.log. Log file that contains events that this script generates

- BDD.log. Log file that contains events that all MDT scripts generate

- Return code. The numeric value returned by the Windows PowerShell script after completion, which indicates the completion status of the script.
References - Microsoft.BDD.TaskSequencePSHost.exe. Custom Windows PowerShell host used to run the Windows PowerShell script.
Location distribution\Scripts
Use cscript ZTIPowerShell.wsf

Arguments

Value Description
None

Properties

Name Read Write
None

ZTIPrereq.vbs

This script verifies that the target computer has the prerequisite software installed and that it is functional. The checks the script performs are:

  • Determine whether 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 fails, 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

ZTISCCM.wsf

This script initializes ZTI when deploying using Configuration Manager. The script performs the following procedure:

  1. If debugging is activated, the script creates the OSD.Debug file.

  2. The script configures these properties:

    • ScriptRootis set to the parent folder of the currently running script.

    • DeployRoot is set to the parent folder of ScriptRoot.

    • ResourceRoot is set to DeployRoot.

    • DeploySystemDrive is set to C:.

    • DeploymentMethod is set to SCCM.

  3. When DeployRootcontains :\:

    • The DeployRoot folder is copied to _SMSTSMDataPath\WDPackage

    • ScriptRoot is set to _SMSTSMDataPath\WDPackage\Scripts

    • DeployRoot is set to the parent folder of ScriptRoot

    • ResourceRoot is set to DeployRoot

  4. When Phase is NULL:

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

    • If the OldComputer.tag file exists in the parent folder of the current running script, 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 Properties.

Value Description
Input Environment variables. Contains the property values, custom property values, database connections, deployment rules, and other information that the scripts require to complete the deployment process
Output - ZTISCCM.log. Log file that contains events that this script generates

- BDD.log. Log file that contains events that all MDT scripts generate
References ZTIUtility.vbs. Includes support functions and subroutines that the script uses
Location distribution\Scripts
Use cscript ZTISCCM.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 -
Architecture -
BDDPackageID - -
DeploymentMethod - -
DeploymentType - -
DeployRoot - -
Phase - -
ResourceRoot - -
ScriptRoot - -
ToolRoot - -

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 that the scripts require to complete the deployment process
Output - ZTISetVariable.log. Log file that contains events that this script generates

- BDD.log. Log file that contains events that all MDT scripts generate
References ZTIUtility.vbs. Includes support functions and subroutines that the script uses
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 tattoos the target computer with identification and version information. The script performs the following procedure:

  1. 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 before starting the copy operation.

  2. Mofcomp.exe will be run using the following command:

    %SystemRoot%\System32\Wbem\Mofcomp.exe -autorecover %SystemRoot%\System32\Wbem\ZTITatoo.mof.  
    
  3. For all deployment methods (LTI, ZTI, and UDI), these deployment details are written for all deployment methods to the registry at HKEY_LOCAL_MACHINE\Software\Microsoft\Deployment 4:

    • Deployment Method is set to the deployment method being used and can be set to LTI, ZTI, or UDI, depending on the deployment method being performed.

    • Deployment Source is set to the source for the deployment and can be set to OEM, MEDIA, or the value in the DeploymentMethod property.

    • Deployment Type is set to the DeploymentType property.

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

    • Deployment Toolkit Version is set to the Version property.

  4. For LTI deployments, these deployment details are written to the registry at HKEY_LOCAL_MACHINE\Software\Microsoft\Deployment 4:

    • Task Sequence ID is set to the TaskSequenceIDproperty.

    • Task Sequence Name is set to the TaskSequenceName property.

    • Task Sequence Version is set to the TaskSequenceVersion property.

  5. For all Configuration Manager deployments (ZTI and UDI for Configuration Manager), these deployment details are written to the registry at HKEY_LOCAL_MACHINE\Software\Microsoft\Deployment 4:

    • OSD Package ID is set to the _SMSTSPackageID task sequence variable.

    • OSD Program Name is always set to "\*".

    • OSD Advertisement ID is set to the _SMSTSAdvertID task sequence variable.

  6. For LTI deployments where an image is being captured, these deployment details are written to the registry at HKEY_LOCAL_MACHINE\Software\Microsoft\Deployment 4:

    • Capture Method is set to the deployment method being used and can be set to LTI, ZTI, or UDI, depending on the deployment method being performed.

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

    • Capture Toolkit Version is set to the Version property.

    • Capture Task Sequence ID is set to the TaskSequenceIDproperty.

    • Capture Task Sequence Name is set to the TaskSequenceName property.

    • Capture Task Sequence Version is set to the TaskSequenceVersion property.

  7. For all Configuration Manager deployments (ZTI and UDI for Configuration Manager) in which an image is being captured, these deployment details are written to the registry at HKEY_LOCAL_MACHINE\Software\Microsoft\Deployment 4:

    • Capture OSD Package ID is set to the _SMSTSPackageID task sequence variable.

    • Capture OSD Program Name is always set to "*****".

    • Capture OSD Advertisement ID is set to the _SMSTSAdvertIDtask sequence variable.

    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 that the scripts require to complete the deployment process
Output - ZTITatoo.log. Log file that contains events that this script generates

- BDD.log. Log file that contains events that all MDT scripts generate
References - Mofcomp.exe. Command-line .mof file compiler

- ZTIUtility.vbs. Includes support functions and subroutines that the script uses
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
_SMSTSAdvertID -
_SMSTSPackageID -
_SMSTSSiteCode -
DeploymentMethod -
DeploymentType -
Version -
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 that the scripts require to complete the deployment process
Output - ZTIUserState.log. Log file that contains events that this script generates

- BDD.log. Log file that contains events that all MDT scripts generate
References - CMD.exe. Allows running of command-line tools

- 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

- USMT Application Files

- ZTIUtility.vbs. Includes support functions and subroutines that the script uses
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.)
/Capture
/Estimate
/Restore

Properties

Name Read Write
Architecture -
DeploymentMethod -
DeploymentType -
DestinationLogicalDrive -
ImageBuild -
ImageSize -
ImageSizeMultiplier -
InstallFromPath -
IsServerOS -
LoadStateArgs -
OSCurrentVersion -
OSDMigrateAdditionalCaptureOptions - -
OSDMigrateAdditionalRestoreOptions - -
OSDPackagePath -
OSDStateStorePath -
OSVersion -
ScanStateArgs -
StatePath - -
UDDir -
UDProfiles -
UDShare -
UserDataLocation - -
USMTConfigFile -
USMTEstimate - -
USMTLocal -
USMTMigFiles -

ZTIUtility.vbs

This script contains utility functions that most of the MDT scripts use.

Value Description
Input Environment variables. Contains the property values, custom property values, database connections, deployment rules, and other information that the scripts require to complete the deployment process
Output None
References - Credentials_ENU.xml. Prompts the user for credentials that will be used when connecting to network resources

- IPConfig.exe. Displays all current TCP/IP network configuration values and refreshes DHCP and DNS settings

- MSHTA.exe. HTML application host

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

- Xcopy.exe. Copies files and directories, including subdirectories
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 -
_SMSTSMachineName -
_SMSTSNextInstructionPointer -
_SMSTSOrgName -
_SMSTSPackageID -
_SMSTSPackageName -
_SMSTSPackagePath -
_SMSTSReserved1 -
_SMSTSReserved2 -
Architecture -
AssetTag -
ComputerName -
Debug - -
DeploymentMethod -
DeployRoot -
DestinationDisk - -
DestinationLogicalDrive - -
DestinationPartition - -
EventShare -
HostName -
ImageBuild - -
ImageFlags -
ImageIndex -
ImageLanguage -
ImageProcessor -
ImageSize -
InstallFromPath -
JoinDomain -
LogPath - -
MacAddress -
OSCurrentVersion -
OSDAdvertID -
OSDAnswerFilePath - -
OSDAnswerFilePathSysprep - -
OSDComputerName - -
OSDPackageID -
OSDPackagePath -
OSDTargetSystemDrive -
OSGUID -
OSSKU -
OSVersion -
Phase -
Processor_Architecture -
ResourceRoot -
SLShare -
SLShareDynamicLogging -
TaskSequenceID -
TaskSequenceName -
TaskSequenceVersion -
UDDir -
UDShare -
UserDomain - -
UserID - -
UserPassword - -
UUID -
Version

Note: This variable is an internal variable that represents the version of MDT.
- -
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 and the target computer is a server, the script exits.

  • If OSInstall exists and is not equal to YES, the script exits.

  • Verify that the minimum amount of RAM exists on the target computer; if not, the script exits.

  • Verify that the processor meets the minimum required speed; if not, the script exits.

  • Verify that the hard disk size meets the minimum size requirements; if not, the script exits.

  • Verify that the target computer’s operating system is installed on drive C; if not, the script exits.

  • If DeploymentType = 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 that the scripts require to complete the deployment process
Output - ZTIValidate.log. Log file that contains events that this script generates

- BDD.log. Log file that contains events that all MDT scripts generate
References - Compact.exe. Displays or alters the compression of files on NTFS file system partitions

- ZTIUtility.vbs. Includes support functions and subroutines that the script uses
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 -
DestinationLogicalDrive - -
ImageBuild -
ImageMemory -
ImageProcessorSpeed -
ImageSize -
ImageSizeMultiplier -
IsServerOS -
Memory -
OSDPackagePath -
OSInstall -
ProcessorSpeed -
SMSTSLocalDataDrive -
VerifyOS -

ZTIVHDCreate.wsf

This script is used to create a virtual hard disk (.vhd or .avhd) file on the target computer and mount the .vhd file as a disk. Then, other portions of the LTI deployment process deploy the Windows operating system and applications to the newly created virtual hard disk. The script processes are as follows:

  • The Class_Initialize method is used to initialize the VHDInputVariable variable.

  • Validate that VHDCreateSource is defined and locates the source .vhd file (if specified).

  • Generate a random .vhd file name if VHDCreateFilename equals RANDOM or "" (null).

  • Verify that the folder exists where the .vhd file (specified in VHDCreateFileName) is to be created.

  • Create the .vhd file using the values in VHDCreateSizePercent, VHDCreateSizeMax, and VHDCreateType.

  • Create a differencing disk (if specified) using the value in VHDCreateDiffVHD.

  • The newly created .vhd file and the optional differencing disk are mounted.

  • The disk number of the mounted virtual hard disk is returned.

Value Description
Input Environment variables. Contains the property values, custom property values, database connections, deployment rules, and other information that the scripts require to complete the deployment process
Output - ZTIVHDCreate.log. Log file that contains events that this script generates

- BDD.log. Log file that contains events that all MDT scripts generate
References - ZTIDiskUtility.vbs. Includes support functions and subroutines the script uses

- ZTIUtility.vbs. Includes support functions and subroutines that the script uses
Location distribution\Scripts
Use cscript ZTIVHDCreate.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
VHDCreateDiffVHD -
VHDCreateFileName -
VHDCreateSizeMax -
VHDCreateSource -
VHDCreateType -
VHDDisks -
VHDInputVariable -
VHDOutputVariable -

ZTIWindowsUpdate.wsf

This script downloads and installs updates from computers on a corporate network that are running WSUS, Windows Update, or Microsoft Update using the Windows Update Agent (WUA) application programming interface (API). By default, this feature is disabled in each task sequence and must be manually activated to run.

Most enterprises will already have teams and infrastructures in place to update newly deployed computers over the corporate network. This process involves tracking the latest set of patches, drivers, and updates available for each desktop configuration and determining which updates should be downloaded and installed for each configuration. If the organization already has an established process, this script might not be necessary. This script was designed to fill a need for deployment teams that might not have established processes, yet want to ensure that target computers are updated when deployed.

This script automatically scans the target computer and downloads a wide range of updates that are found to be applicable. Among these are:

  • Windows service packs

  • Non-Microsoft drivers that were placed on Windows Update

  • The latest hotfix updates

  • Microsoft Office updates

  • Microsoft Exchange Server and SQL Server updates

  • Microsoft Visual Studio® updates

  • Some non-Microsoft application updates

Tip

Many hardware manufacturers have placed their drivers on Windows Update. These drivers no longer need to be maintained in the Out-of-Box Drivers directory. Experiment by removing drivers from the distribution share to see which ones are available on Windows Update. Note that if the drivers are not included with Windows by default, do not remove networking or storage drivers, because the operating system will require user input.

MDT supports the ability to deploy an updated version of WUA as part of the operating system deployment. This helps ensure that target computers are running the correct version of WUA when they are deployed. It also helps eliminate the need to connect to the Internet and download the latest version of WUA after deployment.

MDT can also configure WUA to collect updates from computers on the corporate network that are running WSUS instead of connecting to Microsoft Updates over the Internet. MDT can optionally configure WUA to use a specific computer running WSUS using the WSUSServer property.

For additional information and for WUA deployment instructions, see How to Install the Windows Update Agent on Client Computers.

Obtain the latest version of the WUA stand-alone installer for:

  • x86 versions (WindowsUpdateAgent30-x86.exe) at http://go.microsoft.com/fwlink/?LinkID=100334

  • x64 version (WindowsUpdateAgent30-x64.exe) at http://go.microsoft.com/fwlink/?LinkID=100335

    Windows 7 and later include the most recent version of WUA, so no upgrade is necessary.

    For more information, see Updating Windows Update Agent.

    When enabled in the Task Sequencer, this script runs multiple times while in the State Restore Phase of operating system deployment. It is first run after the operating system has started for the first time. Ensure that the latest updates and service packs are installed before the installation of any applications that might depend on specific updates or service packs being installed on the target computer. For example, an application might be dependent on the latest version of the Microsoft .NET Framework being installed.

    This script also runs after the installation of applications, which ensures that the latest application service packs and updates have been applied. For example, use this script to ensure that the latest updates are applied to Microsoft Office 2010 or the 2007 Office system.

    It is possible, during the installation of one or more updates, the target computer will need to be restarted to allow an update installation to finish fully. To ensure that updates are properly installed, if the script detects that the installation of an update requires the target computer to be restarted, the script automatically restarts the target computer and resumes if additional updates have been detected and are pending installation. The script exits if it determines that the target computer is fully up to date. An error will be logged if, while updating the target computer, the script has seven unsuccessful attempts to install the updates and the target computer still requires a restart.

    During run time, the script performs the following tasks:

  • Configure the target computer to use a WSUS server, if the WSUSServer property was specified.

  • Verify that the latest version ofthe WUA is installed on the target computer.

  • Search the target computer for applicable updates that are not already installed and that might be typically hidden.

  • Each update has an associated UpdateID and QNumber property:

    • The UpdateID property is in GUID form, such as 67da2176-5c57-4614-a514-33abbdd51f67.

    • The QNumber property is a numerical value, such as 987654.

  • The script compares the UpdateID and KBArticle property values against the list of exclusions specified in the following MDT properties:

    • WUMU_ExcludeID. A list of UpdateIDs to exclude; any update with an UpdateID found in this list will not be installed.

    • WUMU_ExcludeKB. A list of QNumbers to exclude; any update with a QNumber found in this list will not be installed.

    • In addition, any update that requires user input will be excluded and not installed.

  • All updates that require approval of an End User License Agreement (EULA) will automatically be approved by the script. Be sure to manually read and check each EULA before running this script in a production environment.

  • The activity for each update is written to the ZTIWindowsUpdate.log file, with the string INSTALL or SKIP if the update has been approved for installation, along with the UpdateID, a short description of the update, and the QNumber.

  • Each update to be installed is downloaded and installed in batches.

  • The target computer might require more than one restart during the update installation.

Note

Windows Internet Explorer 7 requires user interaction, so it is not installed using this script.

Note

By default, include QNumber 925471 in the WUMU_ExcludeKB list to prevent Windows Vista Ultimate from installing extra language packs.

Note

If intranet sources are not available, this script downloads files from two Microsoft sites: http://update.microsoft.com/redist/wuredist.cab and http://download.windowsupdate.com/v6/windowsupdate/redist/standalone/muauth.cab.

Value Description
Input Environment variables. Contains the property values, custom property values, database connections, deployment rules, and other information that the scripts require to complete the deployment process
Output - ZTIWindowsUpdate.log. Log file that contains events that this script generates

- BDD.log. Log file that contains events that all MDT scripts generate
References - Expand.exe. Expands compressed files

- Net.exe. Performs network management tasks

- WindowsUpdateAgent30-x86.exe. Installs WUA

- WindowsUpdateAgent30-x64.exe. Installs WUA

- ZTIUtility.vbs. Includes support functions and subroutines that the script uses
Location distribution\Scripts
Use cscript ZTIWindowsUpdate.wsf </debug:value> </UpdateCommand:"<IsInstalled=0&#124;1> <IsHidden=0&#124;1>"> </Query:true&#124;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.

Note

For more information about UpdateCommand, see IUpdateSearcher::Search Method.

Properties

Name Read Write
Architecture -
DoCapture -
InstalledUpdates -
MSIT_WU_Count - -
NoAutoUpdate_Previous - -
SMSTSRebootRequested - -
SMSTSRetryRequested - -
WSUSServer -
WUMU_ExcludeID -
WUMU_ExcludeKB -

ZTIWipeDisk.wsf

This script formats the target computer’s hard disk. 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 that the scripts require to complete the deployment process
Output - ZTIWipeDisk.log. Log file that contains events that this script generates

- BDD.log. Log file that contains events that all MDT scripts generate
References - CMD.exe. Allows running of command-line tools

- Format.com. Formats the hard disk

- ZTIUtility.vbs. Includes support functions and subroutines that the script uses
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
WipeDisk -

Support Files

The utilities and scripts used in LTI and ZTI deployments reference external configuration files to determine the process steps and configuration settings used during the deployment process.

The following information is provided for each utility:

  • Name. Specifies the name of the file

  • Description. Provides a description of the purpose of the file

  • Location. Indicates the folder where the file 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 MDT is installed.

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

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

ApplicationGroups.xml

Note

This XML file is managed by MDT and should not require modification.

Value Description
Location distribution\Control

Applications.xml

Note

This XML file is managed by MDT and should not require modification.

Value Description
Location distribution\Control

BootStrap.ini

The configuration file used when the target computer is not able to connect to the appropriate deployment share. This situation occurs in the New Computer and the Replace Computer scenarios.

Value Description
Location distribution\Control

CustomSettings.ini

The primary configuration file for the MDT processing rules used in all scenarios.

Value Description
Location distribution\Control

Deploy.xml

Note

This XML file is managed by MDT and should not require modification.

Value Description
Location program_files\Microsoft Deployment Toolkit\Control

DriverGroups.xml

Note

This XML file is managed by MDT and should not require modification.

Value Description
Location distribution\Control

Drivers.xml

Note

This XML file is managed by MDT and should not require modification.

Value Description
Location distribution\Control

LinkedDeploymentShares.xml

Note

This XML file is managed by MDT and should not require modification.

Value Description
Location distribution\Scripts

ListOfLanguages.xml

Note

This XML file is managed by MDT and should not require modification.

Value Description
Location distribution\Scripts

MediaGroups.xml

Note

This XML file is managed by MDT and should not require modification.

Value Description
Location distribution\Scripts

Medias.xml

Note

This XML file is managed by MDT and should not require modification.

Value Description
Location distribution\Scripts

OperatingSystemGroups.xml

Note

This XML file is managed by MDT and should not require modification.

Value Description
Location distribution\Control

OperatingSystems.xml

Note

This XML file is managed by MDT and should not require modification.

Value Description
Location distribution\Control

PackageGroups.xml

Note

This XML file is managed by MDT and should not require modification.

Value Description
Location distribution\Control

Packages.xml

Note

This XML file is managed by MDT and should not require modification.

Value Description
Location distribution\Control

SelectionProfileGroups.xml

Note

This XML file is managed by MDT and should not require modification.

Value Description
Location distribution\Control

SelectionProfiles.xml

Note

This XML file is managed by MDT and should not require modification.

Value Description
Location distribution\Control

ServerManager.xml

Note

This XML file is managed by MDT and should not require modification.

Value Description
Location program_files\Microsoft Deployment Toolkit\Bin

Settings.xml

Note

This XML file is managed by MDT and should not require modification.

Value Description
Location distribution\Control

TaskSequenceGroups.xml

Note

This XML file is managed by MDT and should not require modification.

Value Description
Location distribution\Control

TaskSequences.xml

Note

This XML file is managed by MDT and should not require modification.

Value Description
Location distribution\Control

TS.xml

Note

This XML file is managed by MDT and should not require modification.

Value Description
Location distribution\Control\task_sequence_id

Note

Task_sequence_id is a placeholder for the task sequence ID that was assigned to each task sequence when it was created in the Task Sequences node in the Deployment Workbench.

Wimscript.ini

This .ini file is an ImageX configuration file that contains the list of folders and files that will be excluded from an image. It is referenced by ImageX during the LTI Capture Phase.

For assistance with customizing this file, see the section, "Create an ImageX Configuration File," in the Windows Preinstallation Environment (Windows PE) User’s Guide.

Value Description
Location distribution\Tools\platform

ZTIBIOSCheck.xml

This XML file contains metadata about BIOSes for target computers. This file is edited manually and is read by ZTIBIOSCheck.wsf. Extract the necessary information from a target computer to create an entry in this XML file using the Microsoft Visual Basic® Scripting Edition (VBScript) program (ZTIBIOS_Extract_Utility.vbs) that is embedded in this XML file.

Value Description
Location distribution\Scripts

ZTIConfigure.xml

This XML file is used by the ZTIConfigure.wsf script to translate property values (specified earlier in the deployment process) to configure settings in the Unattend.xml file. This file is already customized to make the appropriate translations and should not require further modification.

Value Description
Location distribution\Scripts

ZTIGather.xml

Note

This XML file is preconfigured and should not require modification. Define custom properties in the CustomSettings.ini file or the MDT DB.

Value Description
Location distribution\Scripts

ZTIUserState_config.xml

This XML file is used by the ZTIUserState.wsf script as a default USMT configuration file. This file is used by default if no custom configuration file is specified by the USMTConfigFile property. See the Config.xml File topic in the USMT documentation for more information on syntax and use.

Value Description
Location distribution\Scripts

ZTITatoo.mof

This .mof file, when imported into the WMI repository of the target computer using Mofcomp.exe, creates the Microsoft_BDD_Info WMI class. This class contains deployment-related information, such as:

  • DeploymentMethod

  • DeploymentType

  • DeploymentTimestamp

  • BuildID

  • BuildName

  • BuildVersion

  • OSDPackageID

  • OSDProgramName

  • OSDAdvertisementID

  • TaskSequenceID

  • TaskSequenceName

  • TaskSequenceVersion

Value Description
Location distribution\Scripts

Utilities

The scripts used in LTI and ZTI reference utilities that perform specialized tasks supporting the steps used during the deployment process. Use the following information to help determine the correct utilities to include in actions and the valid arguments to provide when running each utility.

The following information is provided for each utility:

  • Name. Specifies the name of the utility

  • Description. Provides a description of the purpose of the utility

  • Location. Indicates the folder where the utility 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 MDT is installed.

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

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

  • Use.Provides the commands and options that can be specified

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

BCDBoot.exe

BCDBoot is a tool used to quickly set up a system partition or repair the boot environment located on the system partition. The system partition is set up by copying a small set of boot environment files from an installed Windows image. BCDBoot also creates a Boot Configuration Data (BCD) store on the system partition, with a new boot entry that enables Windows to boot to the installed Windows image.

Value Description
Location Included in the Windows source files

Arguments

Value Description
See the command-line help provided by this utility.

BDDRun.exe

This utility is run as an action by the Task Sequencer for executables (such as a script or other code) that require user interaction. By default, the task sequence cannot run an executable that requires user interaction. However, this utility allows the Task Sequencer to run an executable that requires user interaction.

The executable that requires user interaction is provided as an argument to this utility. This utility runs the executable in a separate command environment.

Note

This utility can only be used in LTI deployments. ZTI deployments prohibit any user interaction.

Value Description
Location distribution\Tools\platform
Use BDDRun.exe commandline

Arguments

Value Description
commandline The command to be run that requires user interaction

Note

Put double quotation marks around any part of the command-line portion of the argument that contains blanks. For example: BDDRun.exe MyAppInstall.exe /destinationdir: "%ProgramFiles%\AppName".

Bootsect.exe

Bootsect.exe updates the master boot code for hard disk partitions to switch between BOOTMGR and NTLDR. Use this utility to restore the boot sector on the computer.

For more information on Bootsect.exe, see the section, "Bootsect Command-Line Options," in the Windows Preinstallation Environment (Windows PE) User’s Guide.

Value Description
Location distribution\Tools\platform
Use bootsect.exe /nt52 C:

Arguments

Value Description
/Help Displays the use instructions listed here.
/nt52 Applies the master boot code compatible with NTLDR to SYS, ALL, or DriveLetter. The operating system installed on SYS, ALL, or DriveLetter must be an earlier version of Windows Vista.
/nt60 Applies the master boot code compatible with BOOTMGR to SYS, ALL, or DriveLetter. The operating system installed on SYS, ALL, or DriveLetter must be Windows Vista.
SYS Updates the master boot code on the system partition used to boot Windows.
All Updates the master boot code on all partitions. ALL does not necessarily update the boot code for each volume. Instead, this option updates the boot code on volumes that can be used as Windows boot volumes, which excludes any dynamic volumes not connected with an underlying disk partition. This restriction is present, because the boot code must be located at the beginning of a disk partition.
DriveLetter Updates the master boot code on the volume associated with this drive letter. The boot code will not be updated if either (1) DriveLetter is not associated with a volume or (2) DriveLetter is associated with a volume not connected to an underlying disk partition.
/Force Forcibly dismounts the volumes during the boot code update. Use this option with caution.

Compact.exe

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

Value Description
Location Included in the Windows source files

Arguments

Value Description
/C Compresses the specified files. Directories will be marked so that files added afterward will be compressed.
/V Decompresses the specified files. Directories will be marked so that files added afterward will not be compressed.
/S Performs the specified operation on files in the given directory and in all subdirectories. Default dir is the current directory.
/A Displays files with the hidden or system attributes. These files are omitted by default.
/I Continues performing the specified operation even after errors have occurred. By default, Compact.exe stops when an error is encountered.
/F Forces the compress operation on all specified files, even those which are already compressed. Already-compressed files are skipped by default.
/Q Reports only the most essential information.
filename Specifies a pattern, file, or directory.

Diskpart.exe

Diskpart is a text-mode command interpreter that allows management of objects (disks, partitions, or volumes) using scripts or direct input in a Command Prompt window.

For more information on Diskpart.exe, see the section, "Diskpart Command-Line Options," in the Windows Preinstallation Environment (Windows PE) User’s Guide.

Value Description
Location Included in the Windows PE source files

Arguments

Value Description
See the guide referenced in the utility description.

Expand.exe

This utility is run to expand (extract) files from compressed files.

Value Description
Location Included in the Windows source files
Use Expand.exe -r wuredist.cab -F:wuRedist.xml %temp%

Arguments

Value Description
-r Renames expanded files
-D Displays the list of files in the source directory
Source Source file specification (Wildcards can be used.)
-F:*Files* Name of files to expand from a .cab file
Destination Destination file | path specification (Destination can be a directory. If Source is multiple files and -r is not specified, Destination must be a directory.)

ImageX.exe

ImageX is a command-line utility that enables OEMs and corporations to capture, modify, and apply file-based disk images for rapid deployment. ImageX works with WIM files for copying to a network, or it can work with other technologies that use WIM images, such as Windows Setup and Windows Deployment Services.

For more information about ImageX, see the section, "What is ImageX," in the Windows Preinstallation Environment (Windows PE) User’s Guide.

Value Description
Location distribution\Tools\platform

Arguments

Value Description
See the guide referenced in the utility description.

Microsoft.BDD.PnpEnum.exe

This utility is run to enumerate Plug and Play devices installed on the target computer.

Value Description
Location distribution\Tools\platform

Arguments

Value Description
None

Mofcomp.exe

Mofcomp.exe is the Managed Object Format compiler that parses a file that contains Managed Object Format statements and adds the classes and class instances defined in the file to the WMI repository. Mofcomp.exe provides command-line help on the switch use options.

Value Description
Location Included in the Windows source files

Arguments

Value Description
See the command-line help that this utility provides.

Netsh.exe

Netsh.exe is a command-line and scripting utility used to automate the configuration of networking components. For more information about Netsh.exe, see The Netsh Command-Line Utility.

Value Description
Location Included in the Windows source files

Arguments

Value Description
See the command-line help that this utility provides or the information found at the URL listed in the utility description.

Reg.exe

The Console Registry Tool is used to read and modify registry data.

Value Description
Location Included in the Windows source files

Arguments

Value Description
See the command-line help that this utility provides.

Regsvr32.exe

This utility is used to register files (.dll, .exe, .ocx, and so on) with the operating system.

Value Description
Location Included in the Windows source files

Arguments

Value Description
file The name of the file to register or unregister
/s Runs the utility in silent mode
/u Unregisters the file

Wpeutil.exe

The Windows PE utility (Wpeutil) is a command-line utility with which various commands can be run in a Windows PE session. For example, an administrator can shut down or reboot Windows PE, activate or deactivate a firewall, configure language settings, and initialize a network. MDT uses the utility to initialize Windows PE and network connections, and start LTI deployments.

For more information on Wpeutil.exe, see the section, "Wpeutil Command-Line Options," in the Windows Preinstallation Environment (Windows PE) User’s Guide.

Value Description
Location Included in the Windows PE source files

Arguments

Value Description
See the guide referenced in the utility description.

MDT Windows PowerShell Cmdlets

In addition to the Deployment Workbench, MDT deployment shares can be managed using Windows PowerShell cmdlets. The MDT Windows PowerShell cmdlets are included in a Windows PowerShell snap-in—Microsoft.BDD.PSSnapIn—which is included with the installation of MDT.

The MDT cmdlets must be run from a Windows PowerShell console that has the MDT Windows PowerShell snap-in loaded. For more information on how to start a Windows PowerShell console that has the MDT Windows PowerShell snap-in loaded, see "Loading the MDT Windows PowerShell Snap-In".

Table 7 lists the MDT Windows PowerShell cmdlets and provides a brief description of each cmdlet. Each cmdlet is discussed in further detail in a subsequent section.

Table 7. MDT Windows PowerShell Cmdlets

Cmdlet Description
Add-MDTPersistentDrive Adds a deployment share to the list of MDT persisted drives that can be restored using the Restore-MDTPersistentDrive cmdlet.
Disable-MDTMonitorService Disables the MDT monitoring services.
Enable-MDTMonitorService Enables the MDT monitoring services.
Get-MDTDeploymentShareStatistics Displays the statistics of a deployment share, including the number of entities per major folder in the deployment share.
Get-MDTMonitorData Displays the MDT monitoring information collected for one or more monitored MTD deployments.
Get-MDTOperatingSystemCatalog Returns the operating system catalog for a specific operating system. If the operating system catalog does not exist or is out of date, then the operating system catalog is regenerated.
Get-MDTPersistentDrive Displays the list of deployment shares that can be restored using the Restore-MDTPersistentDrive cmdlet.
Import-MDTApplication Imports an application into a deployment share.
Import-MDTDriver Imports one or more device drivers into a deployment share.
Import-MDTOperatingSystem Imports one or more operating systems into a deployment share.
Import-MDTPackage Imports one or more operating system packages into a deployment share.
Import-MDTTaskSequence Imports a task sequence into a deployment share.
New-MDTDatabase Creates or upgrades an MDT DB database that is associated with a deployment share.
Remove-MDTMonitorData Removes one or more MDT monitoring data items from the collected MDT monitoring data in a deployment share.
Remove-MDTPersistentDrive Removes a deployment share from the list of MDT persisted Windows PowerShell drives that can be restored using the Restore-MDTPersistentDrive cmdlet.
Restore-MDTPersistentDrive Creates a Windows PowerShell drive for each deployment share in the list of MDT persisted Windows PowerShell drives.
Set-MDTMonitorData Creates a new or updates an existing MDT monitoring data item in the collected MDT monitoring data in a deployment share.
Test-MDTDeploymentShare Verifies the integrity of a deployment share.
Test-MDTMonitorData Verifies that the MDT monitoring services is configured correctly and running.
Update-MDTDatabaseSchema Updates the MDT DB database schema.
Update-MDTDeploymentShare Updates a deployment share.
Update-MDTLinkedDS Replicates content from a deployment share to a linked deployment share.
Update-MDTMedia Replicates content from a deployment share to a deployment media folder.

Add-MDTPersistentDrive

This section describes the Add-MDTPersistentDriveWindows PowerShell cmdlet. Run this cmdlet from a Windows PowerShell console that has the MDT PowerShell snap-in loaded. For more information on how to start a Windows PowerShell console that has the MDT PowerShell snap-in loaded, see "Loading the MDT Windows PowerShell Snap-In".

Syntax

Add-MDTPersistentDrive [-Name] <String> [[-InputObject] <PSObject>] [<CommonParameters>]  

Description

This cmdlet adds an existing Windows PowerShell drive created using the MDTProvider to a list of drives that are persisted in the Deployment Workbench or in a Windows PowerShell session using the Restore-MDTPersistentDrive cmdlet. This cmdlet is called when you create or open a deployment share in the Deployment Workbench.

Note

The list of persisted MDTProvider drives is maintained on a per-user based in the user profile.

The list of persisted MDTProvider drives can be displayed using the Get-MDTPersistentDrive cmdlet.

Parameters

This subsection provides information about the various parameters that can be used with the Add-MDTPersistentDriveWindows cmdlet.

-Name <String>

Specifies the name of a Windows PowerShell drive created using the MDT provider and corresponds to an existing deployment share. The name was created using the New-PSDrive cmdlet and specifying the MDTProvider in the PSProvider parameter.

For more information on how to create a new Windows PowerShell drive using the MDTProvider and how to create a deployment share using Windows PowerShell, see the section "Creating a Deployment Share Using Windows PowerShell" in the MDT document, Microsoft Deployment Toolkit Samples Guide.

Parameter Value
Required? True
Position? 2 and Named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? False
-InputObject <PSObject>

This parameter specifies a Windows PowerShell drive object that was created earlier in the process. Enter a PSObject object, such as one generated by the New-PSDrive cmdlet.

Parameter Value
Required? False
Position? 3 and Named
Default value
Accept pipeline input? True (ByValue)
Accept wildcard characters? False
<CommonParameters>

This cmdlet supports the following common parameters: Verbose, Debug, ErrorAction, ErrorVariable, OutBuffer, OutVariable, WarningAction, and WarningVariable. For more information, see the topic, “about_CommonParameters,” which you can access by typing the following command, and then pressing ENTER:

Get-Help about_CommonParameters  

Outputs

This cmdlet outputs a PSObject type object for the Windows PowerShell drive object was added to the list of persisted drives.

This cmdlet also outputs a String type object if the Verbose common parameter is included.

Example 1

Add-MDTPersistentDrive –Name DS001  
Description

This example adds the deployment share with the Windows PowerShell drive name of DS001 to the list of persisted drives.

Example 2

$MDTPSDrive = New-PSDrive -Name "DS001" -PSProvider "MDTProvider" –Root "C:\DeploymentShare$" -Description "MDT Deployment Share" -NetworkPath \\WDG-MDT-01\DeploymentShare$ -Verbose  
Add-MDTPersistentDrive –InputObject $MDTPSDrive  
Description

This example adds the Windows PowerShell drive name DS001, created by the New-PSDrive cmdlet, to the list of persisted MDT drives using the $MDTPSDrive variable.

Example 3

New-PSDrive -Name "DS001" -PSProvider "MDTProvider" –Root "C:\DeploymentShare$" -Description "MDT Deployment Share" -NetworkPath \\WDG-MDT-01\DeploymentShare$ -Verbose | Add-MDTPersistentDrive –Verbose  
Description

This example adds the Windows PowerShell drive name DS001, created by the New-PSDrive cmdlet, to the list of persisted MDT drives by piping the newly created Windows PowerShell drive object to the Add-MDTPersistentDrive cmdlet.

Disable-MDTMonitorService

This section describes the Disable-MDTMonitorService Windows PowerShell cmdlet. Run this cmdlet from a Windows PowerShell console that has the MDT PowerShell snap-in loaded. For more information on how to start a Windows PowerShell console that has the MDT PowerShell snap-in loaded, see "Loading the MDT Windows PowerShell Snap-In".

Syntax

Disable-MDTMonitorService [<CommonParameters>]  

Description

This cmdlet disables the MDT monitoring service, which runs on the computer where MDT is installed. The MDT monitoring service collects monitoring information that can be displayed:

  • In the Monitoring node in a deployment share in the Deployment Workbench

  • Using the Get-MDTMonitorData cmdlet

    The MDT monitoring service can subsequently be enabled using the Enable-MDTMonitorService.

    For more information on the MDT monitoring service, see the section "Monitoring MDT Deployments" in the MDT document, Using the Microsoft Deployment Toolkit.

Parameters

This subsection provides information about the various parameters that can be used with the Disable-MDTMonitorService cmdlet.

<CommonParameters>

This cmdlet supports the following common parameters: Verbose, Debug, ErrorAction, ErrorVariable, OutBuffer, OutVariable, WarningAction, and WarningVariable. For more information, see the topic, “about_CommonParameters,” which you can accessed by typing the following command, and then pressing ENTER:

Get-Help about_CommonParameters  

Outputs

This cmdlet outputs a String type object if the Verbose common parameter is included; otherwise, no output is generated.

Example 1

Disable-MDTMonitorService  
Description

This example disables the MDT monitoring service.

Enable-MDTMonitorService

This section describes the Enable-MDTMonitorService Windows PowerShell cmdlet. Run this cmdlet from a Windows PowerShell console that has the MDT PowerShell snap-in loaded. For more information on how to start a Windows PowerShell console that has the MDT PowerShell snap-in loaded, see "Loading the MDT Windows PowerShell Snap-In".

Syntax

Enable-MDTMonitorService [-EventPort] <Int32> [-DataPort] <Int32> [<CommonParameters>]  

Description

This cmdlet enables the MDT monitoring service, which runs on the computer where MDT is installed. The MDT monitoring service collects monitoring information that can be displayed:

  • In the Monitoring node in a deployment share in the Deployment Workbench.

  • Using the Get-MDTMonitorData cmdlet

    The MDT monitoring service can be disabled using the Disable-MDTMonitorService.

    For more information on the MDT monitoring service, see the section "Monitoring MDT Deployments" in the MDT document, Using the Microsoft Deployment Toolkit.

Parameters

This subsection provides information about the various parameters that can be used with the Enable-MDTMonitorService cmdlet.

-EventPort <Int32>

This parameter specifies the TCP port used as the event port for the MDT monitoring service.

Parameter Value
Required? False
Position? 2 and Named
Default value 9800
Accept pipeline input? False
Accept wildcard characters? False
-DataPort <Int32>

This parameter specifies the TCP port used as the data port for the MDT monitoring service.

Parameter Value
Required? False
Position? 3 and Named
Default value 9801
Accept pipeline input? False
Accept wildcard characters? False
<CommonParameters>

This cmdlet supports the following common parameters: Verbose, Debug, ErrorAction, ErrorVariable, OutBuffer, OutVariable, WarningAction, and WarningVariable. For more information, see the topic, “about_CommonParameters,” which you can access by typing the following command, and then pressing ENTER:

Get-Help about_CommonParameters  

Outputs

This cmdlet outputs a String type object if the Verbose common parameter is included; otherwise, no output is generated.

Example 1

Enable-MDTMonitorService  
Description

This example enables the MDT monitoring service on the local computer using the default value of 9800 for the event port and the value of 9801 for the data port on the MDT monitoring service.

Example 2

Enable-MDTMonitorService –EventPort 7000 –DataPort 7001  
Description

This example enables the MDT monitoring service on the local computer using the value of 7000 for the event port and the value of 7001 for the data port on the MDT monitoring service.

Get-MDTDeploymentShareStatistics

This section describes the Get-MDTDeploymentShareStatistics Windows PowerShell cmdlet. Run this cmdlet from a Windows PowerShell console that has the MDT PowerShell snap-in loaded. For more information on how to start a Windows PowerShell console that has the MDT PowerShell snap-in loaded, see "Loading the MDT Windows PowerShell Snap-In".

Syntax

Get-MDTDeploymentShareStatistics [-Path <String>] [<CommonParameters>]  

Description

This cmdlet displays the statistics of a deployment share based on the MDTProvder drive that is specified in the Path parameter. The statistics include the number of items in the specified deployment share:

  • Applications

  • Drivers

  • Operating Systems

  • Packages

  • Task Sequences

  • Selection Profiles

  • Linked Deployment Shares

  • MDT Media

  • Computers in the MDT DB

  • Make and Models in the MDT DB

  • Locations in the MDT DB

  • Roles in the MDT DB

Note

The values for the statistics that relate to the MDT DB are not populated and always return a value of zero.

Parameters

This subsection provides information about the various parameters that can be used with the Get-MDTDeploymentShareStatistics cmdlet.

-Path <String>

This parameter specifies the MDTProvider Windows PowerShell drive for the desired deployment share.

Note

If this parameter is not provided, then the Windows PowerShell working directory must default to a location within the desired MDTProvider Windows PowerShell drive.

Parameter Value
Required? False
Position? 2 and Named
Default value
Accept pipeline input? False
Accept wildcard characters? False
<CommonParameters>

This cmdlet supports the following common parameters: Verbose, Debug, ErrorAction, ErrorVariable, OutBuffer, OutVariable, WarningAction, and WarningVariable. For more information, see the topic, “about_CommonParameters,” which you can access by typing the following command, and then pressing ENTER:

Get-Help about_CommonParameters  

Outputs

This cmdlet outputs a PSObject type object that contains the statistics for the deployment share.

Example 1

Get-MDTDeploymentShareStatistics –Path DS001:  
Description

This example returns the deployment share statistics for the deployment share that is specified in the DS001: MDTProvider Windows PowerShell drive.

Example 2

cd DS001:  
Get-MDTDeploymentShareStatistics  
Description

This example returns the deployment share statistics for the deployment share that is specified in the DS001: MDTProvider Windows PowerShell drive. Use the cd command to set the working directory for Windows PowerShell to the DS001: MDTProvider Windows PowerShell drive.

Get-MDTMonitorData

This section describes the Get-MDTMonitorData Windows PowerShell cmdlet. Run this cmdlet from a Windows PowerShell console that has the MDT PowerShell snap-in loaded. For more information on how to start a Windows PowerShell console that has the MDT PowerShell snap-in loaded, see "Loading the MDT Windows PowerShell Snap-In".

Syntax

Get-MDTMonitorData [-Path <String>] [-ID <Nullable>] [<CommonParameters>]  

Description

This cmdlet displays the MDT monitoring data that is being reported to the deployment share that is specified in the Path parameter. The following is example output from this cmdlet:

Name               : WDG-REF-01  
PercentComplete    : 100  
Settings           :  
Warnings           : 0  
Errors             : 0  
DeploymentStatus   : 3  
StartTime          : 5/23/2012 6:45:39 PM  
EndTime            : 5/23/2012 8:46:32 PM  
ID                 : 1  
UniqueID           : 94a0830e-f2bb-421c-b1e0-6f86f9eb9fa1  
CurrentStep        : 88  
TotalSteps         : 88  
StepName           :  
LastTime           : 5/23/2012 8:46:32 PM  
DartIP             :  
DartPort           :  
DartTicket         :  
VMHost             : WDG-HOST-01  
VMName             : WDG-REF-01  
ComputerIdentities : {}  

Note

The MDTProvider Windows PowerShell drive that this cmdlet references must exist prior to running this cmdlet.

Parameters

This subsection provides information about the various parameters that you can use with the Get- MDTMonitorData cmdlet.

-Path <String>

This parameter specifies the MDTProvider Windows PowerShell drive for the desired deployment share.

Note

If this parameter is not provided, then the Windows PowerShell working directory must default to a location within the desired MDTProvider Windows PowerShell drive.

Parameter Value
Required? False
Position? 2 and Named
Default value
Accept pipeline input? False
Accept wildcard characters? False
-ID <Nullable>

This parameter specifies the specific identifier for the deployment of a specific computer. If this parameter is not specified, then all monitoring data for deployments in the deployment share are displayed.

Parameter Value
Required? False
Position? 3 and Named
Default value
Accept pipeline input? False
Accept wildcard characters? False
<CommonParameters>

This cmdlet supports the following common parameters: Verbose, Debug, ErrorAction, ErrorVariable, OutBuffer, OutVariable, WarningAction, and WarningVariable. For more information, see the topic, “about_CommonParameters,” which you can access by typing the following command, and then pressing ENTER:

Get-Help about_CommonParameters  

Outputs

This cmdlet outputs a PSObject type object for each monitored computer, which contains the monitoring data for the computer.

Example 1

Get-MDTMonitorData –Path DS001:  
Description

This example returns the monitoring data for all deployments in the deployment share that is specified in the DS001: MDTProvider Windows PowerShell drive.

Example 2

cd DS001:  
Get-MDTMonitorData  
Description

This example returns the monitoring data for all deployments in the deployment share that is specified in the DS001: MDTProvider Windows PowerShell drive. Use the cd command to set the working directory for Windows PowerShell to the DS001: MDTProvider Windows PowerShell drive.

Example 3

Get-MDTMonitorData –Path DS001: -ID 22  
Description

This example returns the monitoring data for the deployment with an ID of 22 in the deployment share that is specified in the DS001: MDTProvider Windows PowerShell drive.

Get-MDTOperatingSystemCatalog

This section describes the Get-MDTOperatingSystemCatalog Windows PowerShell cmdlet. Run this cmdlet from a Windows PowerShell console that has the MDT PowerShell snap-in loaded. For more information on how to start a Windows PowerShell console that has the MDT PowerShell snap-in loaded, see "Loading the MDT Windows PowerShell Snap-In".

Syntax

Get-MDTOperatingSystemCatalog [-ImageFile] <String> [-Index] <Int32> [<CommonParameters>]  

Description

This cmdlet retrieves or creates an operating system catalog for a custom operating system image so that you can modify the corresponding unattend.xml file using Windows System Image Manager (WSIM). If no operating system catalog is available or if the existing operating system catalog is invalid or out of date, this cmdlet will generate a new operating system catalog.

Note

The process of generating a new operating system catalog may take a long time as the custom operating system image must be mounted, inspected, and unmounted before the operating system catalog creation completes.

Parameters

This subsection provides information about the various parameters that can be used with the Get-MDTOperatingSystemCatalog cmdlet.

-ImageFile <String>

This parameter specifies the fully qualified path to the custom operating system image file (.wim file), including the name of the custom operating system image file.

Parameter Value
Required? True
Position? 2 and Named
Default value
Accept pipeline input? False
Accept wildcard characters? False
-Index <Int32>

This parameter specifies the index of the desired operating system image within the operating system image file (.wim file).

Parameter Value
Required? True
Position? 3 and Named
Default value
Accept pipeline input? False
Accept wildcard characters? False
<CommonParameters>

This cmdlet supports the following common parameters: Verbose, Debug, ErrorAction, ErrorVariable, OutBuffer, OutVariable, WarningAction, and WarningVariable. For more information, see the topic, “about_CommonParameters,” which you can access by typing the following command, and then pressing ENTER:

Get-Help about_CommonParameters  

Outputs

This cmdlet outputs a PSObject type object that contains the path to the operating system catalog.

Example 1

Get-MDTOperatingSystemCatalog –ImageFile "DS001:\Operating Systems\Windows 8\sources\install.wim" –Index 2  
Description

This example returns the operating system catalog for the operating system image at the index of 2 in the operating system image file DS001:\Operating Systems\Windows 8\sources\install.wim.

Get-MDTPersistentDrive

This section describes the Get-MDTPersistentDrive Windows PowerShell cmdlet. Run this cmdlet from a Windows PowerShell console that has the MDT PowerShell snap-in loaded. For more information on how to start a Windows PowerShell console that has the MDT PowerShell snap-in loaded, see "Loading the MDT Windows PowerShell Snap-In".

Syntax

Get-MDTPersistentDrive [<CommonParameters>]  

Description

This cmdlet displays the list of persisted MDT Windows PowerShell drives. The list of persisted MDT Windows PowerShell drives is managed using the Add-MDTPersistentDrive and Remove-MDTPersistentDrive cmdlets or the Deployment Workbench.

The output from this cmdlet contains the following information:

  • Windows PowerShell drive name, such as DS001

  • Directory path, such as \\WDG-MDT-01\DeploymentShare$

    Persisted MDT Windows PowerShell drives are similar to persisted network drive mappings.

Note

This list of persisted MDT Windows PowerShell drives is maintained on a per user basis and are stored in the user profile.

Parameters

This subsection provides information about the various parameters that can be used with the Get- MDTPersistentDrive cmdlet.

<CommonParameters>

This cmdlet supports the following common parameters: Verbose, Debug, ErrorAction, ErrorVariable, OutBuffer, OutVariable, WarningAction, and WarningVariable. For more information, see the topic, “about_CommonParameters,” which you can access by typing the following command, and then pressing ENTER:

Get-Help about_CommonParameters  

Outputs

This cmdlet outputs a PSObject type object for each MDT persisted drive that is identical to the PSObject type object that the New-PSDrive cmdlet returns.

Example 1

Get-MDTPersistentDrive  
Description

This example displays a list of the MDT persisted drives.

Import-MDTApplication

This section describes the Import-MDTApplication Windows PowerShell cmdlet. Run this cmdlet from a Windows PowerShell console that has the MDT PowerShell snap-in loaded. For more information on how to start a Windows PowerShell console that has the MDT PowerShell snap-in loaded, see "Loading the MDT Windows PowerShell Snap-In".

Syntax

Import-MDTApplication [-Path <String>] -Name <String> ApplicationSourcePath <String> -DestinationFolder <String> [-Move] [<CommonParameters>]  

–or–

Import-MDTApplication [-Path <String>] -Name <String> NoSource [<CommonParameters>]  

–or–

Import-MDTApplication [-Path <String>] -Name <String> Bundle [<CommonParameters>]  

Description

This cmdlet imports an application into a deployment share. The following application types can be imported using this cmdlet:

  • Applications that have source files, using the ApplicationSourcePath, DestinationFolder, and Move parameters. The first syntax example illustrates the use of this cmdlet for this type of application.

  • Applications without source files or with source files located on other network shared folders using the NoSource parameter. The second syntax example illustrates the use of this cmdlet for this type of application.

  • Application bundles, which are used to group a set of related applications, using the Bundle parameter. The last syntax example illustrates the use of this cmdlet for this type of application.

Parameters

This subsection provides information about the various parameters that can be used with the Import-MDTApplication cmdlet.

-Path <String>

This parameter specifies the fully qualified path to an existing folder where the application being imported will be placed within the deployment share. If the DestinationFolder parameter is used, then the folder specified in the DestinationFolder parameter is created beneath the folder specified in this parameter. This parameter is used in all syntax usages for this cmdlet.

Note

If this parameter is not provided, the Windows PowerShell working directory must default to the desired location within the deployment share.

Parameter Value
Required? False
Position? Named
Default value
Accept pipeline input? False
Accept wildcard characters? False
-Name <String>

This parameter specifies the name of the application to be added to the deployments share and must be unique within the deployment share. This parameter is used in all syntax usages for this cmdlet.

Parameter Value
Required? True
Position? Named
Default value
Accept pipeline input? False
Accept wildcard characters? False
-ApplicationSourcePath <String>

This parameter specifies the fully qualified path to the application source files for the application that will be imported into the deployment share. This parameter is only valid for use in the first syntax example.

Parameter Value
Required? True
Position? Named
Default value
Accept pipeline input? False
Accept wildcard characters? False
-DestinationFolder <String>

This parameter specifies the folder in the deployment share where the application source files are to be imported. This folder is created beneath the folder specified in the Path parameter. This parameter is only valid for use in the first syntax example.

Parameter Value
Required? True
Position? Named
Default value
Accept pipeline input? False
Accept wildcard characters? False
-Move [<SwitchParameter>]

This parameter specifies whether the application’s source files should be moved (instead of copied) from the folder where the application’s source files are located, which is specified in the ApplicationSourcePath parameter.

If this parameter is:

  • Specified, then the files are moved and the files in the folder specified in the ApplicationSourcePath parameter are deleted

  • Not specified, then the files are copied and the files in the folder specified in the ApplicationSourcePath parameter are retained

    This parameter is only valid for use in the first syntax example.

Parameter Value
Required? False
Position? Named
Default value
Accept pipeline input? False
Accept wildcard characters? False
-NoSource [<SwitchParameter>]

This parameter specifies that the application being imported is an application that has no source files to be copied. When using this parameter, the application source files are:

  • On a network shared folder, which is specified in the application installation command line or working directory configuration settings

  • Already present in the operating system image

    This parameter is only valid for use in the second syntax example.

Parameter Value
Required? False
Position? Named
Default value
Accept pipeline input? True (ByValue)
Accept wildcard characters? False
-Bundle [<SwitchParameter>]

This parameter specifies that the application being imported is an application that is a bundle of two or more applications. This parameter is only valid for use in the last syntax example.

Parameter Value
Required? False
Position? Named
Default value
Accept pipeline input? True (ByValue)
Accept wildcard characters? False
<CommonParameters>

This cmdlet supports the following common parameters: Verbose, Debug, ErrorAction, ErrorVariable, OutBuffer, OutVariable, WarningAction, and WarningVariable. For more information, see the topic, “about_CommonParameters,” which you can access by typing the following command, and then pressing ENTER:

Get-Help about_CommonParameters  

Outputs

This cmdlet outputs a PSObject type object that references the application just imported.

Example 1

Import-MDTApplication -Path "DS001:\Applications" -Name "Office 2010 Professional Plus 32-bit" ApplicationSourcePath "\\WDG-MDT-01\Source$\Office2010ProPlus\x86" DestinationFolder "Office2010ProPlusx86"  
Description

This example imports an application with source files from the network shared folder at \\WDG-MDT-01\Source$\Office2010ProPlus\x86 and copies the source files to DS001:\Applications\Office2010ProPlusx86 within the deployment share. The source files are retained.

Example 2

Import-MDTApplication -Path "DS001:\Applications" -Name "Office 2010 Professional Plus 32-bit" ApplicationSourcePath "\\WDG-MDT-01\Source$\Office2010ProPlus\x86" DestinationFolder "Office2010ProPlusx86" -Move  
Description

This example imports an application with source files from the network shared folder at \\WDG-MDT-01\Source$\Office2010ProPlus\x86 and moves the source files to DS001:\Applications\Office2010ProPlusx86 within the deployment share. The source files are removed from the network shared folder at \\WDG-MDT-01\Source$\Office2010ProPlus\x86. The application is named Office 2012 Professional Plus 32-bit.

Example 3

Import-MDTApplication -Path "DS001:\Applications" -Name "Office 2010 Professional Plus 32-bit" NoSource  
Description

This example imports an application named Office 2012 Professional Plus 32-bit with no source files.

Example 4

Import-MDTApplication -Path "DS001:\Applications" -Name "Woodgrove Bank Core Applications" Bundle  
Description

This example imports an application bundle named Woodgrove Bank Core Applications.

Import-MDTDriver

This section describes the Import-MDTDriver Windows PowerShell cmdlet. Run this cmdlet from a Windows PowerShell console that has the MDT PowerShell snap-in loaded. For more information on how to start a Windows PowerShell console that has the MDT PowerShell snap-in loaded, see "Loading the MDT Windows PowerShell Snap-In".

Syntax

Import-MDTDriver [-Path <String>] -SourcePath <String[]> [ImportDuplicates] [<CommonParameters>]  

Description

This cmdlet imports one or more device drivers into a deployment share. This cmdlet searches for device drivers starting at the folder specified in the SourcePath parameter. This cmdlet will locate multiple device drivers found in that folder structure.

Parameters

This subsection provides information about the various parameters that can be used with the Import-MDTDriver cmdlet.

-Path <String>

This parameter specifies the fully qualified path to an existing folder where the device driver being imported will be placed within the deployment share.

Note

If this parameter is not provided, then the Windows PowerShell working directory must default to the desired location within the deployment share. This parameter must be provided if the SourcePath parameter is not provided.

Parameter Value
Required? False
Position? Named
Default value
Accept pipeline input? False
Accept wildcard characters? False
-SourcePath <String[ ]>

This parameter specifies one or more fully qualified paths in a string array for the source folders where the device driver files are located. Each folder structure, starting with the folder specified in this parameter, is searched for device drivers, including all subfolders and the contents of .cab files in the folder structure.

Note

If this parameter is not provided, then the Windows PowerShell working directory must default to the folder where the device driver files are located. This parameter must be provided if the Path parameter is not provided.

Parameter Value
Required? True
Position? 1 and Named
Default value
Accept pipeline input? False
Accept wildcard characters? False
-ImportDuplicates [<SwitchParameter>]

This parameter specifies whether this cmdlet should import duplicate device drivers. By default, duplicate device drivers are not imported. Duplicate device drivers are detected by calculating a hash values for all the files in a device driver folder. If the calculated hash value matches another device driver, the device driver to be imported is considered a duplicate.

If a duplicate driver is detected and this parameter is not provided, the device driver will be added and linked to the original, existing device driver.

If this parameter is:

  • Specified, then the duplicate device drivers are imported

  • Not specified, then the device drivers will be added and linked to the original, existing device drivers

Parameter Value
Required? False
Position? Named
Default value
Accept pipeline input? True (ByValue)
Accept wildcard characters? False
<CommonParameters>

This cmdlet supports the following common parameters: Verbose, Debug, ErrorAction, ErrorVariable, OutBuffer, OutVariable, WarningAction, and WarningVariable. For more information, see the topic, “about_CommonParameters,” which you can access by typing the following command, and then pressing ENTER:

Get-Help about_CommonParameters  

Outputs

This cmdlet outputs one or more PSObject type objects (one for each device driver imported).

Example 1

Import-MDTDriver -Path "DS001:\Out-of-Box Drivers" SourcePath "\\WDG-MDT-01\Source$\Drivers"  
Description

This example imports all device drivers in the folders structure with the root of the folder structure at \\WDG-MDT-01\Source$\Drivers. The device drivers are stored in the Out-of-Box Drivers folder in the deployment share that is mapped to the DS001: MDTProvder Windows PowerShell drive. If any duplicate device drivers are detected, the device drivers will be added and linked to the original, existing device drivers in the deployment share.

Example 2

$DriverSourcePath="\\WDG-MDT-01\Source$\VendorADrivers", "\\WDG-MDT-01\Source$\VendorBDrivers"  
Import-MDTDriver -Path "DS001:\Out-of-Box Drivers" SourcePath $DriverSourcePath ImportDuplicates  
Description

This example imports all device drivers in the folders structure specified in the string array $DriverSourcePath. The device drivers are stored in the Out-of-Box Drivers folder in the deployment share that is mapped to the DS001: MDTProvder Windows PowerShell drive. If any duplicate device drivers are detected, the duplicate device drivers are imported.

Import-MDTOperatingSystem

This section describes the Import-MDTOperatingSystem Windows PowerShell cmdlet. Run this cmdlet from a Windows PowerShell console that has the MDT PowerShell snap-in loaded. For more information on how to start a Windows PowerShell console that has the MDT PowerShell snap-in loaded, see "Loading the MDT Windows PowerShell Snap-In".

Syntax

Import-MDTOperatingSystem [-Path <String>] -SourcePath <String> [-DestinationFolder <String>] [-Move] [<CommonParameters>]  

–or–

Import-MDTOperatingSystem [-Path <String>] [DestinationFolder <String>] -SourceFile <String> [SetupPath <String>] [-Move] [<CommonParameters>]  

–or–

Import-MDTOperatingSystem [-Path <String>] -WDSServer <String> [<CommonParameters>]  

Description

This cmdlet imports an operating system into a deployment share. The following operating system types can be imported using this cmdlet:

  • Operating systems from the original source files, using the SourcePath parameters. The first syntax example illustrates the use of this cmdlet for this type of operating system import.

  • Custom operating systems image files, such as capture images from reference computers, using the SourceFile parameter. The second syntax example illustrates the use of this cmdlet for this type of operating system import.

  • Operating system images that are present in Windows Deployment Services using the WDSServer parameter. The last syntax example illustrates the use of this cmdlet for this type of operating system import.

Parameters

This subsection provides information about the various parameters that can be used with the Import-MDTOperatingSystem cmdlet.

-Path <String>

This parameter specifies the fully qualified path to an existing folder within the deployment share where the operating system being imported will be placed. If the DestinationFolder parameter is used, then the folder specified in the DestinationFolder parameter is created beneath the folder specified in this parameter. This parameter is used in all syntax usages for this cmdlet.

Note

If this parameter is not provided, then the Windows PowerShell working directory must default to the desired location within the deployment share.

Parameter Value
Required? False
Position? Named
Default value
Accept pipeline input? False
Accept wildcard characters? False
-SourcePath <String>

This parameter specifies the fully qualified path to the operating system source files for the operating system that will be imported into the deployment share. This parameter is only valid for use in the first syntax example.

Parameter Value
Required? True
Position? Named
Default value
Accept pipeline input? False
Accept wildcard characters? False
-DestinationFolder <String>

This parameter specifies the folder in the deployment share where the operating system source files are to be imported. This folder is created beneath the folder specified in the Path parameter. This parameter is only valid for use in the first and second syntax examples.

Parameter Value
Required? True
Position? Named
Default value
Accept pipeline input? False
Accept wildcard characters? False
-Move [<SwitchParameter>]

This parameter specifies if the operating system source files should be moved (instead of copied) from the folder where the operating system source files are located, which is specified in the DestinationFolder parameter.

If this parameter is:

  • Specified, then the files are moved and the files in the folder specified in the DestinationFolder parameter are deleted

  • Not specified, then the files are copied and the files in the folder specified in the DestinationFolder parameter are retained

    This parameter is only valid for use in the first and second syntax examples.

Parameter Value
Required? False
Position? Named
Default value
Accept pipeline input? False
Accept wildcard characters? False
-SourceFile <String>

This parameter specifies the fully qualified path to the operating system source .wim file for the operating system that will be imported into the deployment share. This parameter is only valid for use in the second syntax example.

Parameter Value
Required? True
Position? Named
Default value
Accept pipeline input? False
Accept wildcard characters? False
-SetupPath <String>

This parameter specifies the fully qualified path to the operating system setup files that need to be imported along with the .wim file specified in the SourceFile parameter. This parameter is only valid for use in the second syntax example.

Parameter Value
Required? True
Position? Named
Default value
Accept pipeline input? False
Accept wildcard characters? False
-WDSServer <String>

This parameter specifies the name of the Windows Deployment Services server on which the operating system image files to be imported are located. All operating image files on the Windows Deployment Services server will be imported into the deployment share. The actual operating system image files are not copied to the deployment share. Instead, the deployment share contains a link to each operating system file on the Windows Deployment Services server.

This parameter is only valid for use in the last syntax example.

Parameter Value
Required? False
Position? Named
Default value
Accept pipeline input? False
Accept wildcard characters? False
<CommonParameters>

This cmdlet supports the following common parameters: Verbose, Debug, ErrorAction, ErrorVariable, OutBuffer, OutVariable, WarningAction, and WarningVariable. For more information, see the topic, “about_CommonParameters,” which you can access by typing the following command, and then pressing ENTER:

Get-Help about_CommonParameters  

Outputs

This cmdlet outputs one or more PSObject type objects (one for each operating system that was imported).

Example 1

Import-MDTOperatingSystem -Path "DS001:\Operating Systems" SourcePath "\\WDGMDT01\Source$\Windows8" DestinationFolder "Windows8x64"  
Description

This example imports an operating system from the network shared folder at \\WDG-MDT-01\Source$\Windows8 and copies the source files to DS001:\Operating Systems\Windows8x64 within the deployment share. The source files are retained.

Example 2

Import-MDTOperatingSystem -Path "DS001:\Operating Systems" SourcePath "\\WDGMDT01\Source$\Windows8" DestinationFolder "Windows8x64" -Move  
Description

This example imports an operating system from the network shared folder at \\WDG-MDT-01\Source$\Windows8 and copies the source files to DS001:\Operating Systems\Windows8x64 within the deployment share. The source files are removed from the network shared folder at \\WDG-MDT-01\Source$\Windows8.

Example 3

Import-MDTOperatingSystem -Path "DS001:\Operating Systems" DestinationFolder "Windows8x64-Reference" –SourceFile "\\WDGMDT01\Capture$\WDG-REF-01_Capture.wim"  
Description

This example imports an operating system captured, custom image file (.wim file) from \\WDG-MDT-01\ Capture$\WDG-REF-01_Capture.wim and copies the image file to DS001:\Operating Systems\Windows8x64-Reference within the deployment share. The source .wim file is retained on the network shared folder.

Example 4

Import-MDTOperatingSystem -Path "DS001:\Operating Systems" WDSServer "WDG-WDS-01"  
Description

This example imports all the operating system images from the Windows Deployment Services server named WDG-WDS-01 and creates a link to each operating system image in DS001:\Operating Systems within the deployment share. The source operating system image files on the Windows Deployment Services server are retained on the Windows Deployment Services server.

Import-MDTPackage

This section describes the Import-MDTPackage Windows PowerShell cmdlet. Run this cmdlet from a Windows PowerShell console that has the MDT PowerShell snap-in loaded. For more information on how to start a Windows PowerShell console that has the MDT PowerShell snap-in loaded, see "Loading the MDT Windows PowerShell Snap-In".

Syntax

Import-MDTPackage [-Path <String>] [[-SourcePath] <String[]>] [<CommonParameters>]  

Description

This cmdlet imports one or more operating system packages into a deployment share. The types of operating system packages that can be imported include security updates, language packs, or new components. Service packs should not be imported as operating system packages as they cannot be installed offline.

Parameters

This subsection provides information about the various parameters that can be used with the Import-MDTPackage cmdlet.

-Path <String>

This parameter specifies the fully qualified path to an existing folder within the deployment share where the operating system packages being imported will be placed.

Note

If this parameter is not provided, then the Windows PowerShell working directory must default to the desired location within the deployment share.

Parameter Value
Required? False
Position? Named
Default value
Accept pipeline input? False
Accept wildcard characters? False
-SourcePath <String>

This parameter specifies the fully qualified path to a folder structure to be scanned for operating system packages to import. The specified folder structure will be scanned for .cab and .msu files. For .msu files, the .cab files inside the .msu files are automatically extracted.

Parameter Value
Required? True
Position? 1 and Named
Default value
Accept pipeline input? False
Accept wildcard characters? False
<CommonParameters>

This cmdlet supports the following common parameters: Verbose, Debug, ErrorAction, ErrorVariable, OutBuffer, OutVariable, WarningAction, and WarningVariable. For more information, see the topic, “about_CommonParameters,” which you can access by typing the following command, and then pressing ENTER:

Get-Help about_CommonParameters  

Outputs

This cmdlet outputs a PSObject type object that references the package just imported.

Example 1

Import-MDTOperatingSystem -Path "DS001:\Packages" SourcePath "\\WDGMDT01\Source$\OSPackages"  
Description

This example scans network shared folder at \\WDG-MDT-01\Source$\OSPackages for operating system packages and copies the source files to DS001:\Packages folder within the deployment share. The source files are removed from the network shared folder at \\WDG-MDT-01\Source$\OSPackages.

Import-MDTTaskSequence

This section describes the Import-MDTTaskSequence Windows PowerShell cmdlet. Run this cmdlet from a Windows PowerShell console that has the MDT PowerShell snap-in loaded. For more information on how to start a Windows PowerShell console that has the MDT PowerShell snap-in loaded, see "Loading the MDT Windows PowerShell Snap-In".

Syntax

Import-MDTTaskSequence [-Path <String>] -Template <String> -Name <String> -ID <String> [[-Comments] <String>] [[-Version] <String>] [-OperatingSystemPath <String>] [-OperatingSystem <PSObject>] [-FullName <String>] [-OrgName <String>] [-HomePage <String>] [-ProductKey <String>] [-OverrideProductKey <String>] [-AdminPassword <String>] [<CommonParameters>]  

Description

This cmdlet imports a task sequence into a deployment share. The newly imported task sequence will be based on an existing task sequence template specified in the Template property.

Parameters

This subsection provides information about the various parameters that can be used with the Import-MDTPackage cmdlet.

-Path <String>

This parameter specifies the fully qualified path to an existing folder within the deployment share where the task sequence being imported will be placed. By default, the path should point to the Control folder and or a subfolder of the Control folder in the deployment share. The value of the ID parameter will be used to create a subfolder within the path specified in this parameter.

Note

If this parameter is not provided, then the Windows PowerShell working directory must default to the desired location within the deployment share.

Parameter Value
Required? False
Position? Named
Default value
Accept pipeline input? False
Accept wildcard characters? False
-Template <String>

This parameter specifies the task sequence template to be used for importing the new task sequence. Task sequence templates are .xml files that contain the task sequence steps for a particular type of task sequence. If the task sequence template is located in:

  • The installation_folder\Templates folder (where installation_folder is the folder in which MDT is installed), then only the .xml file name is required.

  • Another folder, then the fully qualified path, including the name of the task sequence template .xml, is required.

    For more information on the task sequence templates that are included with MDT for LTI deployments, see the section "Create a New Task Sequence in the Deployment Workbench" in the MDT document, Using the Microsoft Deployment Toolkit.

Parameter Value
Required? True
Position? 1 and Named
Default value
Accept pipeline input? False
Accept wildcard characters? False
-Name <String>

This parameter specifies the name of the task sequence to be imported. The value of this parameter must be unique within the deployment share.

Parameter Value
Required? True
Position? 2 and Named
Default value
Accept pipeline input? False
Accept wildcard characters? False
-ID <String>

This parameter specifies the identifier of the task sequence to be imported. The value of this parameter must be unique within the deployment share. The value assigned to this parameter should be in uppercase and not have any spaces or special characters. This value is used to create a subfolder in the folder specified in the Path parameter, which should be under the Control folder in the deployment share.

Parameter Value
Required? True
Position? 3 and Named
Default value
Accept pipeline input? False
Accept wildcard characters? False
-Comments <String>

This parameter specifies the text that provides additional, descriptive information about the task sequence to be imported. This descriptive information is visible in the Deployment Workbench.

Parameter Value
Required? False
Position? 4 and Named
Default value
Accept pipeline input? False
Accept wildcard characters? False
-Version <String>

This parameter specifies the version number of the task sequence to be imported. The value of this parameter is informational only and is not used by MDT for version-related processing.

Parameter Value
Required? False
Position? 4 and Named
Default value
Accept pipeline input? False
Accept wildcard characters? False
-OperatingSystemPath <String>

This parameter specifies the fully qualified Windows PowerShell path to the folder in the deployment share that contains the operating system to be used with this task sequence, such as DS001:\Operating Systems\Windows 8. The operating system must already exist in the deployment share where the task sequence is being imported.

Note

If you do not provide this parameter and the task sequence needs to reference an operating system, then you must provide the OperatingSystem parameter.

Parameter Value
Required? False
Position? Named
Default value
Accept pipeline input? False
Accept wildcard characters? False
-OperatingSystem <PSObject>

This parameter specifies the operating system object to be used with this task sequence. The operating system must already exist in the deployment share where the task sequence is being imported.

You can retrieve the Windows PowerShell object for an operating system using the Get-Item cmdlet, such as the following example:

$OS=Get-Item "DS001:\Operating Systems\Windows 8"  

For more information on the Get-Item cmdlet, see Using the Get-Item Cmdlet.

Note

If you do not provide this parameter and the task sequence needs to reference an operating system, then you must provide the OperatingSystemPath parameter.

Parameter Value
Required? False
Position? Named
Default value
Accept pipeline input? False
Accept wildcard characters? False
-FullName <String>

This parameter specifies the name of the registered owner of the operating system to be used with this task sequence. This name is saved in the RegisteredOwner registry key at HKEY_LOCAL_MACHINE\Software\Microsoft\Windows\CurrentVersion. The value of this parameter is injected into the Unattend.xml file to be associated with this task sequences.

Parameter Value
Required? False
Position? Named
Default value
Accept pipeline input? False
Accept wildcard characters? False
-OrgName <String>

This parameter specifies the name of the organization for the registered owner of the operating system to be used with this task sequence. This name is saved in the RegisteredOrganization registry key at HKEY_LOCAL_MACHINE\Software\Microsoft\Windows\CurrentVersion. The value of this parameter is injected into the Unattend.xml file to be associated with this task sequences.

Parameter Value
Required? False
Position? Named
Default value
Accept pipeline input? False
Accept wildcard characters? False
-HomePage <String>

This parameter specifies the URL to be used as the home page in Internet Explorer. The value of this parameter is injected into the Unattend.xml file to be associated with this task sequences.

Parameter Value
Required? False
Position? Named
Default value
Accept pipeline input? False
Accept wildcard characters? False
-ProductKey <String>

This parameter specifies the product key to be used for the operating system to be used with this task sequence. This product key is valid only for retail versions of Windows operating systems. The value of this parameter is injected into the Unattend.xml file to be associated with this task sequences.

Note

If this parameter is not provided, then the product key must be provided when deploying this task sequence in the Deployment Wizard, in the CustomSettings.ini file, or in the MDT DB.

Parameter Value
Required? False
Position? Named
Default value
Accept pipeline input? False
Accept wildcard characters? False
-OverrideProductKey <String>

This parameter specifies the MAK key to be used for the operating system to be used with this task sequence. This product key is valid only for volume license versions of Windows. The value of this parameter is injected into the Unattend.xml file to be associated with this task sequences.

Note

If this parameter is not provided, then the MAK key must be provided when deploying this task sequence in the Deployment Wizard, in the CustomSettings.ini file, or in the MDT DB.

Parameter Value
Required? False
Position? Named
Default value
Accept pipeline input? False
Accept wildcard characters? False
-AdminPassword <String>

This parameter specifies the password to be assigned to the built-in, local Administrator account on the target computer. The value of this parameter is injected into the Unattend.xml file to be associated with this task sequences.

Note

If this parameter is not provided, then the password to be assigned to the built-in, local Administrator account on the target computer must be provided when deploying this task sequence in the Deployment Wizard, in the CustomSettings.ini file, or in the MDT DB.

Parameter Value
Required? False
Position? Named
Default value
Accept pipeline input? False
Accept wildcard characters? False
<CommonParameters>

This cmdlet supports the following common parameters: Verbose, Debug, ErrorAction, ErrorVariable, OutBuffer, OutVariable, WarningAction, and WarningVariable. For more information, see the topic, “about_CommonParameters,” which you can access by typing the following command, and then pressing ENTER:

Get-Help about_CommonParameters  

Outputs

This cmdlet outputs a PSObject type object that references the task sequence just imported.

Example 1

Import-MDTTaskSequence -Path "DS001:\Control" –Template "Client.xml" –Name "Deploy Windows 8 to Reference Computer" –ID "WIN8REFERENCE" –Comments "Task sequence for deploying Windows 8 to the reference computer (WDG-REF-01)" –Version "1.00" –OperatingSystemPath "DS001:\Operating Systems\Windows 8_x64" –FullName "Woodgrove Bank Employee" –OrgName "Woodgrove Bank" HomePage "http://www.woodgrovebank.com"  OverrideProductKey "1234512345123451234512345" AdministratorPassword "P@ssw0rd"  
Description

This example imports a task sequence named Deploy Windows 8 to Reference Computer and creates the task sequence in the DS001:\Control\WIN8REFERENCE folder in the deployment share. The comment, “Task sequence for deploying Windows 8 to the reference computer (WDG-REF-01),” is assigned to the task sequence. The version number of the task sequence is set to 1.00.

The operating system associated with the task sequence is located at DS001:\Operating Systems\Windows 8_x64 in the deployment share. The registered owner of the operating system will be set to Woodgrove Bank Employee. The registered organization of the operating system will be set to Woodgrove Bank. The Internet Explorer home page will default to http://www.woodgrovebank.com. The password for the local, built-in Administrator account will be set to a value of P@ssw0rd. The product key for the operating system will be set to 1234512345123451234512345.

Example 2

$OSObject=Get-Item "DS001:\Operating Systems\Windows 8_x64"  
Import-MDTTaskSequence -Path "DS001:\Control" –Template "Client.xml" –Name "Deploy Windows 8 to Reference Computer" –ID "WIN8REFERENCE" –Comments "Task sequence for deploying Windows 8 to the reference computer (WDG-REF-01)" –Version "1.00"–OperatingSystem $OSObject –FullName "Woodgrove Bank Employee" –OrgName "Woodgrove Bank" HomePage "http://www.woodgrovebank.com"  AdministratorPassword "P@ssw0rd"  
Description

This example imports a task sequence named Deploy Windows 8 to Reference Computer and creates the task sequence in the DS001:\Control\WIN8REFERENCE folder in the deployment share. The comment, “Task sequence for deploying Windows 8 to the reference computer (WDG-REF-01),” is assigned to the task sequence. The version number of the task sequence is set to 1.00.

The operating system associated with the task sequence is located at DS001:\Operating Systems\Windows 8_x64 in the deployment share, which is passed to the cmdlet using the $OSObject variable. The $OSObject variable is set to an existing operating system object using the Get-Item cmdlet.

The registered owner of the operating system will be set to Woodgrove Bank Employee. The registered organization of the operating system will be set to Woodgrove Bank. The Internet Explorer home page will default to http://www.woodgrovebank.com. The password for the local, built-in Administrator account will be set to a value of P@ssw0rd. The product key for the operating system will need to be provided when deploying this task sequence in the Deployment Wizard, in the CustomSettings.ini file, or in the MDT DB.

New-MDTDatabase

This section describes the New-MDTDatabase Windows PowerShell cmdlet. Run this cmdlet from a Windows PowerShell console that has the MDT PowerShell snap-in loaded. For more information on how to start a Windows PowerShell console that has the MDT PowerShell snap-in loaded, see "Loading the MDT Windows PowerShell Snap-In".

Syntax

New-MDTDatabase [-Path <String>] [-Force] -SQLServer <String> [-Instance <String>] [-Port <String>] [-Netlib <String>] -Database <String> [-SQLShare <String>] [<CommonParameters>]  

Description

This cmdlet creates a new MDT DB database that is associated with a deployment share. Each deployment share can be associated with only one MDT DB database.

Parameters

This subsection provides information about the various parameters that can be used with the New-MDTDatabase cmdlet.

-Path <String>

This parameter specifies the fully qualified Windows PowerShell path to the deployment share to which the new MDT DB database will be associated placed.

Note

If this parameter is not provided, then the Windows PowerShell working directory must default to the desired location within the deployment share.

Parameter Value
Required? False
Position? Named
Default value
Accept pipeline input? False
Accept wildcard characters? False
-Force [<SwitchParameter>]

This parameter specifies that tables within the MDT DB should be recreated if the database specified in the Database parameter already exist. If this parameter is:

  • Provided, then the tables within an existing MDT DB will be re-created

  • Omitted, then the tables within an existing MDT DB will not be re-created

Parameter Value
Required? False
Position? Named
Default value
Accept pipeline input? True (ByValue)
Accept wildcard characters? False
-SQLServer <String>

This parameter specifies the name of the computer running SQL Server where the new MDT DB database will be created.

Parameter Value
Required? True
Position? Named
Default value
Accept pipeline input? False
Accept wildcard characters? False
-Instance <String>

This parameter specifies the SQL Server instance in which the new MDT DB database will be created. If this parameter is omitted, the MDT DB database is created in the default SQL Server instance.

Note

The SQL Browser service must be running on the computer running SQL Server for the cmdlet to locate the instance specified in this parameter.

Parameter Value
Required? False
Position? Named
Default value
Accept pipeline input? False
Accept wildcard characters? False
-Port <String>

This parameter specifies the TCP port to be used in communication with the SQL Server instance specified in the SQLServer parameter. The default port that SQL Server uses is 1433. Specify this parameter when SQL Server is configured to use a port other than the default value. The value of this parameter must match the port configured for SQL Server.

Parameter Value
Required? False
Position? Named
Default value
Accept pipeline input? False
Accept wildcard characters? False
-Netlib <String>

This parameter specifies the SQL network library used in communication with the SQL Server instance specified in the SQLServer parameter. The parameter can be set to one of the following values:

  • DBNMPNTW, which is used to specify named pipes communication

  • DBSMSOCN, which is used to specify TCP/IP sockets communication

    If this parameter is not provided, the named pipes SQL network library (DBNMPNTW) is used.

Parameter Value
Required? False
Position? Named
Default value
Accept pipeline input? False
Accept wildcard characters? False
-Database <String>

This parameter specifies the name of the database to be created in the SQL Server instance specified in the Instance parameter on the SQL Server specified in the SQLServer parameter. The default location and naming convention will be used for the database and log files when creating the database.

If the database specified in this parameter already exists, the database will not be recreated. The tables within the database can be recreated based on the Force parameter.

Parameter Value
Required? True
Position? Named
Default value
Accept pipeline input? False
Accept wildcard characters? False
-SQLShare <String>

This parameter specifies the name of a network shared folder on the computer where SQL Server is running. This connection is used to establish Windows Integrated Security connections using the Named Pipes protocol.

Note

If this parameter is not included, then a secured IPC$ connection is not established. As a result, named pipes communication with SQL Server may fail.

Parameter Value
Required? False
Position? Named
Default value
Accept pipeline input? False
Accept wildcard characters? False
<CommonParameters>

This cmdlet supports the following common parameters: Verbose, Debug, ErrorAction, ErrorVariable, OutBuffer, OutVariable, WarningAction, and WarningVariable. For more information, see the topic, “about_CommonParameters,” which you can access by typing the following command, and then pressing ENTER:

Get-Help about_CommonParameters  

Outputs

This cmdlet outputs a PSObject type object for the new MDT DB that was created.

Example 1

New-MDTDatabase -Path "DS001:" –SQLServer "WDGSQL01" Database "MDTDB" –SQLShare "\\WDGSQL01\MDTShare$"  
Description

This example creates an MDT DB named MDTDB in the default SQL Server instance on a computer named WDG-SQL-01. If the database already exists, the tables in the existing database will not be recreated. The connection will be made using the default SQL Server TCP port and the Named Pipes protocol.

Example 2

New-MDTDatabase -Path "DS001:" –Force –SQLServer "WDGSQL01" –Instance "MDTInstance" Database "MDTDB" –SQLShare "\\WDGSQL01\MDTShare$"  
Description

This example creates an MDT DB named MDTDB in the SQL Server instance named MDTInstance on a computer named WDG-SQL-01. If the database already exists, the tables in the existing database will be recreated. The connection will be made using the default SQL Server TCP port and the Named Pipes protocol.

Remove-MDTMonitorData

This section describes the Get-MDTPersistentDrive Windows PowerShell cmdlet. Run this cmdlet from a Windows PowerShell console that has the MDT PowerShell snap-in loaded. For more information on how to start a Windows PowerShell console that has the MDT PowerShell snap-in loaded, see "Loading the MDT Windows PowerShell Snap-In".

Syntax

Remove-MDTMonitorData [-Path <String>] [-ID <Int32>] [<CommonParameters>]  

–or–

Remove-MDTMonitorData [-Path <String>] [-ComputerObject <PSObject>] [<CommonParameters>]  

Description

This cmdlet removes collected monitoring data from the existing collected monitoring data in a deployment share. You can identify the monitoring data to remove by specifying the:

  • Identifier (ID) of the monitoring item for a specific deployment share. The monitoring item IDs are automatically generated and assigned to the item when the item is created for the deployment share. The first syntax example illustrates this usage.

  • Computer object for the monitoring item in the deployment share. The computer object can be obtained using the Get-MDTMonitorData cmdlet. The last syntax example illustrates this usage.

Note

Once the monitoring data has been removed, there is no method for recovering the information.

Parameters

This subsection provides information about the various parameters that can be used with the Get- MDTMonitorData cmdlet.

-Path <String>

This parameter specifies the MDTProvider Windows PowerShell drive for the desired deployment share.

Note

If this parameter is not provided, then the Windows PowerShell working directory must default to a location within the desired MDTProvider Windows PowerShell drive.

Parameter Value
Required? False
Position? Named
Default value
Accept pipeline input? False
Accept wildcard characters? False
-ID <Nullable>

This parameter specifies the monitoring data item to be removed using the identifier of the monitoring data item. If this parameter is not specified, then the ComputerObject parameter must be specified to identify a particular monitoring data item.

Parameter Value
Required? False
Position? Named
Default value
Accept pipeline input? True (ByValue)
Accept wildcard characters? False
-ComputerObject <PSObject>

This parameter specifies the monitoring data item to be removed using a computer object. If this parameter is not specified, then the ID parameter must be specified to identify a particular monitoring data item.

Parameter Value
Required? False
Position? Named
Default value
Accept pipeline input? True (ByValue)
Accept wildcard characters? False
<CommonParameters>

This cmdlet supports the following common parameters: Verbose, Debug, ErrorAction, ErrorVariable, OutBuffer, OutVariable, WarningAction, and WarningVariable. For more information, see the topic, “about_CommonParameters,” which you can access by typing the following command, and then pressing ENTER:

Get-Help about_CommonParameters  

Outputs

This cmdlet may output a String type object if the Verbose common parameter is included; otherwise, no output is generated.

Example 1

Remove-MDTMonitorData -Path "DS001:" -ID 3  
Description

This example removes the monitoring data item with an ID that has a value of 3 from the deployment share at the Windows PowerShell path DS001:.

Example 2

Remove-MDTMonitorData -ID 3  
Description

This example removes the monitoring data item with an ID that has a value of 3 from the deployment share at the default Windows PowerShell path.

Example 3

$MonitorObject=Get-MDTMonitorData | Where-Object {$_.Name eq 'WDG-REF-01'}  
Remove-MDTMonitorData -ComputerObject $MonitorObject  
Description

This example removes any monitoring data item where the name of the computer is WDG-REF-01. The object is found using the Get-MDTMonitorData cmdlet and the Where-Object cmdlet. For more information on the Where-Object cmdlet, see Using the Where-Object Cmdlet.

Remove-MDTPersistentDrive

This section describes the Remove-MDTPersistentDriveWindows Windows PowerShell cmdlet. Run this cmdlet from a Windows PowerShell console that has the MDT PowerShell snap-in loaded. For more information on how to start a Windows PowerShell console that has the MDT PowerShell snap-in loaded, see "Loading the MDT Windows PowerShell Snap-In".

Syntax

Remove-MDTPersistentDrive [-Name] <String> [[-InputObject] <PSObject>] [<CommonParameters>]  

Description

This cmdlet removes an existing Windows PowerShell drive created using the MDTProvider from the list of drives that are persisted in the Deployment Workbench or in a Windows PowerShell session using the Restore-MDTPersistentDrive cmdlet. This cmdlet is called when a deployment share is closed in (removed from) the Deployment Workbench.

Note

The list of persisted MDTProvider drives is maintained on a per-user based in the user profile.

The list of persisted MDTProvider drives can be displayed using the Get-MDTPersistentDrive cmdlet. An MDTProvider drive can be added to the list of persisted drives using the Add-MDTPersistentDrive cmdlet.

Parameters

This subsection provides information about the various parameters that can be used with the Add-MDTPersistentDriveWindows cmdlet.

-Name <String>

Specifies the name of a Windows PowerShell drive created using the MDT provider and corresponds to an existing deployment share. The name was created using the New-PSDrive cmdlet and specifying the MDTProvider in the PSProvider parameter.

For more information on how to create a new Windows PowerShell drive using the MDTProvider and how to create a deployment share using Windows PowerShell, see the section "Creating a Deployment Share Using Windows PowerShell" in the MDT document, Microsoft Deployment Toolkit Samples Guide.

Parameter Value
Required? True
Position? 1 and Named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? False
-InputObject <PSObject>

This parameter specifies a Windows PowerShell drive object that was created earlier in the process. Enter a PSObject object, such as one generated by the New-PSDrive cmdlet.

Parameter Value
Required? False
Position? 2 and Named
Default value
Accept pipeline input? True (ByValue)
Accept wildcard characters? False
<CommonParameters>

This cmdlet supports the following common parameters: Verbose, Debug, ErrorAction, ErrorVariable, OutBuffer, OutVariable, WarningAction, and WarningVariable. For more information, see the topic, “about_CommonParameters,” which you can access by typing the following command, and then pressing ENTER:

Get-Help about_CommonParameters  

Outputs

This cmdlet provides no outputs.

Example 1

Remove-MDTPersistentDrive –Name "DS001:"  
Description

This example removes the deployment share with the Windows PowerShell drive name of DS001 from the list of persisted drives.

Example 2

$MDTPSDrive = Get-PSDrive | Where-Object {$_.Root -eq "C:\DeploymentShare" -and $_.Provider -like "*MDTProvider"}   
Remove-MDTPersistentDrive –InputObject $MDTPSDrive  
Description

This example removes the deployment share at C:\DeploymentShare$ from the list of persisted drives. The GetPSDrive and Where-Object cmdlets are used to return the MDT persisted Windows PowerShell drive to the Remove-MDTPersistentDrive cmdlet using the $MDTPSDrive variable. For more information on the Where-Object cmdlet, see Using the Where-Object Cmdlet. For more information on the Get-PSDrive cmdlet, see Using the Get-PSDrive Cmdlet.

Restore-MDTPersistentDrive

This section describes the Restore-MDTPersistentDrive Windows PowerShell cmdlet. Run this cmdlet from a Windows PowerShell console that has the MDT PowerShell snap-in loaded. For more information on how to start a Windows PowerShell console that has the MDT PowerShell snap-in loaded, see "Loading the MDT Windows PowerShell Snap-In".

Syntax

Restore-MDTPersistentDrive [-Force] [<CommonParameters>]  

Description

This cmdlet restores a persisted MDT Windows PowerShell drive to the list of active Windows PowerShell drive for each deployment share that was added to the list of persisted MDT Windows PowerShell drives. The list of persisted MDT Windows PowerShell drives is managed using the Add-MDTPersistentDrive and Remove-MDTPersistentDrive cmdlets or the Deployment Workbench.

This cmdlet calls the New-PSDrive cmdlet to create a Windows PowerShell drive for each drive in the MDT persisted list. Persisted MDT Windows PowerShell drives are similar to persisted network drive mappings.

Note

This list of persisted MDT Windows PowerShell drives is maintained on a per-user basis and are stored in the user profile.

Parameters

This subsection provides information about the various parameters that can be used with the Restore-MDTPersistentDrive cmdlet.

-Force [<SwitchParameter>]

This parameter specifies that the deployment share should be upgraded when restored (if required). If this parameter is:

  • Provided, then the deployment share will be upgraded when restored (if required)

  • Omitted, then deployment share will not be upgraded when restored

Parameter Value
Required? False
Position? Named
Default value
Accept pipeline input? True (ByValue)
Accept wildcard characters? False
<CommonParameters>

This cmdlet supports the following common parameters: Verbose, Debug, ErrorAction, ErrorVariable, OutBuffer, OutVariable, WarningAction, and WarningVariable. For more information, see the topic, “about_CommonParameters,” which you can access by typing the following command, and then pressing ENTER:

Get-Help about_CommonParameters  

Outputs

This cmdlet outputs a PSObject type object for each MDT Provider Windows PowerShell drive that is restored.

Example 1

Get-MDTPersistentDrive  
Description

This example restores the list of MDT persisted drives, by creating a Windows PowerShell drive using the MDTProvider type. The deployment share will not be upgraded when restored.

Example 2

Get-MDTPersistentDrive -Force  
Description

This example restores the list of MDT persisted drives, by creating a Windows PowerShell drive using the MDTProvider type. The deployment share will be upgraded when restored (if required).

Set-MDTMonitorData

This section describes the Get-MDTPersistentDrive Windows PowerShell cmdlet. Run this cmdlet from a Windows PowerShell console that has the MDT PowerShell snap-in loaded. For more information on how to start a Windows PowerShell console that has the MDT PowerShell snap-in loaded, see "Loading the MDT Windows PowerShell Snap-In".

Syntax

Set-MDTMonitorData [-Path <String>] [-ComputerObject <PSObject>] [-Settings <Hashtable>] [<CommonParameters>]  

–or–

Set-MDTMonitorData [-Path <String>] [-MacAddress <String>] [Settings <Hashtable>] [<CommonParameters>]  

Description

This cmdlet creates a new monitoring data item, or updates an existing monitoring data item, in a deployment share. You can identify the monitoring data to remove by specifying the:

  • Computer object for the monitoring item in the deployment share. The computer object can be obtained using the Get-MDTMonitorData cmdlet. The first syntax example illustrates this usage.

  • MAC address of the primary network adapter of the monitoring item for a specific deployment share. The MAC address is automatically assigned to the monitoring data item when the item is created for the deployment share. The last syntax example illustrates this usage.

Note

Once the monitoring data has been removed, there is no method for recovering the information.

Parameters

This subsection provides information about the various parameters that can be used with the Get- MDTMonitorData cmdlet.

-Path <String>

This parameter specifies the MDTProvider Windows PowerShell drive for the desired deployment share.

Note

If this parameter is not provided, then the Windows PowerShell working directory must default to a location within the desired MDTProvider Windows PowerShell drive.

Parameter Value
Required? False
Position? Named
Default value
Accept pipeline input? False
Accept wildcard characters? False
-ComputerObject <PSObject>

This parameter specifies the monitoring data item to be created or updated using a computer object. If this parameter is not specified, then the MACAddress parameter must be specified to identify a particular monitoring data item.

Parameter Value
Required? False
Position? Named
Default value
Accept pipeline input? True (ByValue)
Accept wildcard characters? False
-MACAddress <String>

This parameter specifies the monitoring data item to be created or updated using the MAC address of the primary network adapter of the computer being monitored. The format of the MACAddress is xx:xx:xx:xx:xx:xx, where x is a hexadecimal character specified in uppercase (as required). If this parameter is not specified, then the ComputerObject parameter must be specified to identify a particular monitoring data item.

Parameter Value
Required? False
Position? Named
Default value
Accept pipeline input? True (ByValue)
Accept wildcard characters? False
-Settings <Hashtable>

This parameter specifies the monitoring data settings for the monitoring data item to be created or updated. The format of the hashtable provided with this parameter is @{"Setting"="Value"; "Setting1"="Value1"; "Setting2"="Value2}. If this parameter is not specified, then the monitoring data item is created, but no monitoring information is stored.

"Setting" can be any property listed in the ZTIGather.xml file. Value can be any valid value for the property specfied in "Setting".

Parameter Value
Required? False
Position? Named
Default value
Accept pipeline input? True (ByValue)
Accept wildcard characters? False
<CommonParameters>

This cmdlet supports the following common parameters: Verbose, Debug, ErrorAction, ErrorVariable, OutBuffer, OutVariable, WarningAction, and WarningVariable. For more information, see the topic, “about_CommonParameters,” which you can access by typing the following command, and then pressing ENTER:

Get-Help about_CommonParameters  

Outputs

This cmdlet does not generate any output.

Example 1

$MonitorObject=Get-MDTMonitorData | Where-Object {$_.Name eq 'WDG-REF-01'}  
Set-MDTMonitorData -ComputerObject $MonitorObject Setting @{"OSDComputerName"="WDG-MDT-01";"SkipWizard"="YES"}  
Description

This example removes any monitoring data item where the name of the computer is WDG-REF-01. The object is found using the Get-MDTMonitorData cmdlet and the Where-Object cmdlet. For more information on the Where-Object cmdlet, see Using the Where-Object Cmdlet. The OSDComputerName property is recorded as having a value of WDG-MDT-01, and the SkipWizard property is recorded as having a value of YES.

Example 2

Set-MDTMonitorData -MACAddress "00:11:22:33:44:55" MonitorObject Setting @{"OSDComputerName"="WDG-MDT-01";"SkipWizard"="YES"}  
Description

This example creates or updates a monitoring data item with a MACAddress that has a value of 00:11:22:33:44:55. The OSDComputerName property is recorded as having a value of WDG-MDT-01, and the SkipWizard property is recorded as having a value of YES.

Test-MDTDeploymentShare

Although this cmdlet is returned using the Get-Command cmdlet as being in the Microsoft.BDD.PSSnapIn snap-in, it is not implemented.

Test-MDTMonitorData

This section describes the Test-MDTMonitorData Windows PowerShell cmdlet. Run this cmdlet from a Windows PowerShell console that has the MDT PowerShell snap-in loaded. For more information on how to start a Windows PowerShell console that has the MDT PowerShell snap-in loaded, see "Loading the MDT Windows PowerShell Snap-In".

Syntax

Test-MDTMonitorData -ServerName <String> -EventPort <Int32> -DataPort <Int32> [<CommonParameters>]  

Description

This cmdlet validates if the MDT monitoring service, which runs on the computer on which MDT is installed, is enabled and running properly. The MDT monitoring service collects monitoring information that can be displayed:

Note

For this cmdlet to function properly there must be at least one MDT monitoring data item in the deployment share. If no MDT monitoring information has been recorded, the deployment share will fail the test.

For more information on the MDT monitoring service, see the section "Monitoring MDT Deployments" in the MDT document, Using the Microsoft Deployment Toolkit.

Parameters

This subsection provides information about the various parameters that can be used with the Test-MDTMonitorData cmdlet.

-Server <String>

Specifies the name of the computer on which MDT is installed and the MDT monitoring service is running.

Parameter Value
Required? True
Position? Named
Default value None
Accept pipeline input? False
Accept wildcard characters? False
-DataPort <Int32>

This parameter specifies the TCP port used as the data port for the MDT monitoring service.

Parameter Value
Required? True
Position? Named
Default value
Accept pipeline input? False
Accept wildcard characters? False
-EventPort <Int32>

This parameter specifies the TCP port used as the event port for the MDT monitoring service.

Parameter Value
Required? True
Position? Named
Default value
Accept pipeline input? False
Accept wildcard characters? False
<CommonParameters>

This cmdlet supports the following common parameters: Verbose, Debug, ErrorAction, ErrorVariable, OutBuffer, OutVariable, WarningAction, and WarningVariable. For more information, see the topic, “about_CommonParameters,” which you can access by typing the following command, and then pressing ENTER:

Get-Help about_CommonParameters  

Outputs

This cmdlet outputs a Boolean value that represents the success (true) or failure (false) of the text.

Example 1

Test-MDTMonitorData -Server "WDG-MDT-01" -DataPort "9801" EventPort "9800"  
Description

This example verifies if the MDT monitoring service on WDG-MDT-01 is installed and running. The cmdlet will verify using a data port of 9801 and an event port of 9800.

Update-MDTDatabaseSchema

This section describes the Update-MDTDatabaseSchema Windows PowerShell cmdlet. Run this cmdlet from a Windows PowerShell console that has the MDT PowerShell snap-in loaded. For more information on how to start a Windows PowerShell console that has the MDT PowerShell snap-in loaded, see "Loading the MDT Windows PowerShell Snap-In".

Syntax

Update-MDTDatabaseSchema -SQLServer <String> [-Instance <String>] [-Port <String>] [-Netlib <String>] -Database <String> [-SQLShare <String>] [<CommonParameters>]  

Description

This cmdlet updates an existing MDT DB database to the latest version of the MDT DB database schema. Each deployment share can be associated with only one MDT DB database.

This cmdlet is automatically called when a deployment share is being upgraded, such as when running the Restore-MDTPersistentDrive cmdlet with the Force parameter and the Update-MDTDeploymentShare cmdlet.

Parameters

This subsection provides information about the various parameters that can be used with the Upgrade-MDTDatabaseSchema cmdlet.

-SQLServer <String>

This parameter specifies the name of the computer running SQL Server where the MDT DB database will be upgraded.

Parameter Value
Required? True
Position? Named
Default value
Accept pipeline input? False
Accept wildcard characters? False
-Instance <String>

This parameter specifies the SQL Server instance on which the MDT DB database to be upgraded exists. If this parameter is omitted, then the MDT DB database is assumed to be in the default SQL Server instance.

Note

The SQL Browser service must be running on the computer running SQL Server for the cmdlet to locate the instance specified in this parameter.

Parameter Value
Required? False
Position? Named
Default value
Accept pipeline input? False
Accept wildcard characters? False
-Port <String>

This parameter specifies the TCP port to be used in communication with the SQL Server instance specified in the SQLServer parameter. The default port that SQL Server uses is 1433. Specify this parameter when SQL Server is configured to use a port other than the default value. The value of this parameter must match the port configured for SQL Server.

Parameter Value
Required? False
Position? Named
Default value
Accept pipeline input? False
Accept wildcard characters? False
-Netlib <String>

This parameter specifies the SQL network library that is used in communication with the SQL Server instance specified in the SQLServer parameter. The parameter can be set to one of the following values:

  • DBNMPNTW, which is used to specify named pipes communication

  • DBSMSOCN, which is used to specify TCP/IP sockets communication

    If this parameter is not provided, the named pipes SQL network library (DBNMPNTW) is used.

Note

The Deployment Workbench does not provide the option for configuring the SQL network library. The Deployment Workbench always uses named pipes communication. However, the SQL network library can be configured in the CustomSettings.ini file.

Parameter Value
Required? False
Position? Named
Default value
Accept pipeline input? False
Accept wildcard characters? False
-Database <String>

This parameter specifies the name of the database to be upgraded in the SQL Server instance specified in the Instance parameter on the SQL Server instance specified in the SQLServer parameter.

Parameter Value
Required? True
Position? Named
Default value
Accept pipeline input? False
Accept wildcard characters? False
<CommonParameters>

This cmdlet supports the following common parameters: Verbose, Debug, ErrorAction, ErrorVariable, OutBuffer, OutVariable, WarningAction, and WarningVariable. For more information, see the topic, “about_CommonParameters,” which you can access by typing the following command, and then pressing ENTER:

Get-Help about_CommonParameters  

Outputs

This cmdlet outputs a PSObject type object for the MDT database that was upgraded. This cmdlet also outputs a String type data if the Verbose common parameter is included.

Example 1

Update-MDTDatabaseSchema –SQLServer "WDGSQL01" Database "MDTDB"   
Description

This example updates the schema for an MDT database named MDTDB in the default SQL Server instance on a computer named WDG-SQL-01. The connection will be made to the SQL Server instance using the default TCP port and the Named Pipes protocol.

Example 2

Update-MDTDatabaseSchema –SQLServer "WDGSQL01" –Instance "MDTInstance" -Port "6333" Database "MDTDB"  
Description

This example updates the schema for an MDT database named MDTDB in the SQL Server instance named MDTInstance on a computer named WDG-SQL-01. The connection will be made to the SQL Server using TCP port 6333 and the Named Pipes protocol.

Update-MDTDeploymentShare

This section describes the Update-MDTDeploymentShare Windows PowerShell cmdlet. Run this cmdlet from a Windows PowerShell console that has the MDT PowerShell snap-in loaded. For more information on how to start a Windows PowerShell console that has the MDT PowerShell snap-in loaded, see "Loading the MDT Windows PowerShell Snap-In".

Syntax

Update-MDTDeploymentShare [-Path <String>] [-Force] [Compress] [<CommonParameters>]  

Description

This cmdlet updates an existing deployment share with the latest files from the Windows ADK. This cmdlet also updates or regenerates the required Windows PE boot images in both WIM and ISO file formats.

Parameters

This subsection provides information about the various parameters that can be used with the Update-MDTDeploymentShare cmdlet.

-Path <String>

This parameter specifies the fully qualified path to an existing folder in the deployment share that is being updated.

Note

If this parameter is not provided, then the Windows PowerShell working directory must default to the desired location within the deployment share.

Parameter Value
Required? False
Position? Named
Default value
Accept pipeline input? False
Accept wildcard characters? False
-Force [<SwitchParameter>]

This parameter specifies whether Windows PE boot images (.iso and .wim files) for the deployment share should be completely regenerated. If this parameter is:

  • Provided, then the cmdlet creates new versions of the Windows PE boot images. This process takes more time than optimizing the existing Windows PE boot images.

  • Omitted, then the cmdlet optimizes the existing Windows PE boot images. This process takes less time than generating new versions of the Windows PE boot images. If this parameter is omitted, the Compress parameter can be used to reduce the size of the boot images as a part of the Windows PE boot image optimization process.

Parameter Value
Required? False
Position? Named
Default value
Accept pipeline input? True (ByValue)
Accept wildcard characters? False
-Compress [<SwitchParameter>]

This parameter specifies whether Windows PE boot images (.iso and .wim files) for the deployment share should be compressed when they are optimized (without the Force parameter). If this parameter is:

  • Provided, then the cmdlet compresses the Windows PE boot images as they are being optimized

  • Omitted, then the cmdlet does not compress the Windows PE boot images as they are being optimized

Note

This parameter should only be provided if the Force parameter is not provided. If the Force parameter is included, new Windows PE boot images are generated and are compressed to the minimal size.

Parameter Value
Required? False
Position? Named
Default value
Accept pipeline input? True (ByValue)
Accept wildcard characters? False
<CommonParameters>

This cmdlet supports the following common parameters: Verbose, Debug, ErrorAction, ErrorVariable, OutBuffer, OutVariable, WarningAction, and WarningVariable. For more information, see the topic, “about_CommonParameters,” which you can access by typing the following command, and then pressing ENTER:

Get-Help about_CommonParameters  

Outputs

This cmdlet outputs a String type data and produces additional String type data if the Verbose common parameter is included.

Example 1

Update-MDTDepoymentShare   
Description

This example updates the deployment share at the Windows PowerShell working directory. The Windows PE boot images will be optimized. The Windows PE boot images will not be compressed.

Example 2

Update-MDTDepoymentShare -Path "DS001:"  
Description

This example updates the deployment share at the MDT Windows PowerShell drive named DS001:. The Windows PE boot images will be optimized. The Windows PE boot images will not be compressed.

Example 3

Update-MDTDepoymentShare -Path "DS001:" -Compress  
Description

This example updates the deployment share at the MDT Windows PowerShell drive named DS001:. The Windows PE boot images will be optimized. The Windows PE boot images will be compressed.

Example 4

Update-MDTDepoymentShare -Path "DS001:" -Force  
Description

This example updates the deployment share at the MDT Windows PowerShell drive named DS001:. New versions of the Windows PE boot images will be generated.

Update-MDTLinkedDS

This section describes the Update-MDTLinkedDS Windows PowerShell cmdlet. Run this cmdlet from a Windows PowerShell console that has the MDT PowerShell snap-in loaded. For more information on how to start a Windows PowerShell console that has the MDT PowerShell snap-in loaded, see "Loading the MDT Windows PowerShell Snap-In".

Syntax

Update-MDTLinkedDS -Path <String> [<CommonParameters>]  

Description

This cmdlet replicates content from a deployment share to a linked deployment share using the selection profile used to define the linked deployment share. The replication behavior is determined based on the configuration settings for the linked deployment share.

Parameters

This subsection provides information about the various parameters that can be used with the Update-MDTLinkedDS cmdlet.

-Path <String>

This parameter specifies the fully qualified path to the linked deployment share that is being updated.

Note

If this parameter is not provided, then the Windows PowerShell working directory must default to the desired location within the deployment share.

Parameter Value
Required? True
Position? Named
Default value
Accept pipeline input? False
Accept wildcard characters? False
<CommonParameters>

This cmdlet supports the following common parameters: Verbose, Debug, ErrorAction, ErrorVariable, OutBuffer, OutVariable, WarningAction, and WarningVariable. For more information, see the topic, “about_CommonParameters,” which you can access by typing the following command, and then pressing ENTER:

Get-Help about_CommonParameters  

Outputs

This cmdlet outputs a String type data and produces additional String type data if the Verbose common parameter is included.

Example 1

Update-MDTLinkedDS -Path "DS001:\Linked Deployment Shares\LINKED001"  
Description

This example replicates content from the deployment share to the linked deployment share at the Windows PowerShell path DS001:\Linked Deployment Shares\LINKED001 folder.

Update-MDTMedia

This section describes the Update-MDTMedia Windows PowerShell cmdlet. Run this cmdlet from a Windows PowerShell console that has the MDT PowerShell snap-in loaded. For more information on how to start a Windows PowerShell console that has the MDT PowerShell snap-in loaded, see "Loading the MDT Windows PowerShell Snap-In".

Syntax

Update-MDTMedia -Path <String> [<CommonParameters>]  

Description

This cmdlet replicates content from a deployment share to a folder that contains deployment media using the selection profile used to define the deployment media. The replication behavior is determined based on the configuration settings for the deployment media.

Media in LTI allows you to perform LTI deployments solely from local media without connecting to a deployment share. You can store the media on a DVD, USB hard disk, or other portable device. After you create the media, generate bootable WIM images that allow the deployment to be performed from portable media devices locally available on the target computer.

Parameters

This subsection provides information about the various parameters that can be used with the Update-MDTMedia cmdlet.

-Path <String>

This parameter specifies the fully qualified path to the folder that contains the deployment media that is being updated.

Note

If this parameter is not provided, then the Windows PowerShell working directory must default to the desired location within the deployment share.

Parameter Value
Required? True
Position? Named
Default value
Accept pipeline input? False
Accept wildcard characters? False
<CommonParameters>

This cmdlet supports the following common parameters: Verbose, Debug, ErrorAction, ErrorVariable, OutBuffer, OutVariable, WarningAction, and WarningVariable. For more information, see the topic, “about_CommonParameters,” which you can access by typing the following command, and then pressing ENTER:

Get-Help about_CommonParameters  

Outputs

This cmdlet outputs a String type data and produces additional String type data if the Verbose common parameter is included.

Example 1

Update-MDTMedia -Path "DS001:\Media\MEDIA001"  
Description

This example replicates content from the deployment share to the folder containing the deployment media at the Windows PowerShell path DS001:\Media \MEDIA001 folder.

Tables and Views in the MDT DB

In MDT, many property settings can be stored (typically configured in the CustomSettings.ini file) in a database. Configuring the properties in a database helps create a generic CustomSettings.ini file that requires fewer modifications and allows one CustomSettings.ini file to be used in more images (because the file is more generic).

Customize the database in the Database node in the Deployment Workbench. Using the Deployment Workbench, the deployment settings can be configured and saved in tables.

However, queries about the information in the tables are done using views. Views help simplify the queries by joining results from multiple tables. ZTIGather.wsf queries the views to return the result set that the Parameters and ParameterCondition properties specify.

Tables in the MDT DB

The following table lists the database tables that Deployment Workbench creates and manages.

Table Description
ComputerIdentity Used to identify a specific computer using any combination of the AssetTag, UUID, SerialNumber, and MACAddress properties. The table includes a Description column to provide a user-friendly method of describing the computer (usually the computer name).
Descriptions Contains descriptions of all properties configurable via the database.
LocationIdentity Used to identify geographic locations using the Location property. The values for this property are stored in a corresponding column in the table.
LocationIdentity_DefaultGateway Relates the default gateway values with a location identified in the LocationIdentity table. There is a one-to-many relationship between this table and the LocationIdentity table.
MakeModelIdentity Used to identify a specific make and model of a computer using the Make and Model properties. The values for these properties are stored in corresponding columns in the table.
PackageMapping Used to associate the name presented in the Add or Remove Programs Control Panel item with a Configuration Manager package and program to be deployed in place of the application in Add or Remove Programs. For more information on this table, see the section, "Deploying Applications Based on Earlier Application Versions", in the MDT document Microsoft Deployment Toolkit Samples Guide.
RoleIdentity Used to identify the purpose of a computer or the users of a computer using the Role property. The values for this property are stored in a corresponding column in the table.
Settings Identifies the settings that are applied to an individual computer or a group of computers based on the settings in the Computers, Roles, Locations, and Make and Model nodes in the Database node in the Deployment Workbench.
Settings_Administrators Identifies the user accounts to be added to the local Administrator group on the target computer based on the settings in the Computers, Roles, Locations, and Make and Model nodes in the Database node in the Deployment Workbench.
Settings_Applications Identifies the applications to be deployed to the target computer based on the settings in the Computers, Roles, Locations, and Make and Model nodes in the Database node in the Deployment Workbench.
Settings_Packages Identifies the packages to be deployed to the target computer based on the settings in the Computers, Roles, Locations, and Make and Model nodes in the Database node in the Deployment Workbench.
Settings_Roles Identifies the roles to be associated with the target computer based on the settings in the Computers, Locations, and Make and Model nodes in the Database node in the Deployment Workbench.

Views in the MDT DB

The following table lists and describes the database views that are used when querying configuration information in the MDT DB.

View Description
ComputerAdministrators Used to find all accounts to be made members of the local Administrators group on the target computer. The view is a join of the ComputerIdentity and Settings_Administrators tables.
ComputerApplications Used to find all applications to be deployed to the target computer. The view is a join of the ComputerIdentity and Settings_Applications tables.
ComputerPackages Used to find all packages to be deployed to the target computer. The view is a join of the ComputerIdentity and Settings_Packages tables.
ComputerRoles Used to find all roles to be associated with the target computer. The view is a join of the ComputerIdentity and Settings_Roles tables.
ComputerSettings Used to find all property settings to be configured for the target computer. The view is a join of the ComputerIdentity and Settings tables.
LocationAdministrators Used to find all the accounts to be made a member of the local Administrators group on the target computers within a location. The view is a join of the LocationIdentity, LocationIdentity_DefaultGateway, and Settings_Administrators tables.
LocationApplications Used to find all the applications to be deployed to the target computers within a location. The view is a join of the LocationIdentity, LocationIdentity_DefaultGateway, and Settings_Applications tables.
LocationPackages Used to find all the packages to be deployed to the target computers within a location. The view is a join of the LocationIdentity, LocationIdentity_DefaultGateway, and Settings_Packages tables.
LocationRoles Used to find all the roles to be associated with the target computers within a location. The view is a join of the LocationIdentity, LocationIdentity_DefaultGateway, and Settings_Roles tables.
Locations Used to find the IP addresses for the default gateways within a location or for all the locations that contain a specified IP address for a default gateway. The view is a join of the LocationIdentity and LocationIdentity_DefaultGateway tables.
LocationSettings Used to find all the property settings to be configured for the target computers within a location. The view is a join of the LocationIdentity, LocationIdentity_DefaultGateway, and Settings tables.
MakeModelAdministrators Used to find all accounts to be made members of the local Administrators group on the target computers with a given make and model. The view is a join of the MakeModelIdentity and Settings_Administrators tables.
MakeModelApplications Used to find all applications to be deployed to the target computers with a given make and model. The view is a join of the MakeModelIdentity and Settings_Applications tables.
MakeModelPackages Used to find all packages to be deployed to the target computers with a given make and model. The view is a join of the MakeModelIdentity and Settings_Applications tables.
MakeModelRoles Used to find all roles associated with the target computers with a given make and model. The view is a join of the MakeModelIdentity and Settings_Roles tables.
MakeModelSettings Used to find all property settings to be configured for the target computers with a given make and model. The view is a join of the MakeModelIdentity and Settings tables.
RoleAdministrators Used to find all accounts to be made members of the local Administrators group on the target computers with a given role. The view is a join of the RoleIdentity and Settings_Administrators tables.
RoleApplications Used to find all applications to be deployed to the target computers with a given role. The view is a join of the RoleIdentity and Settings_Applications tables.
RolePackages Used to find all packages to be deployed to the target computers with a given role. The view is a join of the RoleIdentity and Settings_Packages tables.
RoleSettings Used to find all property settings to be configured for the target computers with a given role. The view is a join of the RoleIdentity and Settings tables.

Windows 7 Feature Dependency Reference

Table 8 lists the Windows 7 features, the parent feature, and any dependent features. You can use this information to determine which features and roles need to be installed to support a specific feature using the Install Roles and Features and Uninstall Roles and Features task sequence steps.

Table 8. Windows 7 Feature Dependency Reference

Feature Parent Feature Dependent Features
Windows Media® Center Media Features Might affect other Windows features
Windows DVD Maker Media Features Might affect other Windows features
Windows Media Player Media Features Might affect other Windows features
Windows Search N/A Might affect other Windows features
Internet Explorer (amd64) N/A Might affect other Windows features
World Wide Web services Microsoft Internet Information Services (IIS) - Microsoft Message Queuing (MSMQ) HTTP support

- Windows Communication Foundation (WCF) HTTP activation
IIS 6 WMI compatibility IIS, Web management tools, IIS 6 management compatibility IIS 6 scripting tooling
Microsoft .NET extensibility IIS, World Wide Web services, application development features - Microsoft ASP.NET

- MSMQ HTTP support

- WCF HTTP activation
Default document IIS, World Wide Web services, common HTTP features MSMQ HTTP support
Directory browsing IIS, World Wide Web services, common HTTP features MSMQ HTTP support
HTTP redirection IIS, World Wide Web services, common HTTP features MSMQ HTTP support
Static content IIS, World Wide Web services, common HTTP features - Web-based Distributed Authoring and Versioning (WebDAV) publishing

- MSMQ HTTP support
Custom logging IIS, World Wide Web services, health and diagnostics MSMQ HTTP support
HTTP logging IIS, World Wide Web services, health and diagnostics MSMQ HTTP support
ODBC logging IIS, World Wide Web services, health and diagnostics MSMQ HTTP support
Request Monitor IIS, World Wide Web services, health and diagnostics MSMQ HTTP support
Tracing IIS, World Wide Web services, health and diagnostics MSMQ HTTP support
Static content compression IIS, World Wide Web services, performance features MSMQ HTTP support
Security IIS, World Wide Web services - Microsoft .NET extensibility

- MSMQ HTTP support

- WCF HTTP activation
Request Filtering IIS, World Wide Web services, security - Microsoft .NET extensibility

- MSMQ HTTP support

- WCF HTTP activation
XPS Viewer N/A Might affect other Windows features

UDI Reference

This reference provides further information about UDI and includes topics on: