Property Reference

Administrators

User accounts and domain groups to add to the local Administrators group on the target computer.

user1 , user2

List of the users and groups, separated by commas, to be added to the local Administrators group.

[Settings]
Priority=Default
Properties=MyCustomProperty
[Default]
OSInstall=Y
ScanStateArgs=/v:5 /o /c
LoadStateArgs=/v:5 /c /lac
Packages1=NYC00010-Install
Packages2=NYC00011-Install
Administrators1=WOODGROVEBANK\NYC Help Desk Staff    
PowerUsers1=WOODGROVEBANK\User01
PowerUsers2=WOODGROVEBANK\User02

PowerUsers

AdminPassword

Password used for the local administrator account when deploying the operating system on the target computer.

admin_password

The password for the local administrator account on the target computer.

[Settings]
Priority=Default
Properties=MyCustomProperty
[Default]
OSInstall=Y
ScanStateArgs=/v:5 /o /c
LoadStateArgs=/v:5 /c /lac 
AdminPassword=P@ssw0rd
Packages1=NYC00010-Install
Packages2=NYC00011-Install
Administrators1=WOODGROVEBANK\NYC Help Desk Staff    
PowerUsers1=WOODGROVEBANK\User01
PowerUsers2=WOODGROVEBANK\User02

N/A

Applications

Application globally unique identifiers (GUIDs) to be installed on the target computer. These applications are specified in Deployment Workbench in the Applications node. These GUIDs are stored in the Applications.xml file.

application_guid

The GUID 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.

[Settings]
Priority=Default
Properties=MyCustomProperty
[Default]
OSInstall=Y
ScanStateArgs=/v:5 /o /c
LoadStateArgs=/v:5 /c /lac
Applications1={1D7DF331-47B7-472C-87B3-442597EC2F7D}
Applications2={9d2b8999-5e4d-4f3d-bb05-edaaf4fe5628}
Administrators1=WOODGROVEBANK\NYC Help Desk Staff

Packages

Architecture

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

Use the CapableArchitecture property to identify the actual processor architecture supported by the target computer.

X86

Processor architecture is 32-bit.

Note   This property is dynamically set by the BDD 2007 scripts and is not configured in CustomSettings.ini. Treat this property as read-only.

CapableArchitecture, HALName, Make, Memory, Model, ProcessorSpeed, UUID

AreaCode

The area code to be configured for the operating system on the target computer. This property allows only numeric characters. This value gets inserted into the appropriate configuration settings in unattend.txt or sysprep.inf for Microsoft Windows® XP or unattend.xml for Windows Vista.

area_code

The area code where the target computer is to be deployed.

[Settings]
Priority=Default
Properties=MyCustomProperty
[Default]
OSInstall=Y
ScanStateArgs=/v:5 /o /c
LoadStateArgs=/v:5 /c /lac
DoCapture=Y
AreaCode=206
CountryCode=001
Dialing=TONE
LongDistanceAccess=9
BackupShare=\\NYC-AM-FIL-01\Backup$
BackupDir=%ComputerName%
DeployRoot=\\NYC-AM-FIL-01\Distribution$
ResourceRoot=\\NYC-AM-FIL-01\Resource$
UDShare=\\NYC-AM-FIL-01\MigData$
UDDir=%ComputerName%

CountryCode, Dialing, LongDistanceAccess

AssetTag

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.

asset_tag

The format of the asset tag is undefined and is determined by the asset tag standard of each organization.

[Settings]
Priority=AssetTag, Default
Properties=MyCustomProperty
[Default]
OSInstall=Y
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$
CaptureGroups=YES
Groups1=NYC Application Management
Groups2=NYC Help Desk Users
[DAL-0034034931]
OSDNEWMACHINENAME=HPD530-1
OSDINSTALLPACKAGE=DAL00342
OSDINSTALLPROGRAM=CustomVista
[NYC-0034003233]
OSDNEWMACHINENAME=BVMXP
OSDINSTALLPACKAGE=NYC00002
OSDINSTALLPROGRAM=SpecialVista

MACAddress, Make, Model, Product, SerialNumber, UUID

BackupDir

Folder in which backups of the target computer are stored. This folder exists beneath the Universal Naming Convention (UNC) path specified in the BackupShare property. If the folder does not already exist, the folder is created automatically.

folder

The name of the folder that exists beneath the shared folder specified in the BackShare property.

[Settings]
Priority=Default
Properties=MyCustomProperty
[Default]
OSInstall=Y
ScanStateArgs=/v:5 /o /c
LoadStateArgs=/v:5 /c /lac
DoCapture=Y
BackupShare=\\NYC-AM-FIL-01\Backup$
BackupDir=%ComputerName%
DeployRoot=\\NYC-AM-FIL-01\Distribution$
ResourceRoot=\\NYC-AM-FIL-01\Resource$
UDShare=\\NYC-AM-FIL-01\MigData$
UDDir=%ComputerName%

BackupShare, ComputerBackupLocation, DoCapture, SLShare, UDDir, UDShare, UserDataLocation

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 Windows Deployment Wizard.

• ZTI are the credentials used by the Microsoft Systems Management Server (SMS) 2003 Advance Client network access account.

The permissions required on this share are as follows:

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

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

• Creator Owner. Allow for the Full Control permission

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.

[Settings]
Priority=Default
Properties=MyCustomProperty
[Default]
OSInstall=Y
ScanStateArgs=/v:5 /o /c
LoadStateArgs=/v:5 /c /lac
DoCapture=Y
BackupShare=\\NYC-AM-FIL-01\Backup$
BackupDir=%ComputerName%
DeployRoot=\\NYC-AM-FIL-01\Distribution$
ResourceRoot=\\NYC-AM-FIL-01\Resource$
UDShare=\\NYC-AM-FIL-01\MigData$
UDDir=%ComputerName%

BackupDir, ComputerBackupLocation, DoCapture, SLShare, UDDir, UDShare, UserDataLocation

BDEDriveLetter

The drive letter for the partition that is not encrypted by BitLocker™ Drive Encryption, also known as the system volume. The system volume is the volume that contains the hardware-specific files needed to load Windows computers after the basic input/output system (BIOS) has booted the platform.

drive_letter

The letter designation for the logical drive for the system volume (such as S or T). The default value is S.

