Reviewing the Deployment Processing Rules

Article
03/05/2008

Before you can identify the deployment processing rules that you want to include, you need to identify the deployment components that are used in BDD 2007 for ZTI and LTI. Figure 2 illustrates the steps in reviewing the deployment processing rules.

Figure 2. Steps in reviewing the deployment processing rules

Identifying the BDD 2007 Deployment Components

The ZTI and LTI deployment processes use a common set of deployment components included in BDD 2007. To configure the deployment process properly, you need to identify how these components interact in the ZTI and LTI deployment processes.

The BDD 2007 deployment components include:

Scripts
Configuration files
Configuration database
Environment variables
Log files

For a pictorial description of how these components work together in the BDD 2007 deployment process for ZTI and LTI, see “Deployment Process Flowcharts” in Configuration Reference.

Scripts

The scripts provide the automation of the deployment process. The scripts scan the configuration files, configuration database, and environment variables to determine the rules to be used when deploying the images to the target computers.

The scripts create log files as the scripts automate the deployment process. The log files record the status of the deployment process and can be used to assist in the troubleshooting the deployment process.

For more information on each script, see “Deployment Process Flowcharts” in Configuration Reference.

Configuration Files

The scripts interpret the configuration files to ensure the appropriate steps occur to deploy the correct operating system to the appropriate target computer. Run the wizards in Deployment Workbench to assist in the creation and maintenance the configuration files.

Deployment Workbench can create and manage:

Templates configuration files. After Deployment Workbench creates the template file, the file is manually customized to include the appropriate processing rules. The CustomSettings.ini file is an example of this type of configuration file. After these template files are initially created, maintain them manually instead of through Deployment Workbench.
Completed configuration files. These files require no further customization. The Applications.xml file is an example of this type of configuration file. Maintain these files through Deployment Workbench. Although you can maintain these files manually, using Deployment Workbench is recommended to avoid introducing errors due to human error.

The configuration files in BDD 2007 and a brief description are listed in Table 2.

Table 2. Configuration Files in BDD 2007

Configuration File	Description
CustomSettings.ini	Primary configuration file for the BDD 2007 processing rules used in all scenarios
BootStrap.ini	Configuration file used when the target computer is not able to connect to the appropriate deployment point. This situation occurs in the New Computer scenario and for the replacement computer in the Replace Computer scenario

For more information about the other configuration files, see “Deployment Process Flowcharts” in Configuration Reference.

Configuration Database

The configuration database is a logical extension of configuration settings that would normally exist in CustomSettings.ini. Create and manage the configuration database through the Database node in Deployment Workbench.

The configuration database allows you to centrally store the configuration settings in a relational database. The configuration database is referenced in the CustomSettings.ini file. The scripts query that database to retrieve values for properties. Using the configuration database is appropriate when the target computers have a high-speed, persistent connection to the server running Microsoft SQL Server™ where the configuration database is stored. Otherwise, make all configuration settings in CustomSettings.ini.

For more information on the configuration database, see “Configuring the Rules in the Configuration Database,” later in this guide.

Environment Variables

The scripts automatically retrieve appropriate environment variables. The variables are referenced like properties in the deployment processing rules. The environment variables can be referenced as any property in the configuration files or configuration database.

Log Files

Because the scripts automatically create log files, no configuration settings are necessary. Each script creates a log file that matches the name of the script. For example, ZTIGather.wsf creates a log file named ZTIGather.log.

Each script also updates a common log file (BDD.log) that aggregates the contents of all the logs.

For more information on each log file, see “Deployment Process Flowcharts” in Configuration Reference.

Identifying the CustomSettings.ini Syntax

The syntax of the CustomSettings.ini file is very similar to many .ini files. Listing 1 lists a CustomSettings.ini file that is customized for a ZTI-based deployment. For a further explanation of the CustomSettings.ini file in Listing 1, see “Basic CustomSettings.ini File for ZTI” in Deployment Configuration Samples Guide.

Listing 1. CustomSettings.ini file Customized for ZTI Deployment

