Share via

UDI Wizard Task Sequence variables

  • Article

 

I know that I haven't posted in a while, but I have been thinking about it. I have several topics in draft form just waiting to be finished up and posted. In today's blog I will go over the task sequence variables that are read or set based on the selections made from each page in the wizard. 

Welcome Page

 No variables are read or set for this page.

 

Preflight Page

 No variables are read or set from the wizard for this page. However, there are some task sequence variables that may be set from some of the preflights being run from the page. An example of this is the variable set from the BitLocker preflight check.

OSDBitlockerStatus 

This task sequence variable specifies if BitLocker Drive Encryption is enabled on the target computer by the BitLocker preflight check.

Value

Description

Example

PROTECTED

The target computer has BitLocker Drive Encryption enabled.

OSDBitlockerStatus=PROTECTED

Does not exist

If the target computer does not have BitLocker Drive Encryption enabled, then the task sequence variable does not exist.

 

Computer Page

 

OSDComputerName

The computer name assigned to the target computer

Value

Description

Example

Computer Name

The computer name to assign to the target computer

OSDComputerName=%_SMSTSMachineName%

 

OSDDomainName

Specifies the name of the domain to which the target computer will be joined if the computer is configured to be a domain member.

Value

Description

Example

Domain Name

The name of the domain to which the target computer will be joined.

OSDDomainName=domain01

 

OSDDomainOUName

Specifies the name of the OU in the domain to which the target computer account will be created when the computer joins a domain.

Value

Description

Example

OU Name

The name of the OU in the domain in which the computer account will be created.

OSDDomainOUName=OU=Workstations,DC=MyDomain,DC=MyCorp,DC=MyForest,DC=COM

 

OSDWorkgroupName

Specifies the name of the workgroup to which the target computer will be joined if the computer is configured to be a workgroup member.

Value

Description

Example

Workgroup Name

The name of the workgroup to which the target computer will be joined.

OSDWorkgroupName=WORKGROUP01

 

OSDNetworkJoinType

Specifies whether the target computer joins a domain or a workgroup.

Value

Description

Example

0

Specifies that the target computer will join a domain. Additionally if this variable is set to this value then the domain/workgroup radio button will be set to domain.

OSDNetworkJoinType=0

1

Specifies that the target computer will join a workgroup. Additionally if this variable is set to this value then the domain/workgroup radio button will be set to workgroup.

OSDNetworkJoinType=1

 

OSDJoinAccount

Specifies the domain-based account used to join the target computer to the domain specified in the OSDDomainName task sequence variable. This task sequence variable is necessary if the target computer will be joined to a domain.

Value

Description

Example

Account Name

The name of the account used to join the target computer to the domain in the format of domain\account.

OSDJoinAccount=domain\account

 

 

OSDJoinPassword

Specifies the password for the domain-based account used to join the target computer to the domain specified in the OSDJoinAccount task sequence variable. This task sequence variable is necessary if the target computer will be joined to a domain.

Value

Description

Example

password

The name of the account used to join the target computer to the domain in the format of domain\account.

OSDJoinAccount=domain\account

 

User Configuration Page

 

OSDLocalAdminPassword

Specifies the password for the Administrator local built-in account on the target computer.

Value

Description

Example

password

The password of the Administrator local built-in account on the target computer.

OSDLocalAdminPassword=password

  

AddAdmin

This task sequence variable specifies a list of domain-based accounts or local accounts to be added to the Administrators local built-in group on the target computer.

Value

Description

Example

domain\account_name1; computer\account_name2

The format of the accounts to be made members of the Administrators group on the target computer in the format of domain\account and separated by semicolons, where domain can be the name of an Active Directory domain or the target computer name.

OSDAddAdmin=domain\user01;Win7-01\LocalUser01

 

Language Page

 

UILanguage

The default language to be used with the target operating system. If not specified, the language configured in the image being deployed will be used.

Value

Description

Example

UI_language

The default language for the operating system on the target computer

UILanguage=en-us

 