[Settings]
Priority=Default
Properties=MyCustomProperty
[Default]
OSInstall=Y
ScanStateArgs=/v:5 /o /c
LoadStateArgs=/v:5 /c /lac
DoCapture=Y
BDEDriveLetter=S:
BDEDriveSize= 2000
BDEInstall=ProtectKeyWithTpmAndPin
BDEPin=123456789
BDERecoveryKey=TRUE
BDERecoveryPassword=TRUE
BDERequired=YES
BDEKeyLocation=\\NYC-AM-FIL-01\RecoveryKey\%ComputerName%
BackupShare=\\NYC-AM-FIL-01\Backup$
BackupDir=%ComputerName%
DeployRoot=\\NYC-AM-FIL-01\Distribution$
ResourceRoot=\\NYC-AM-FIL-01\Resource$
UDShare=\\NYC-AM-FIL-01\MigData$
UDDir=%ComputerName%

BDEDriveSize, BDEInstall, BDEKeyLocation, BDEPin, BDERecoveryKey, BDERecoveryPassword, BDERequired, TMPOwnerPassword

BDEDriveSize

The size of the partition that is encrypted by BitLocker Drive Encryption, also known as the operating system volume. The value is specified in megabytes (MB). In the example, the size of the BitLocker Drive Encryption partition to create is almost 2 gigabytes (GB) (2000 MB).

drive_size

The size of the partition in megabytes.

[Settings]
Priority=Default
Properties=MyCustomProperty
[Default]
OSInstall=Y
ScanStateArgs=/v:5 /o /c
LoadStateArgs=/v:5 /c /lac
DoCapture=Y
BDEDriveLetter=S:
BDEDriveSize= 2000
BDEInstall=ProtectKeyWithTpmAndPin
BDEPin=123456789
BDERecoveryKey=TRUE
BDERecoveryPassword=TRUE
BDERequired=YES
BDEKeyLocation=\\NYC-AM-FIL-01\RecoveryKey\%ComputerName%
BackupShare=\\NYC-AM-FIL-01\Backup$
BackupDir=%ComputerName%
DeployRoot=\\NYC-AM-FIL-01\Distribution$
ResourceRoot=\\NYC-AM-FIL-01\Resource$
UDShare=\\NYC-AM-FIL-01\MigData$
UDDir=%ComputerName%

BDEDriveLetter, BDEInstall, BDEKeyLocation, BDEPin, BDERecoveryKey, BDERecoveryPassword, BDERequired, TMPOwnerPassword

BDEInstall

The type of BitLocker Drive Encryption installation to be performed. You can protect the target computer by using one of the following methods:

• A Trusted Platform Module (TPM) microcontroller

• A TPM and a personal identification number (PIN)

• A TPM and a startup key (typically stored on a USB flash drive)

• An external key

ProtectKeyWithTpm

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.

ProtectKeyWithTpmAndStartupKey

Protect the computer with TPM and a startup key. Use this option to create a startup key and to save it on a USB flash drive. The startup key must be present in the port each time the computer restarts.

[Settings]
Priority=Default
Properties=MyCustomProperty
[Default]
OSInstall=Y
ScanStateArgs=/v:5 /o /c
LoadStateArgs=/v:5 /c /lac
DoCapture=Y
BDEDriveLetter=S:
BDEDriveSize= 2000
BDEInstall=ProtectKeyWithTpmAndPin
BDEPin=123456789
BDERecoveryKey=TRUE
BDERecoveryPassword=TRUE
BDERequired=YES
BDEKeyLocation=\\NYC-AM-FIL-01\RecoveryKey\%ComputerName%
BackupShare=\\NYC-AM-FIL-01\Backup$
BackupDir=%ComputerName%
DeployRoot=\\NYC-AM-FIL-01\Distribution$
ResourceRoot=\\NYC-AM-FIL-01\Resource$
UDShare=\\NYC-AM-FIL-01\MigData$
UDDir=%ComputerName%

BDEDriveLetter, BDEDriveSize, BDEKeyLocation, BDEPin, BDERecoveryKey, BDERecoveryPassword, BDERequired, TMPOwnerPassword

BDEKeyLocation

The location for storing the recovery key and startup key.

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

[Settings]
Priority=Default
Properties=MyCustomProperty
[Default]
OSInstall=Y
ScanStateArgs=/v:5 /o /c
LoadStateArgs=/v:5 /c /lac
DoCapture=Y
BDEDriveLetter=S:
BDEDriveSize= 2000
BDEInstall=ProtectKeyWithTpmAndPin
BDEPin=123456789
BDERecoveryKey=TRUE
BDERecoveryPassword=TRUE
BDERequired=YES
BDEKeyLocation=REMOVABLEDRIVE
BackupShare=\\NYC-AM-FIL-01\Backup$
BackupDir=%ComputerName%
DeployRoot=\\NYC-AM-FIL-01\Distribution$
ResourceRoot=\\NYC-AM-FIL-01\Resource$
UDShare=\\NYC-AM-FIL-01\MigData$
UDDir=%ComputerName%

BDEDriveLetter, BDEDriveSize, BDEInstall, BDEKeyLocation, BDEPin, BDERecoveryKey, BDERequired, TMPOwnerPassword

BDEPin

The PIN to be assigned to the target computer for use in BitLocker Drive Encryption when the BDEInstall property is set to ProtectKeyWithTpmAndPin.

PIN

The PIN to be used for BitLocker Drive Encryption. The PIN can be 4 to 20 digits long.

[Settings]
Priority=Default
Properties=MyCustomProperty
[Default]
OSInstall=Y
ScanStateArgs=/v:5 /o /c
LoadStateArgs=/v:5 /c /lac
DoCapture=Y
BDEDriveLetter=S:
BDEDriveSize= 2000
BDEInstall=ProtectKeyWithTpmAndPin
BDEPin=123456789
BDERecoveryKey=TRUE
BDERecoveryPassword=TRUE
BDERequired=YES
BDEKeyLocation=\\NYC-AM-FIL-01\RecoveryKey\%ComputerName%
BackupShare=\\NYC-AM-FIL-01\Backup$
BackupDir=%ComputerName%
DeployRoot=\\NYC-AM-FIL-01\Distribution$
ResourceRoot=\\NYC-AM-FIL-01\Resource$
UDShare=\\NYC-AM-FIL-01\MigData$
UDDir=%ComputerName%

BDEDriveLetter, BDEDriveSize, BDEInstall, BDERecoveryKey, BDERecoveryPassword, BDEKeyLocation, BDERequired, TMPOwnerPassword

BDERecoveryKey

A Boolean value that indicates whether the process creates a recovery key for BitLocker Drive Encryption. 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).

TRUE

A recovery key is created.