[Settings]
Priority=Default, MACAddress
Properties=CustomProperty
[Default]
OSInstall=Y
ScanStateArgs=/v:5 /o /c
LoadStateArgs=/v:5 /c /lac
UserDataLocation=NONE
CustomProperty=TRUE
OSDINSTALLSILENT=1
[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

A CustomSettings.ini file includes:

Sections
Properties
Settings

Sections in CustomSettings.ini File

Sections are identified by brackets that surround the section name (for example [Settings]). In Listing 1, the sections include [Settings], [Default], [00:0F:20:35:DE:AC], and [00:03:FF:FE:FF:FF].

Required Sections

Only the [Settings] section is required. All other sections are optional. The BDD 2007 scripts require the [Settings] section in CustomSettings.ini to locate the reserved properties (Priority and Properties properties).

Optional Sections

The optional sections in the CustomSettings.ini file are used to assign a group of configuration settings to:

A group of computers. In Listing 1, the configuration settings in the [Default] section are applied to more than one computer. For more information, see “Applying the Properties to Groups of Computers” later in this guide.
An individual computer. In Listing 1, the configuration settings in the [00:0F:20:35:DE:AC] and [00:03:FF:FE:FF:FF] sections are applied to the corresponding computer (in this case, identified by the media access control [MAC] address of the target computer). For more information, see “Applying the Properties to Individual Computers” later in this guide.

Properties in CustomSettings.ini File

Properties are variables that need to have values assigned. Properties are followed by an equal sign (“=”). The scripts scan the CustomSettings.ini file to locate the properties.

The types of properties that can be used in deploying your target computers include those properties:

Automatically declared in ZTIGather.wsf. These predefined properties are declared in the ZTIGather.wsf code and are documented in the Configuration Reference. In addition, ZTIGather.wsf automatically sets the values for these properties. These properties are not configured in CustomSettings.ini and should be treated as read-only.
Declared in the ZTIGather.xml file. These predefined properties are listed in the ZTIGather.xml file and are documented in Configuration Reference. ZTIGather.wsf retrieves these properties by scanning the ZTIGather.xml file. You can divide the properties in this file into properties that:
- ZTIGather.wsf automatically assigns values. ZTIGather.wsf automatically sets the values for these properties, which need to be treated as read-only.
- You need to assign values to in CustomSettings.ini. You need to ensure that the value for any of these properties that you wish to use is set in CustomSettings.ini and is considered modifiable.
Declared in the Properties property. These are custom properties that you can declare, and they are in addition to the properties automatically declared in ZTIGather.wsf and in ZTIGather.xml.

The way properties are used for ZTI and LTI are identical. However, some properties are unique to ZTI or LTI.

Because ZTI uses Microsoft Systems Management Server (SMS) 2003 and the SMS Operating System Deployment (OSD) Feature Pack to deploy target operating system images, ZTI has properties that refer to SMS OSD Feature Pack values (such as OSDInstallPackage, OSDInstallProgram, and OSDNewMachineName).

Like ZTI, LTI also has unique properties. Most of the LTI-specific properties relate to the Windows Deployment Wizard (such as SkipAdministratorPassword, SkipCapture, or SkipUserData).

Although these properties use the same syntax as other properties, the reserved properties perform specific functions in the deployment processing rules.

Priority Reserved Property

The Priority reserved property determines the sequence and section of where to find configuration values. Each section is searched in the order specified. When a property value is found, the remaining sections are not used for that property. In Listing 1, the [Default] section is parsed first, and then the section that corresponds to the MAC address of the target computer (in this case, [00:0F:20:35:DE:AC] or [00:03:FF:FE:FF:FF]).

Table 3 lists the types of property value that can be assigned to the Priority property.

Table 3. Priority Property Value Types and Their Descriptions

Priority Property Value	Description
DefaultGateway	The scripts scan for a section that matches the default gateway IP address of the target computer, for example a section named [10.1.1.1]. If the section is found, the script scans the section for properties. If the section does not exist, the script continues scanning based on the remaining values in the Priority property.
LocalDataName	Any property known to the scripts can be used to identify a section name in the configuration file. For example, specifying the HostName property causes the script to scan for a section with the target computer host name. Other properties, like MACAddress, can result in multiple section names being checked (because a computer can have multiple MAC addresses).
CustomSection	One or more specific section names can be specified, where CustomSection represents the desired section name. For example, if MySection were included in the Priority property, the [MySection] section would be searched for any properties not previously found.

DefaultGateway

The scripts scan for a section that matches the default gateway IP address of the target computer, for example a section named [10.1.1.1]. If the section is found, the script scans the section for properties. If the section does not exist, the script continues scanning based on the remaining values in the Priority property.

LocalDataName

Any property known to the scripts can be used to identify a section name in the configuration file.

For example, specifying the HostName property causes the script to scan for a section with the target computer host name. Other properties, like MACAddress, can result in multiple section names being checked (because a computer can have multiple MAC addresses).

CustomSection

One or more specific section names can be specified, where CustomSection represents the desired section name. For example, if MySection were included in the Priority property, the [MySection] section would be searched for any properties not previously found.

Properties Reserved Property

The Properties reserved property (as shown in Listing 1) defines any custom, user-defined properties that you want to use in your deployment. These user-defined properties are located by ZTIGather.wsf script in the CustomSettings.ini file (or configuration database). These properties are in addition to the predefined properties in BDD 2007.

In Listing 1, CustomProperty is a user-defined property and ScanStateArgs is a predefined property. For a list of the predefined properties in BDD 2007, see “Property Reference” in Configuration Reference.

Values in CustomSettings.ini File

Values are the configuration settings assigned to the properties. Values are preceded by an equal sign (“=”). The scripts scan the CustomSettings.ini file to locate the values. In Listing 1, the value assigned to the LoadStateArgs property is as follows:

/v:5 /c /lac

Identifying the BootStrap.ini Syntax

In ZTI and LTI deployments, use the BootStrap.ini file to specify property settings prior to accessing the CustomSettings.ini file. Use the BootStrap.ini file to provide distribution point information, SMS OSD Feature Pack package and program information, logon credentials, and Microsoft Windows Preinstallation Environment (Windows PE) keyboard locale settings.

The properties configured in BootStrap.ini help the BDD 2007 scripts locate the appropriate:

BDD 2007 distribution point.
SMS 2003 OSD Feature Pack package and program.

For example, in the New Computer scenario for ZTI, specify the SMS 2003 OSD Feature Pack properties in BootStrap.ini so that the BDD 2007 scripts know which SMS 2003 OSD Feature Pack package to use (because CustomSettings.ini is in the package).

The syntax of the BootStrap.ini file is identical to the CustomSettings.ini file. The BootStrap.ini file contains a subset of the properties that are used in the CustomSettings.ini file. Table 4 lists the common properties that are configured in BootStrap.ini

Table 4. Common Properties Configured in BootStrap.ini

Property Name	LTI	ZTI
DeployRoot
SkipBDDWelcome
UserDomain
UserID
UserPassword
KeyboardLocale
OSDInstallSilent
OSDInstallPackage
OSDInstallProgram

Deployment Workbench creates the BootStrap.ini file when a deployment point is created. After the initial creation, make all further customizations manually. Listing 2 shows the BootStrap.ini file that Deployment Workbench creates automatically for deployment point types other than SMS 2003 OSD Feature Pack (OSD), including the “Lab or single-server deployment” (LAB), “Separate deployment share” (Network), and “Removable media” (Media) deployment types. The BootStrap.ini file in Listing 2 may have to be customized (for example, to add the properties listed in Table 4).

Listing 2. BootStrap.ini file as Created by Deployment Workbench for Deployment Point Types Other Than OSD

[Settings]
Priority=Default
[Default]
DeployRoot=\\NYC-BDD-01\Distribution$

Listing 3 illustrates the BootStrap.ini file that Deployment Workbench creates automatically for SMS 2003 OSD Feature Pack deployment points that have been customized to include the OSDInstallSilent, OSDInstallPackage, and OSDInstallProgram properties.

Note The DeployRoot property is not automatically added to a deployment type of OSD.

Listing 3. BootStrap.ini file as Created by Deployment Workbench for OSD Type Deployment Points for ZTI-based Deployments

[Settings]
Priority=Default
[Default]
OSDINSTALLSILENT=1
OSDINSTALLPACKAGE=XXX00000
OSDINSTALLPROGRAM=Install