UserLocale

 The user locale to be used with the target operating system. If not specified, the user locale configured in the image being deployed will be used.

Value

Description

Example

user_locale

The locale for the user on the target computer. For:

· Windows Server 2003, the value is specified as a hexadecimal value (0409:00000409).

· Windows Server 2008, the value is specified as a text value (en-us).

UserLocale=fr-CA

 

SystemLocale

Default system locale used for the operating system.

Value

Description

Example

locale

The default locale of the operating system

SystemLocale=0409:00000409

 

KeyboardLocale

Keyboard locale to be used in the deployed operating system.

Value

Description

Example

keyboardLocale

An additional keyboard locale to be made available in the deployed operating system

KeyboardLocale=0409:00000409

 

OSDTimeZone

The default time zone  

Value

Description

Example

Time Zone

The default time zone that will be set for the deployed operating system

OSDTimeZone="Pacific Standard Time"

 

Volume Page

 

OSDImageIndex

Specifies the index number of the target operating system in a WIM file.

Value

Description

Example

index number

The index number of the target, which starts with an index number of 1 for the first operating system in the WIM file.

OSDImageIndex=1

OSDArchitecture

Specifies the processor architecture of the target operating system selected for deployment.

Value

Description

Example

x86

The target operating system is a 32-bit operating system.

OSDAchitecture=x86

amd64

The target operating system is a 64-bit operating system.

OSDAchitecture=amd64

 

OSDTargetDrive

Specifies the disk volume where the target operating system will be deployed.

Value

Description

Example

disk volume

The disk volume designation

OSDTargetDrive=C:

 

OSDWinPEWinDir

Specifies the folder in which the Windows operating system is currently installed on the target computer.

Value

Description

Example

windows directory

The directory in which the Windows operating system is currently installed from which the user state will be captured from.

OSDWinPEWinDir=C:\Windows

 

OSDDiskPart

Specifies whether the target disk partition should be formatted.

Value

Description

Example

YES

The target disk partition will be formatted.

OSDDiskPart=YES

NO

The target disk partition will not be formatted.

OSDDiskPart=NO

 

Application Page

OSDApplicationList

Specifies which applications should be selected by default on the Install Software page of the Operating System Deployment (OSD) Setup Wizard.

Value

Description

Example

list of app ids

A semicolon-delimited list of application to be selected by default on the Install Software page of the Operating System Deployment (OSD) Setup Wizard; each application is represented by an application ID and separated by a semicolon. The application ID is derived from the Id attribute of each application in the UDIWizard_Config.xml file. In the following excerpt from a UDIWizard_Config.xml file, the Office 2007 SP2 application has an Id attribute of 1:

<Application DisplayName="Office 2007 SP2" State="Disabled" Id="1">

NOTE: This variable can be read in but when the wizard exits it will set the task sequence variables in a manner which can be read by the task sequence.

OSDApplicationList=2;3

 

Application Base Variables

These variables will be set based on which applications are selected when the wizard exits and what the base variable name is set to.

Value

Description

Example

PKGID:Program Name

The base variable name is configurable from the designer for the wizard. The name used must match the base variable name used in your task sequence on the Install Software Step.

The number of applications which can be installed range from 1 to 999 from this single step. By default the base variable name used with UDI is Packages so the avaible variables which can be set are: Packages001 - Pacakges999.

Packages001=SMS0000C:Office Setup

 

Summary Page

No variables are set from this page. However, as this is the last page in the wizard when the Finish button is selected then the selections for each page will be set as task sequence variables.

 

Other

OSDSetupWizCancelled

Specifies if the user cancelled the Operating System Deployment (OSD) Setup Wizard. The wizard can be cancelled from any page in the wizard.

Value

Description

Example

True

The user cancelled the Operating System Deployment (OSD) Setup Wizard.

OSDSetupWizCancelled=True

Does not exist

If the wizard is not cancelled, then the task sequence variable does not exist.

Comments

  • Anonymous
    December 31, 2013
    UDI Wizard Task Sequence variables