[Settings]
Priority=Default
Properties=MyCustomProperty
[Default]
OSInstall=Y
ScanStateArgs=/v:5 /o /c
LoadStateArgs=/v:5 /c /lac
DoCapture=Y
BDEDriveLetter=S:
BDEDriveSize= 2000
BDEInstall=ProtectKeyWithTpmAndPin
BDEPin=123456789
BDERecoveryKey=TRUE
BDERecoveryPassword=TRUE
BDERequired=YES
BDEKeyLocation=\\NYC-AM-FIL-01\RecoveryKey\%ComputerName%
BackupShare=\\NYC-AM-FIL-01\Backup$
BackupDir=%ComputerName%
DeployRoot=\\NYC-AM-FIL-01\Distribution$
ResourceRoot=\\NYC-AM-FIL-01\Resource$
UDShare=\\NYC-AM-FIL-01\MigData$
UDDir=%ComputerName%

BDEDriveLetter, BDEDriveSize, BDEInstall, BDEPin, BDERecoveryPassword, BDEKeyLocation, BDERequired, TMPOwnerPassword

BDERecoveryPassword

A Boolean value that indicates whether the process creates a recovery password for BitLocker Drive Encryption. The recovery password is a 48-digit, randomly generated number, created during BitLocker setup. It can be managed and copied after BitLocker Drive Encryption is enabled. Through the interface, the recovery password can be printed, saved to a file, or both for future use.

TRUE

A recovery password is created.

[Settings]
Priority=Default
Properties=MyCustomProperty
[Default]
OSInstall=Y
ScanStateArgs=/v:5 /o /c
LoadStateArgs=/v:5 /c /lac
DoCapture=Y
BDEDriveLetter=S:
BDEDriveSize= 2000
BDEInstall=ProtectKeyWithTpmAndPin
BDEPin=123456789
BDERecoveryKey=TRUE
BDERecoveryPassword=TRUE
BDERequired=YES
BDEKeyLocation=\\NYC-AM-FIL-01\RecoveryKey\%ComputerName%
BackupShare=\\NYC-AM-FIL-01\Backup$
BackupDir=%ComputerName%
DeployRoot=\\NYC-AM-FIL-01\Distribution$
ResourceRoot=\\NYC-AM-FIL-01\Resource$
UDShare=\\NYC-AM-FIL-01\MigData$
UDDir=%ComputerName%

BDEDriveLetter, BDEDriveSize, BDEInstall, BDEPin, BDERecoveryKey, BDEKeyLocation, BDERequired, TMPOwnerPassword

BDERequired

Indicates whether BitLocker Drive Encryption is required on the target computer. Use this property to terminate the BDD 2007 deployment process if the BitLocker Drive Encryption installation process fails and the security requirements of the target computer mandate the use of BitLocker Drive Encryption protection.

YES

Requires BitLocker Drive Encryption and terminates the BDD 2007 deployment process if the BitLocker Drive Encryption installation process fails on the target computer.

[Settings]
Priority=Default
Properties=MyCustomProperty
[Default]
OSInstall=Y
ScanStateArgs=/v:5 /o /c
LoadStateArgs=/v:5 /c /lac
DoCapture=Y
BDEDriveLetter=S:
BDEDriveSize= 2000
BDEInstall=ProtectKeyWithTpmAndPin
BDEPin=123456789
BDERecoveryKey=TRUE
BDERecoveryPassword=TRUE
BDERequired=YES
BDEKeyLocation=\\NYC-AM-FIL-01\RecoveryKey\%ComputerName%
BackupShare=\\NYC-AM-FIL-01\Backup$
BackupDir=%ComputerName%
DeployRoot=\\NYC-AM-FIL-01\Distribution$
ResourceRoot=\\NYC-AM-FIL-01\Resource$
UDShare=\\NYC-AM-FIL-01\MigData$
UDDir=%ComputerName%

BDEDriveLetter, BDEDriveSize, BDEInstall, BDEPin, BDERecoveryKey, BDERecoveryPassword, BDEKeyLocation, TMPOwnerPassword

BitsPerPel

Setting for display 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 gets inserted into the appropriate configuration settings in unattend.txt or sysprep.inf for Windows XP or unattend.xml for Windows Vista.

Note   The default values (in the template unattend.txt, sysprep.inf, and unattend.xml files) are 1,024 pixels horizontal resolution, 768 pixels vertical resolution, 32-bit color depth, and 60 Hertz vertical refresh rate.

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.

[Settings]
Priority=Computers, Default
Properties=MyCustomProperty
[Default]
OSInstall=Y
ScanStateArgs=/v:5 /o /c
LoadStateArgs=/v:5 /c /lac 
BitsPerPel=32
VRefresh=60
XResolution=1024
YResolution=768

VRefresh, XResolution, YResolution

BuildID

The identifier for the operating system build to be deployed to the target computer. The Build ID is created in Deployment Workbench in the Builds node in the console tree. The BuildID property allows alphanumeric characters, hyphens (-), and underscores (_). The BuildID property cannot be blank or contain spaces.

build_id

Identifier of the operating system build as defined in Deployment Workbench for the target operating system being deployed.

Note   Make certain to use the BuildID specified in Deployment Workbench user interface (UI), not the GUID of the BuildID.

[Settings]
Priority=Default
Properties=MyCustomProperty
[Default]
OSInstall=Y
ScanStateArgs=/v:5 /o /c
LoadStateArgs=/v:5 /c /lac 
BuildID=Build_20

N/A

CapableArchitecture

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

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

X86

Processor architecture is 32-bit.

Note   This property is dynamically set by the BDD 2007 scripts and is not configured in CustomSettings.ini. Treat this property as read only.

Architecture, HALName, Make, Memory, Model, ProcessorSpeed, UUID

CaptureGroups

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

NO

Captures no group membership information.

YES

Captures the membership of the Administrators 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 (typically set to YES).

[Settings]
Priority=Default
Properties=MyCustomProperty
[Default]
OSInstall=Y
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$
CaptureGroups=YES
Groups1=NYC Application Management
Groups2=NYC Help Desk Users

Groups

ComputerName

The name to be assigned to the target computer during the deployment of the target operating system.

computer_name

The name to be assigned to the target computer.

Note   In the refresh computer scenario, ZTI can rename the computer by including the line:

“ComputerName=%OSDNEWMACHINENAME%

in the [Default] section.

[Settings]
Priority=Default
Properties=MyCustomProperty
[Default]
OSInstall=Y
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=%ComputerName%
SLShare=\\NYC-AM-FIL-01\Logs$
UDProfiles=Administrator, User-01, ExtranetUser
UserDataLocation=NONE
OSDINSTALLSILENT=1
OSDINSTALLPACKAGE=NYC00002
OSDINSTALLPROGRAM=SpecialVista
ComputerName=%OSDNEWMACHINENAME%

OSDNewMachineName

ComputerBackupLocation

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

blank

For LTI, the location for storing the backup is selected in the Windows Deployment Wizard. For ZTI, this is the same as setting the property to NONE.

AUTO

Setting to create backup on a local hard disk if space is available. Otherwise, the backup is saved on a network location specified in the BackupShare and BackupDir properties.

NONE

No backup is to be performed.

[Settings]
Priority=Default
Properties=MyCustomProperty
[Default]
OSInstall=Y
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$
ComputerBackupLocation=NETWORK
BackupShare = \\NYC-AM-FIL-01\Backup$
BackupDir = %ComputerName%
UDDir=%ComputerName%
SLShare=\\NYC-AM-FIL-01\Logs$
UDProfiles=Administrator, User-01, ExtranetUser
UserDataLocation=NONE
OSDINSTALLSILENT=1
OSDINSTALLPACKAGE=NYC00002
OSDINSTALLPROGRAM=SpecialVista
ComputerName=%OSDNEWMACHINENAME%

BackupShare, BackupDir

CountryCode

The country code to be configured for the operating system on the target computer. This property allows only numeric characters. This value gets inserted into the appropriate configuration settings in unattend.txt or sysprep.inf for Windows XP or unattend.xml for Windows Vista.

country_code

The country code where the target computer is to be deployed.

[Settings]
Priority=Default
Properties=MyCustomProperty
[Default]
OSInstall=Y
ScanStateArgs=/v:5 /o /c
LoadStateArgs=/v:5 /c /lac
DoCapture=Y
AreaCode=206
CountryCode=001
Dialing=TONE
LongDistanceAccess=9
BackupShare=\\NYC-AM-FIL-01\Backup$
BackupDir=%ComputerName%
DeployRoot=\\NYC-AM-FIL-01\Distribution$
ResourceRoot=\\NYC-AM-FIL-01\Resource$
UDShare=\\NYC-AM-FIL-01\MigData$
UDDir=%ComputerName%

AreaCode, Dialing, LongDistanceAccess

Database

The Database property 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.

database

The name of the database to be used for querying property values.

[Settings]
Priority=Computers, Default
Properties=MyCustomProperty
[Default]
OSInstall=Y
ScanStateArgs=/v:5 /o /c
LoadStateArgs=/v:5 /c /lac
[Computers]
SQLServer=NYC-SQL-01
SQLShare=SQL$
Database=DWDB
Instance=SQLEnterprise2005
Table=Computers
Parameters=SerialNumber, AssetTag
ParameterCondition=OR

Database, DBID, DBPwd, Instance, NetLib, Order, Parameters, ParameterCondition, SQLServer, SQLShare, Table

DBID

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

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

user_id

The name of the user account credentials used to access the computer running SQL Server by using SQL Server authentication.

[Settings]
Priority=Computers, Default
Properties=MyCustomProperty
[Default]
OSInstall=Y
ScanStateArgs=/v:5 /o /c
LoadStateArgs=/v:5 /c /lac
[Computers]
SQLServer=NYC-SQL-01
DBID=SQL_User-01
DBPwd=P@ssw0rd
NetLib=DBNMPNTW
Database=DWDB
Instance=SQLEnterprise2005
Table=Computers
Parameters=SerialNumber, AssetTag
ParameterCondition=OR

Database, DBPwd, Instance, NetLib, Order, Parameters, ParameterCondition, SQLServer, SQLShare, Table

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   Using SQL Server authentication is not as secure as Windows Integrated authentication. Windows Integrated authentication is the recommended authentication method. Using the DBID and DBPwd properties stores the credentials in clear text in the CustomSettings.ini file. For more information about using Windows Integrated authentication, see the SQLShare property.

user_password

The password for the user account credentials specified in the DBID property for authenticating by using SQL Server authentication.

[Settings]
Priority=Computers, Default
Properties=MyCustomProperty
[Default]
OSInstall=Y
ScanStateArgs=/v:5 /o /c
LoadStateArgs=/v:5 /c /lac
[Computers]
SQLServer=NYC-SQL-01
DBID=SQL_User-01
DBPwd=P@ssw0rd
NetLib=DBNMPNTW
Database=DWDB
Instance=SQLEnterprise2005
Table=Computers
Parameters=SerialNumber, AssetTag
ParameterCondition=OR

Database, DBPwd, Instance, NetLib, Order, Parameters, ParameterCondition, SQLServer, SQLShare, Table

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.

default_gateway

The IP address of the default gateway in standard dotted-decimal notation.

Note   This property is dynamically set by the BDD 2007 scripts and is not configured in CustomSettings.ini. Treat this property as read only.

IPAddress, MACAddress

DeployDrive

The value used by the scripts to access files and run programs in the Deployment Point share created by Deployment Workbench. 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.

drive_letter

The letter designation for the logical drive where the target operating system is to be installed (such as C or D).

Note   This property is dynamically set by the BDD 2007 scripts and is not configured in CustomSettings.ini. Treat this property as read only.

DeployRoot, ResourceDrive, ResourceRoot

DeploymentMethod

The method being used for the deployment (NETWORK, MEDIA, or OSD).

NETWORK

The deployment occurs to the target computers over the network.

OSD

The deployment occurs through Microsoft SMS Operating System Deployment (OSD) Feature Pack from OSD distribution points. This is the method used by ZTI.

Note   This property is dynamically set by the BDD 2007 scripts and is not configured in CustomSettings.ini. Treat this property as read only.

DeploymentType

DeploymentType

The type of deployment being performed based on the deployment scenario. For ZTI, this property is set dynamically by the BDD 2007 scripts and is not configured in CustomSettings.ini.

For LTI, you have the option of bypassing the wizard page that allows the selection of the deployment type in the Windows Deployment Wizard. When you skip the wizard page (by using the SkipDeploymentType property), you must set this value in CustomSettings.ini to identify the type of deployment you want to perform.

For more information, see the SkipDeploymentType property.

Note   The example illustrates the use of the DeploymentType property in conjunction with the SkipDeploymentType property to skip the wizard page in the Windows Deployment Wizard. All values must be specified in upper case to function properly.

NEWCOMPUTER

The target computer is a new computer that has never been a member of the network.

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.

[Settings]
Priority=Default
Properties=MyCustomProperty
[Default]
OSInstall=Y
ScanStateArgs=/v:5 /o /c
LoadStateArgs=/v:5 /c /lac
DeployRoot=\\NYC-AM-FIL-01\Distribution$
ResourceRoot=\\NYC-AM-FIL-01\Resource$
DeploymentType=UPGRADE
UserDataLocation=NONE
SkipAppsOnUpgrade=NO
SkipCapture=NO
SkipDeploymentType=YES
SkipAdminPassword=YES
SkipProductKey=YES

DeploymentMethod

DeployRoot

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

Note   For this property to function properly it must be configured in both the CustomSettings.ini and BootStrap.ini files. This is because BootStrap.ini is processed before a deployment point (containing CustomSettings.ini) has been selected.

UNC_path

The UNC path to the Deployment Point share. The default share name is Distribution$.

[Settings]
Priority=Default
Properties=MyCustomProperty
[Default]
OSInstall=Y
ScanStateArgs=/v:5 /o /c
LoadStateArgs=/v:5 /c /lac
DeployRoot=\\NYC-AM-FIL-01\Distribution$
ResourceRoot=\\NYC-AM-FIL-01\Resource$
UserDataLocation=NONE
SkipAppsOnUpgrade=NO
SkipCapture=NO
SkipAdminPassword=YES
SkipProductKey=YES

ResourceRoot

DeploySystemDrive

The logical drive volume where the target operating system is to be installed.

drive_letter

The letter designation for the logical drive where the target operating system is to be installed (such as C or D).

Note   This property is dynamically set by the BDD 2007 scripts and is not configured in CustomSettings.ini. Treat this property as read only.

DeployRoot, ResourceRoot

Dialing

The type of dialing supported by the telephony infrastructure where the target computer is located. This value gets inserted into the appropriate configuration settings in unattend.txt or sysprep.inf for Windows XP or unattend.xml for Windows Vista.

PULSE

The telephony infrastructure supports pulse dialing.

[Settings]
Priority=Default
Properties=MyCustomProperty
[Default]
OSInstall=Y
ScanStateArgs=/v:5 /o /c
LoadStateArgs=/v:5 /c /lac
DoCapture=Y
AreaCode=206
CountryCode=001
Dialing=TONE
LongDistanceAccess=9
BackupShare=\\NYC-AM-FIL-01\Backup$
BackupDir=%ComputerName%
DeployRoot=\\NYC-AM-FIL-01\Distribution$
ResourceRoot=\\NYC-AM-FIL-01\Resource$
UDShare=\\NYC-AM-FIL-01\MigData$
UDDir=%ComputerName%

AreaCode, CountryCode, LongDistanceAccess, DeployRoot, ResourceRoot

DoCapture

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

YES

Run Sysprep on the target computer and capture a WIM image.

PREPARE

Copies the necessary files to run Sysprep on the target computer but does not run Sysprep or other image capture processes. This value is used when you are using the SMS OSD Feature Pack to capture an image of the target computer.

[Settings]
Priority=Default
Properties=MyCustomProperty
[Default]
OSInstall=Y
ScanStateArgs=/v:5 /o /c
LoadStateArgs=/v:5 /c /lac
DoCapture=YES
BackupShare=\\NYC-AM-FIL-01\Backup$
BackupDir=%ComputerName%
UserDataLocation=NETWORK
DeployRoot=\\NYC-AM-FIL-01\Distribution$
ResourceRoot=\\NYC-AM-FIL-01\Resource$
UDShare=\\NYC-AM-FIL-01\MigData$
>UDDir=%ComputerName%

Also see

DomainAdmin

The user name of a user account that is a member of the Domain Admins group in an Active Directory domain (specified in the DomainAdminDomain property). The account is used to join the computer to a domain.

Note   For ZTI, the credentials the SMS OSD Feature Pack specifies are normally used. If the DomainAdmin property is specified, the credentials in the DomainAdmin property override the credentials that the SMS OSD Feature Pack specifies.

user_id

The name of the user account credentials used to join the computer to a domain.

[Settings]
Priority=Default
Properties=MyCustomProperty
[Default]
OSInstall=Y
ScanStateArgs=/v:5 /o /c
LoadStateArgs=/v:5 /c /lac
DomainAdmin=NYCAdmin
DomainAdminDomain=WOODGROVEBANK
DomainAdminPassword=P@ssw0rd
Packages1=NYC00010-Install
Packages2=NYC00011-Install
Administrators1=WOODGROVEBANK\NYC Help Desk Staff    
PowerUsers1=WOODGROVEBANK\User01
PowerUsers2=WOODGROVEBANK\User02

DomainAdminDomain, DomainPassword

DomainAdminDomain    

The domain in which a user’s credentials (specified in DomainAdmin) exist.

Note   For ZTI, the credentials that the SMS OSD Feature Pack specifies are normally used. If the DomainAdmin property is specified, the credentials in the DomainAdmin property override the credentials that the SMS OSD Feature Pack specifies.

domain

The name of the domain where the user account credentials exist.

[Settings]
Priority=Default
Properties=MyCustomProperty
[Default]
OSInstall=Y
ScanStateArgs=/v:5 /o /c
LoadStateArgs=/v:5 /c /lac
DomainAdmin=NYCAdmin
DomainAdminDomain=WOODGROVEBANK
DomainAdminPassword=P@ssw0rd
Packages1=NYC00010-Install
Packages2=NYC00011-Install
Administrators1=WOODGROVEBANK\NYC Help Desk Staff    
PowerUsers1=WOODGROVEBANK\User01
PowerUsers2=WOODGROVEBANK\User02

DomainAdmin, DomainAdminPassword

DomainAdminPassword

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 the SMS OSD Feature Pack specifies are normally used. If the DomainAdmin property is specified, the credentials in the DomainAdmin property override the credentials that the SMS OSD Feature Pack specifies.

domain_admin_password

The password for the domain administrator account on the target computer.

[Settings]
Priority=Default
Properties=MyCustomProperty
[Default]
OSInstall=Y
ScanStateArgs=/v:5 /o /c
LoadStateArgs=/v:5 /c /lac
DomainAdmin=NYCAdmin
DomainAdminDomain=WOODGROVEBANK
DomainAdminPassword=P@ssw0rd
Packages1=NYC00010-Install
Packages2=NYC00011-Install
Administrators1=WOODGROVEBANK\NYC Help Desk Staff    
PowerUsers1=WOODGROVEBANK\User01
PowerUsers1=WOODGROVEBANK\User02

DomainAdmin, DomainAdminDomain

DomainOUs

A list of Active Directory organizational units (OUs) where the target computer account can be created. The DomainOUs property lists text values that can be any nonblank value. The DomainOUs property has a numeric suffix (for example, DomainOUs1 or DomainOUs2).

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

<?xml version="1.0" encoding="utf-8"?>
<DomainOUs>
  <DomainOU>OU=\WOODGROVEBANK\NYC\Tellers\Computers </DomainOU>
  <DomainOU>OU=\WOODGROVEBANK\NYC\Managers\Computers </DomainOU>
</DomainOUs> 

OU1
OU2
OU3

The OU where the target computer account can be created.

[Settings]
Priority=Default
Properties=MyCustomProperty
[Default]
OSInstall=Y
ScanStateArgs=/v:5 /o /c
LoadStateArgs=/v:5 /c /lac
DriversPaths=\\NYC-AM-FIL-01\Drivers$, \\NYC-AM-FIL-03\VistaDrvs
Packages1=NYC00010-Install
Packages2=NYC00011-Install
DomainOUs1=\WOODGROVEBANK\NYC\Tellers\Computers
DomainOUs2=\WOODGROVEBANK\NYC\Managers\Computers
Administrators1=WOODGROVEBANK\NYC Help Desk Staff
PowerUsers1=WOODGROVEBANK\User01
PowerUsers2=WOODGROVEBANK\User02

N/A

DriverGroup

A list of text values that associates out-of-box drivers created in 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 nonblank value. The DriverGroup property value has a numeric suffix (for example, DriverGroup1 or DriverGroup2). Once defined, a driver group is associated with a computer. A computer may be associated with more than one driver group.

In the 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.

driver_group1 driver_group2

The name of the driver group as defined in Deployment Workbench.

[Settings]
Priority=Make, Default
Properties=MyCustomProperty
[Default]
OSInstall=Y
ScanStateArgs=/v:5 /o /c
LoadStateArgs=/v:5 /c /lac
DriverGroup1=Shared Drivers
Packages1=NYC00010-Install
Packages2=NYC00011-Install
Administrators1=WOODGROVEBANK\NYC Help Desk Staff
PowerUsers1=WOODGROVEBANK\User01
PowerUsers2=WOODGROVEBANK\User02
[Mfgr01]
DriverGroup1=Mfgr01 Video Drivers
DriverGroup2=Mfgr01 Network Drivers
[Mfgr02]
DriverGroup1=Mfgr02 Drivers

DriverPaths, Make

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 BDD 2007 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, DriverPaths1 or DriverPaths2).

UNC_path1
UNC_path2

UNC path to the shared folder where the additional drivers are located.

[Settings]
Priority=Default
Properties=MyCustomProperty
[Default]
OSInstall=Y
ScanStateArgs=/v:5 /o /c
LoadStateArgs=/v:5 /c /lac
DriverPaths1=\\NYC-AM-FIL-01\Drivers$
DriverPaths2=\\NYC-AM-FIL-03\VistaDrvs
Packages1=NYC00010-Install
Packages2=NYC00011-Install
Administrators1=WOODGROVEBANK\NYC Help Desk Staff
PowerUsers1=WOODGROVEBANK\User01
PowerUsers2=WOODGROVEBANK\User02

DriverGroup

EventShare

The UNC path to the event collection servers for the ZTI Management Pack for Microsoft Operations Manager (MOM) 2005. The EventShare property points to a shared folder in which the BDD 2007 scripts record events.

By default, the shared folder is created at C:\Events. If the folder is created in any location other than C:\Events, modify the Generate ZTI Events and Discovery Data Management Pack rule to reference the location of the folder created.

UNC_path

The UNC path to the shared folder where the Management Pack stores event information. The default share name is Events.

[Settings]
Priority=Default
Properties=MyCustomProperty
[Default]
OSInstall=Y
ScanStateArgs=/v:5 /o /c
LoadStateArgs=/v:5 /c /lac
EventShare=\\NYC-AM-FIL-01\Events
DeployRoot=\\NYC-AM-FIL-01\Distribution$
ResourceRoot=\\NYC-AM-FIL-01\Resource$
UserDataLocation=NONE
SkipAppsOnUpgrade=NO
SkipCapture=NO
SkipAdminPassword=YES
SkipProductKey=YES

N/A

FullName

The full name of the user for the target computer provided during the installation of the operating system. This value gets inserted into the appropriate configuration settings in unattend.txt or sysprep.inf for Windows XP or unattend.xml for Windows Vista.

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

full_name

The full name of the user for the target computer.

[Settings]
Priority=MACAddress, Default
Properties=CustomProperty, ApplicationInstall
[Default]
OSInstall=Y
ScanStateArgs=/v:5 /o /c
LoadStateArgs=/v:5 /c /lac
UserDataLocation=NONE
CustomProperty=TRUE
OSDINSTALLSILENT=1
OrgName=Woodgrove Bank
[00:0F:20:35:DE:AC]
OSDNEWMACHINENAME=HPD530-1
OSDINSTALLPACKAGE=DAL00342
OSDINSTALLPROGRAM=CustomVista
ApplicationInstall=Custom
FullName=Woodgrove Bank User
[00:03:FF:FE:FF:FF]
OSDNEWMACHINENAME=BVMXP
OSDINSTALLPACKAGE=NYC00002
OSDINSTALLPROGRAM=SpecialVista 
ApplicationInstall=Minimum
FullName=Woodgrove Bank Manager

OrgName

Groups

The list of local groups on the target computer whose membership you want to capture. This group membership is captured during the State Capture Phase and is restored during the State Restore Phase.

group

The name of the local group on the target computer for which you want to capture group membership.

[Settings]
Priority=Default
Properties=MyCustomProperty
[Default]
OSInstall=Y
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$
CaptureGroups=YES
Groups1=NYC Application Management
Groups2=NYC Help Desk Users

CaptureGroups

HALName

The descriptive name of the hardware abstraction layer (HAL) currently running on the target computer.

Note   This property is only required for Windows XP deployment.

hal_name

The name of the HAL running on the target computer.

Note   This property is dynamically set by the BDD 2007 scripts and is not configured in CustomSettings.ini. Treat this property as read only.

Architecture, CapableArchitecture

Home_Page

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

URL

The URL of the Web page to be used as the home page for Internet Explorer on the target computer.

[Settings]
Priority=Default
Properties=MyCustomProperty
[Default]
OSInstall=Y
ScanStateArgs=/v:5 /o /c
LoadStateArgs=/v:5 /c /lac
Home_Page=https://portal.woodgrovebank.com
DeployRoot=\\NYC-AM-FIL-01\Distribution$
ResourceRoot=\\NYC-AM-FIL-01\Resource$
UDShare=\\NYC-AM-FIL-01\MigData$
UDDir=%ComputerName%
SLShare=\\NYC-AM-FIL-01\Logs$
UDProfiles=Administrator, User-01, ExtranetUser
UserDataLocation=NONE
OSDINSTALLSILENT=1
OSDINSTALLPACKAGE=NYC00002
OSDINSTALLPROGRAM=SpecialVista
ComputerName=%OSDNEWMACHINENAME%

N/A

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 may be shorter than the computer name

host_name

The IP host name assigned to the target computer.

Note   This property is dynamically set by the BDD 2007 scripts and is not configured in CustomSettings.ini. Treat this property as read only.

ComputerName

InputLocale

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

Ensure that you exclude this setting in the Microsoft Windows User State Migration Tool (USMT) when you are backing up and restoring user state information. Otherwise, the settings in the user state information will override the values specified in the > InputLocale property.

Note This property is used only for deploying Windows XP.

keyboard_locale1;keyboard_locale2

The locale for the keyboard attached to the target computer.

[Settings]
Priority=Default
Properties=MyCustomProperty
[Default]
OSInstall=Y
ScanStateArgs=/v:5 /o /c
LoadStateArgs=/v:5 /c /lac 
UserLocale=0409:00000409
InputLocale= 0409:00000409;0413:00020409;0413:00000409;0409:00020409

BuildID, KeyboardLocale, LanguagePacks, UserLocale

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.

instance

The name of the instance of SQL Server to be used for querying property values.

[Settings]
Priority=Computers, Default
Properties=MyCustomProperty
[Default]
OSInstall=Y
ScanStateArgs=/v:5 /o /c
LoadStateArgs=/v:5 /c /lac
[Computers]
SQLServer=NYC-SQL-01
Database=DWDB
Instance=SQLEnterprise2005
Table=Computers
Parameters=SerialNumber, AssetTag
ParameterCondition=OR

Database, DBID, DBPwd, NetLib, Order, Parameters, ParameterCondition, SQLServer, SQLShare, Table

IPAddress

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.

IP_address

The IP address of the target computer in standard dotted-decimal notation.

Note   This property is dynamically set by the BDD 2007 scripts and is not configured in CustomSettings.ini. Treat this property as read only.

DefaultGateway, MACAddress, SerialNumber, Make, Model

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 following properties will be true at a time: IsDesktop, IsLaptop, IsServer.

TRUE

The target computer is a desktop computer.

Note   This property is dynamically set by the BDD 2007 scripts and is not configured in CustomSettings.ini. Treat this property as read only.

IsLaptop, IsServer, IsServerOS

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 following properties will be true at a time: IsDesktop, IsLaptop, IsServer.

TRUE

The target computer is a portable computer.

Note   This property is dynamically set by the BDD 2007 scripts and is not configured in CustomSettings.ini. Treat this property as read only.

IsDesktop, IsServer, IsServerOS

IsServer

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

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

TRUE

The target computer is a server.

Note   This property is dynamically set by the BDD 2007 scripts and is not configured in CustomSettings.ini. Treat this property as read only.

IsDesktop, IsLapotp, IsServerOS

IsServerOS

Indicator of whether the current operating system running on the target computer is a server operating system (such as Microsoft Windows Server® 2003).

TRUE

The operating system on the target computer is a server operating system.

Note   This property is dynamically set by the BDD 2007 scripts and is not configured in CustomSettings.ini. Treat this property as read only.

IsDesktop, IsLaptop, IsServerOS

Name

LTI

ZTI

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 underlines (_). The JoinDomain property cannot be blank or contain spaces.

domain_name

The name of the domain that the target computer joins.

[Settings]
Priority=Default
Properties=MyCustomProperty
[Default]
OSInstall=Y
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=%ComputerName%
SLShare=\\NYC-AM-FIL-01\Logs$
UDProfiles=Administrator, User-01, ExtranetUser
UserDataLocation=NONE
OSDINSTALLSILENT=1
OSDINSTALLPACKAGE=NYC00002
OSDINSTALLPROGRAM=SpecialVista
JoinDomain=WOODGROVEBANK
MachineObjectOU=NewYork
ComputerName=%OSDNEWMACHINENAME%

MachineObjectOU, UserDomain

JoinWorkgroup

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

workgroup_name

The name of the workgroup that the target computer joins.

[Settings]
Priority=Default
Properties=MyCustomProperty
[Default]
OSInstall=Y
ScanStateArgs=/v:5 /o /c
LoadStateArgs=/v:5 /c /lac 
Workgroup=WDGV_WORKGROUP

JoinDomain

KeyboardLocale

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

Ensure that you exclude this setting in USMT when you are 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 This property is only used for deploying Windows Vista. For this property to function properly it must be configured in both the CustomSettings.ini and BootStrap.ini files. This is because BootStrap.ini is processed before a deployment point (containing CustomSettings.ini) has been selected.

keyboard_locale1;keyboard_locale2

The locale for the keyboard attached to the target computer.

Note The value can be specified by using either format in Example 1 or Example 2.

[Settings]
Priority=Default
Properties=MyCustomProperty
[Default]
OSInstall=Y
ScanStateArgs=/v:5 /o /c
LoadStateArgs=/v:5 /c /lac 
UserLocale=en-us
KeyboardLocale=en-us

[Settings]
Priority=Default
Properties=MyCustomProperty
[Default]
OSInstall=Y
ScanStateArgs=/v:5 /o /c
LoadStateArgs=/v:5 /c /lac 
UserLocale=en-us
KeyboardLocale= 0409:00004009; 1809:00001809; 041A:0000041A; 083b:0001083b

BuildID, InputLocale, LanguagePacks, UserLocale

LanguagePacks

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

language_pack_guid

The GUID that 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.

[Settings]
Priority=Default
Properties=MyCustomProperty
[Default]
OSInstall=Y
ScanStateArgs=/v:5 /o /c
LoadStateArgs=/v:5 /c /lac
LanguagePacks1={a1923f8d-b07b-44c7-ac1e-353b7cc4c1ad}

SkipPackageDisplay

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 nonzero return code), the local state store is moved to %WINDIR%\StateStore to prevent deletion and to ensure that no user state information is lost.

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. You can 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 on these and other arguments, see the USMT Help files.

[Settings]
Priority=Default
Properties=MyCustomProperty
[Default]
OSInstall=Y
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=%ComputerName%

ScanStateArgs, USMTMigFiles

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 through Deployment Workbench. Deployment Workbench can assist in creating the locations, defining property settings associated with the locations, and then configuring CustomSettings.ini to perform the database query for the Location property and the property settings associated with the locations.

In the example, the LocationSettings section queries the LocationSettings view in the database for a list of locations containing 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. In the example, NYC and the NYC-6311 Lexington-4th Floor sections represent the locations. This is an example of how one computer can belong to two locations. The NYC section is for all computers in a larger geographic area (an entire city), while the NYC-6311 Lexington-4th Floor section is for all computers on the fourth floor at 6311 Lexington Ave., in New York City.

location1 ,
location2

The list of locations to be assigned to an individual computer or a group of computers.

[Settings]
Priority= LocationSettings, Location, Default
Properties=MyCustomProperty
[Default]
SkipCapture=NO
SkipAppsOnUpgrade=NO
UserDataLocation=AUTO
DeployRoot=\\W2K3-SP1\Distribution11$
OSInstall=Y
ScanStateArgs=/v:15 /o /c
LoadStateArgs=/v:7 /c
[LocationSettings]
SQLServer=w2k3-sp1
Instance=SQL2005Enterprise
Database=DWDB
Netlib=DBNMPNTW
SQLShare=SQL$
Table=LocationSettings
Parameters=DefaultGateway
[NYC]
UDDir=%ComputerName%
UDShare=\\NYC-FIL-01\UserData
[NYC-6311 Lexington-4th Floor]
DeployRoot=\\NYC-BDD-01\Distribution1$

N/A

LongDistanceAccess

The dialing digits to gain access to an outside line to dial long distance. The property can contain only numeric digits. This value gets inserted into the appropriate configuration settings in unattend.txt or sysprep.inf for Windows XP or unattend.xml for Windows Vista.

long_distance_access

The digits used to get an outside line to dial long distance where the target computer is to be deployed.

[Settings]
Priority=Default
Properties=MyCustomProperty
[Default]
OSInstall=Y
ScanStateArgs=/v:5 /o /c
LoadStateArgs=/v:5 /c /lac
DoCapture=Y
AreaCode=206
CountryCode=001
Dialing=TONE
LongDistanceAccess=9
BackupShare=\\NYC-AM-FIL-01\Backup$
BackupDir=%ComputerName%
DeployRoot=\\NYC-AM-FIL-01\Distribution$
ResourceRoot=\\NYC-AM-FIL-01\Resource$
UDShare=\\NYC-AM-FIL-01\MigData$
UDDir=%ComputerName%

AreaCode, CountryCode, Dialing

MACAddress

The media access control (MAC) layer address of the primary network adapter of the target computer. Typically the MACAddress property is included on the Priority line so that you can provide property values specific to a target computer.

macaddress

The MAC address of the target computer.

The example illustrates the sections for the target computers ([00:0F:20:35:DE:AC] and [00:03:FF:FE:FF:FF]) that contain workstation-specific settings. These sections are scanned because the MACAddress property is specified on the Priority line.

[Settings]
Priority=MACAddress, Default
Properties=MyCustomProperty
[Default]
OSInstall=Y
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$
CaptureGroups=YES
Groups1=NYC Application Management
Groups2=NYC Help Desk Users
[00:0F:20:35:DE:AC]
OSDNEWMACHINENAME=HPD530-1
OSDINSTALLPACKAGE=DAL00342
OSDINSTALLPROGRAM=CustomVista
[00:03:FF:FE:FF:FF]
OSDNEWMACHINENAME=BVMXP
OSDINSTALLPACKAGE=NYC00002
OSDINSTALLPROGRAM=SpecialVista

DefaultGateway, IPAddress, Make, Model, Product, SerialNumber, UUID

MachineObjectOU

The Active Directory OU in the target domain where the computer account for the target computer is created.

OU_name

The name of the OU 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.

[Settings]
Priority=Default
Properties=MyCustomProperty
[Default]
OSInstall=Y
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=%ComputerName%
SLShare=\\NYC-AM-FIL-01\Logs$
UDProfiles=Administrator, User-01, ExtranetUser
UserDataLocation=NONE
OSDINSTALLSILENT=1
OSDINSTALLPACKAGE=NYC00002
OSDINSTALLPROGRAM=SpecialVista
JoinDomain=WOODGROVEBANK
MachineObjectOU=NewYork
ComputerName=%OSDNEWMACHINENAME%

JoinDomain, UserDomain

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

make

The manufacturer of the target computer.

Note   This property is dynamically set by the BDD 2007 scripts and is not configured in CustomSettings.ini. Treat this property as read only.

Architecture, CapableArchitecture, HALName, Model, Product

Memory

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

memory

The amount of memory installed on the target computer in megabytes.

Note   This property is dynamically set by the BDD 2007 scripts and is not configured in CustomSettings.ini. Treat this property as read only.

Architecture, CapableArchitecture, HALName, Make, Model, ProcessorSpeed, Product, UUID

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

model

The model of the target computer.

Note   This property is dynamically set by the BDD 2007 scripts and is not configured in CustomSettings.ini. Treat this property as read only.

Architecture, CapableArchitecture, HALName, Make, Product

NetLib

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

DBNMPNTW

Use named pipes protocol to communicate.

[Settings]
Priority=Computers, Default
Properties=MyCustomProperty
[Default]
OSInstall=Y
ScanStateArgs=/v:5 /o /c
LoadStateArgs=/v:5 /c /lac
[Computers]
SQLServer=NYC-SQL-01
SQLShare=SQL$
NetLib=DBNMPNTW
Database=DWDB
Instance=SQLEnterprise2005
Table=Computers
Parameters=SerialNumber, AssetTag
ParameterCondition=OR

Database, DBID, DBPwd, Instance, Order, Parameters, ParameterCondition, SQLServer, SQLShare, Table

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. You can provide more than one property 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. In the example below, Order=Make, Model adds an ORDER BY Make, Model clause to the query.

property1, property2, ...

Properties to define the sort order for the result set (where propertyn represents the properties in the sort criteria).

[Settings]
Priority=Computers, Default
Properties=MyCustomProperty
[Default]
OSInstall=Y
ScanStateArgs=/v:5 /o /c
LoadStateArgs=/v:5 /c /lac
[Computers]
SQLServer=NYC-SQL-01
SQLShare=SQL$
NetLib=DBNMPNTW
Database=DWDB
Instance=SQLEnterprise2005
Table=MakeModelSettings
Parameters=SerialNumber, AssetTag
ParameterCondition=OR
Order=Make, Model

Database, DBID, DBPwd, Instance, NetLib, Parameters, ParameterCondition, SQLServer, SQLShare, Table

OrgName

The name of the organization that owns the target computer. This value gets inserted into the appropriate configuration settings in unattend.txt or sysprep.inf for Windows XP or unattend.xml for Windows Vista.

org_name