Task sequence action variables in System Center Configuration Manager

Applies to: System Center Configuration Manager (Current Branch)

Task sequence action variables specify configuration settings that are used by a single step in a System Center Configuration Manager task sequence. By default, the task sequence step initializes its settings before it runs. These settings are available only while the associated task sequence step runs. In other words, the task sequence adds the action variable value to the task sequence environment before the task sequence step is run. The task sequence removes the value from the environment after the step runs.

Action Variable Example

For example, you can specify a start-in directory for a command-line action by using the Run Command Line task sequence step. This step includes a Start In property whose default value is stored in the task sequence environment as the WorkingDirectory variable. The WorkingDirectory environment variable is initialized before the Run Command Line task sequence action is run. During the Run Command Line step, the WorkingDirectory value can be accessed through the Start In property. After the step completes, the task sequence removes the value of the WorkingDirectory variable from the environment. If the sequence contains another Run Command Line task sequence step, the task sequence initializes a new WorkingDirectory variable, and sets it to the starting value for the current step.

The default value for a task sequence action variable is present when the task sequence step runs. If you set a new value, it is available to multiple steps in the task sequence. If you use one of the task sequence variable creation methods to override a built-in variable value, the new value remains in the environment and overrides the default value for other steps in the task sequence. For example, if you add a Set Task Sequence Variable step as the first step of the task sequence, which sets the WorkingDirectory variable to C:\, any Run Command Line step in the task sequence uses the new starting directory value.

Action Variables for Task Sequence Actions

Configuration Manager task sequence variables are grouped by their associated task sequence action. Use the following links to gather information about the action variables associated with a specific action. The task sequence variables govern how the task sequence action operates. The task sequence action reads and uses the variables that you mark as input variables. Alternatively, you can use the Set Task Sequence Variable step or the TSEnvironment COM object to set the variables at runtime. Only the task sequence action marks variables as output variables. Actions that occur later in the task sequence read these output variables.

Note

Not all task sequence actions are associated with a set of task sequence variables. For example, although there are variables associated with the Enable BitLocker action, there are no variables associated with the Disable BitLocker action.

Apply Data Image

For more information, see Apply Data Image.

Details

Action Variable Name Description
OSDDataImageIndex

(input)
Specifies the index value of the image that is applied to the destination computer.
OSDWipeDestinationPartition

(input)
Specifies whether to delete the files located on the destination partition.

Valid values:

true (default)

false

Apply Driver Package

For more information, see Apply Driver Package.

Details

Action Variable Name Description
OSDApplyDriverBootCriticalContentUniqueID

(input)
Specifies the content ID of the mass storage device driver to install from the driver package. If this variable is not specified, no mass storage driver is installed.
OSDApplyDriverBootCriticalINFFile

(input)
Specifies the INF file of the mass storage driver to install.



This task sequence variable is required if the OSDApplyDriverBootCriticalContentUniqueID is set.
OSDApplyDriverBootCriticalHardwareComponent

(input)
Specifies whether a mass storage device driver is installed, this variable must be scsi.

This task sequence variable is required if the OSDApplyDriverBootCriticalContentUniqueID is set.
OSDApplyDriverBootCriticalID

(input)
Specifies the boot critical ID of the mass storage device driver to install. This ID is listed in the scsi section of the device driver's txtsetup.oem file.

This task sequence variable is required if the OSDApplyDriverBootCriticalContentUniqueID is set.
OSDAllowUnsignedDriver

(input)
Specifies whether to configure Windows to allow the installation of unsigned device drivers. This task sequence variable is not used when deploying the Windows Vista and later operating system.

Valid values:

true

false (default)

Apply Network Settings

For more information, see Apply Network Settings.

Details

Action Variable Name Description
OSDAdapter

(input)
This task sequence variable is an array variable. Each element in the array represents the settings for a single network adapter on the computer. Access the settings for each adapter by combining the array variable name with the zero-based network adapter index and the property name.

If this step configures multiple network adapters, it defines the properties for the second network adapter by using the index in the variable name. For example, OSDAdapter1EnableDHCP, OSDAdapter1IPAddressList, OSDAdapter1DNSDomain, OSDAdapter1WINSServerList, and OSDAdapter1EnableWINS.

For example, use the following variable names to define the properties of the first network adapter for this task sequence step to configure:

  • OSDAdapter0EnableDHCP: true enables Dynamic Host Configuration Protocol (DHCP) for the adapter.
    This setting is required. Possible values are: True or False.
  • OSDAdapter0IPAddressList: Comma-delimited list of IP addresses for the adapter. This property is ignored unless EnableDHCP is set to false.
    This setting is required.
  • OSDAdapter0SubnetMask: Comma-delimited list of subnet masks. This property is ignored unless EnableDHCP is set to false.
    This setting is required.
  • OSDAdapter0Gateways: Comma-delimited list of IP gateway addresses. This property is ignored unless EnableDHCP is set to false.
    This setting is required.
  • OSDAdapter0DNSDomain: Domain Name System (DNS) domain for the adapter.
  • OSDAdapter0DNSServerList: Comma-delimited list of DNS servers for the adapter.
    This setting is required.
  • OSDAdapter0EnableDNSRegistration: true to register the IP address for the adapter in DNS.
  • OSDAdapter0EnableFullDNSRegistration: true to register the IP address for the adapter in DNS under the full DNS name for the computer.
  • OSDAdapter0EnableIPProtocolFiltering: true to enable IP protocol filtering on the adapter.
  • OSDAdapter0IPProtocolFilterList: Comma-delimited list of protocols allowed to run over IP. This property is ignored if EnableIPProtocolFiltering is set to false.
  • OSDAdapter0EnableTCPFiltering: true to enable TCP port filtering for the adapter.
  • OSDAdapter0TCPFilterPortList: Comma-delimited list of ports to be granted access permissions for TCP. This property is ignored if EnableTCPFiltering is set to false.
  • OSDAdapter0TcpipNetbiosOptions: Options for NetBIOS over TCP/IP. Possible values are as follows:

    • 0: Use NetBIOS settings from DHCP server.
    • 1: Enable NetBIOS over TCP/IP.
    • 2: Disable NetBIOS over TCP/IP.
  • OSDAdapter0EnableWINS: true to use WINS for name resolution.
  • OSDAdapter0WINSServerList: Comma-delimited list of WINS server IP addresses. This property is ignored unless EnableWINS is set to true.
  • OSDAdapter0MacAddress: MAC address used to match settings to physical network adapter.
  • OSDAdapter0Name: Name of the network connection as it appears in the network connections control panel program. The name is between 0 and 255 characters in length.
  • OSDAdapter0Index: Index of the network adapter settings in the array of settings.

    OSDAdapterCount=1
    OSDAdapter0EnableDHCP=FALSE
    OSDAdapter0IPAddressList=192.168.0.40
    OSDAdapter0SubnetMask=255.255.255.0
    OSDAdapter0Gateways=192.168.0.1
    OSDAdapter0DNSSuffix=contoso.com
OSDAdapterCount

(input)
Specifies the number of network adapters installed on the destination computer. When the OSDAdapterCount value is set, all the configuration options for each adapter must be set. For example, if you set the OSDAdapterTCPIPNetbiosOptions value for a specific adapter then all the values for that adapter must also be configured.

If this value is not specified, all OSDAdapter values are ignored.
OSDDNSDomain

(input)
Specifies the primary DNS server that is used by the destination computer.
OSDDomainName

(input)
Specifies the name of the Windows domain that the destination computer joins. The specified value must be a valid Active Directory Domain Services domain name.
OSDDomainOUName

(input)
Specifies the RFC 1779 format name of the organizational unit (OU) that the destination computer joins. If specified, the value must contain the full path.

Example:

LDAP://OU=MyOu,DC=MyDom,DC=MyCompany,DC=com
OSDEnableTCPIPFiltering

(input)
Specifies whether TCP/IP filtering is enabled.

Valid values:

true

false (default)
OSDJoinAccount

(input)
Specifies the network account that is used to add the destination computer to a Windows domain.
OSDJoinPassword

(input)
Specifies the network password that is used to add the destination computer to a Windows domain.
OSDNetworkJoinType

(input)
Specifies whether the destination computer joins a Windows domain or a workgroup.

0 indicates that the destination computer joins a Windows domain. 1 specifies that the computer joins a workgroup.

Valid values:

0

1
OSDDNSSuffixSearchOrder

(input)
Specifies the DNS search order for the destination computer.
OSDWorkgroupName

(input)
Specifies the name of the workgroup that the destination computer joins.

Specify either this value or the OSDDomainName value. The workgroup name can be a maximum of 32 characters.

Example:

Accounting

Apply Operating System Image

For more information, see Apply Operating System Image.

Details

Action Variable Name Description
OSDConfigFileName

(input)
Specifies the file name of the operating system deployment answer file associated with the operating system deployment package.
OSDImageIndex

(input)
Specifies the image index value of the WIM file that is applied to the destination computer.
OSDInstallEditionIndex

(input)
Specifies the version of Windows Vista or later operating system that is installed. If no version is specified, Windows Setup determines which version to install using the referenced product key.

Use only a value of zero (0) if the following conditions are true:

- You are installing a pre-Windows Vista operating system
- You are installing a volume license edition of Windows Vista or later, and no product key is specified.

Valid values:

0 (default)
OSDTargetSystemDrive (output) Specifies the drive letter of the partition that contains the operating system files.

Apply Windows Settings

For more information, see Apply Windows Settings.

Details

Action Variable Name Description
OSDComputerName

(input)
Specifies the name of the destination computer.

Example:

%_SMSTSMachineName% (default)
OSDProductKey

(input)
Specifies the Windows product key. The specified value must be between 1 and 255 characters.
OSDRegisteredUserName

(input)
Specifies the default registered user name in the new operating system. The specified value must be between 1 and 255 characters.
OSDRegisteredOrgName

(input)
Specifies the default registered organization name in the new operating system. The specified value must be between 1 and 255 characters.
OSDTimeZone

(input)
Specifies the default time zone setting that is used in the new operating system.
OSDServerLicenseMode

(input)
Specifies the Windows Server license mode that is used.

Valid values:

PerSeat

PerServer
OSDServerLicenseConnectionLimit

(input)
Specifies the maximum number of connections allowed. The specified number must be in the range between 5 and 9999 connections.
OSDRandomAdminPassword

(input)
Specifies a randomly generated password for the administrator account in the new operating system. If set to true, Windows Setup disables the local administrator account on the target computer. If set to false, Windows Setup enables the local administrator account on the target computer, and sets the account password to the value of OSDLocalAdminPassword.

Valid values:

true (default)

false
OSDLocalAdminPassword

(input)
Specifies the local administrator password. If you enable Randomly generate the local administrator password and disable the account on all supported platforms, then the step ignores this variable. The specified value must be between 1 and 255 characters.

Auto Apply Drivers

For more information, see Auto Apply Drivers.

Details

Action Variable Name Description
OSDAutoApplyDriverCategoryList

(input)
A comma-delimited list of the driver catalog category unique IDs. The Auto Apply Driver step only considers the drivers in at least one of the specified categories. This value is optional, and it is not set by default. Obtain the available category IDs by enumerating the list of SMS_CategoryInstance objects on the site.
OSDAllowUnsignedDriver

(input)
Specifies whether Windows is configured to allow unsigned device drivers to be installed. This task sequence variable is not used when deploying Windows Vista and later operating systems.

Valid values:

true

false (default)
OSDAutoApplyDriverBestMatch

(input)
If there are multiple device drivers in the driver catalog that are compatible with a hardware device, this variable determines the step's action. If set to true, the step only installs the best device driver. If false, the step installs all compatible device drivers, and Windows chooses the best driver to use.

Valid values:

true (default)

false
SMSTSDriverRequestConnectTimeOut When requesting the driver catalog, this variable is the number of seconds the task sequence waits for the HTTP server connection. If the connection takes longer than the timeout setting, the task sequence cancels the request. By default, the timeout is set to 60 seconds.
SMSTSDriverRequestReceiveTimeOut When requesting the driver catalog, this variable is the number of seconds the task sequence waits for a response. If the connection takes longer than the timeout setting, the task sequence cancels the request. By default, the timeout is set to 480 seconds.
SMSTSDriverRequestResolveTimeOut When requesting the driver catalog, this variable is the number of seconds the task sequence waits for HTTP name resolution. If the connection takes longer than the timeout setting, the task sequence cancels the request. By default, the timeout is set to 60 seconds.
SMSTSDriverRequestSendTimeOut When sending a request for the driver catalog, this variable is the number of seconds the task sequence waits to send the request. If the request takes longer than the timeout setting, the task sequence cancels the request. By default, the timeout is set to 60 seconds.

Capture Network Settings

For more information, see Capture Network Settings.

Details

Action Variable Name Description
OSDMigrateAdapterSettings

(input)
Specifies whether the network adapter settings (TCP/IP, DNS, and WINS) configuration information is captured.

Examples:

true (default)

false
OSDMigrateNetworkMembership

(input)
Specifies whether the workgroup or domain membership information is migrated as part of the operating system deployment.

Examples:

true (default)

false

Capture Operating System Image

For more information, see Capture Operating System Image.

Details

Action Variable Name Description
OSDCaptureAccount

(input)
Specifies a Windows account name that has permissions to store the captured image on a network share.
OSDCaptureAccountPassword

(input)
Specifies the password for the Windows account used to store the captured image on a network share.
OSDCaptureDestination

(input)
Specifies the location where the captured operating system image is saved. The maximum directory name length is 255 characters.
OSDImageCreator

(input)
An optional name of the user who created the image. This name is stored in the WIM file. The maximum length of the user name is 255 characters.
OSDImageDescription

(input)
An optional user-defined description of the captured operating system image. This description is stored in the WIM file. The maximum length of the description is 255 characters.
OSDImageVersion

(input)
An optional user-defined version number to assign to the captured operating system image. This version number is stored in the WIM file. This value can be any combination of letters with a maximum length of 32 characters.
OSDTargetSystemRoot

(input)
Specifies the path to the Windows directory of the installed operating system on the reference computer. This operating system is verified as being a supported operating system for capture by Configuration Manager.

Capture User State

For more information, see Capture User State.

Details

Action Variable Name Description
OSDStateStorePath

(input)
The UNC or local path name of the folder where the user state is saved. No default.
OSDMigrateAdditionalCaptureOptions

(input)
Additional user state migration tool (USMT) command-line options that the task sequence uses to capture user state. The step does not expose these settings in the task sequence editor. Specify these options as a string, which the task sequence appends to the automatically generated USMT command line.

The USMT options specified with this task sequence variable are not validated for accuracy prior to running the task sequence.
OSDMigrateMode

(input)
Allows you to customize the files that are captured by USMT. If this variable is set to Simple, then the task sequence only uses the standard USMT configuration files. If this variable is set to Advanced, then the task sequence variable OSDMigrateConfigFiles specifies the configuration files that USMT uses.

Valid values:

Simple

Advanced
OSDMigrateConfigFiles

(input)
Specifies the configuration files used to control the capture of user profiles. This variable is used only if OSDMigrateMode is set to Advanced. This comma-delimited list value is set to perform customized user profile migration.

Example: miguser.xml,migsys.xml,migapps.xml
OSDMigrateContinueOnLockedFiles

(input)
If USMT cannot capture some files, this variable allows the user state capture to proceed.

Valid values:

true (default)

false
OSDMigrateEnableVerboseLogging

(input)
Enables verbose logging for USMT.

Valid values:

true

false (default)
OSDMigrateSkipEncryptedFiles

(input)
Specifies whether encrypted files are captured.

Valid values:

true

false (default)
_OSDMigrateUsmtPackageID

(input)
Specifies the package ID of the Configuration Manager package that contains the USMT files. This variable is required.

Capture Windows Settings

For more information, see Capture Windows Settings.

Details

Action Variable Name Description
OSDMigrateComputerName

(input)
Specifies whether the computer name is migrated.

Valid values:

true (default)

false

If the value is true, then the OSDComputerName variable is set to the NetBIOS name of the computer.
OSDComputerName

(output)
Set to the NetBIOS name of the computer. The value is set only if the OSDMigrateComputerName variable is set to true.
OSDMigrateRegistrationInfo

(input)
Specifies whether the step migrates user and organization information.

Valid values:

true (default)

false

If the value is true, then the OSDRegisteredOrgName variable is set to the registered organization name of the computer.
OSDRegisteredOrgName

(output)
Set to the registered organization name of the computer. The value is set only if the OSDMigrateRegistrationInfo variable is set to true.
OSDMigrateTimeZone

(input)
Specifies whether the computer time zone is migrated.

Valid values:

true (default)

false

If the value is true, then the variable OSDTimeZone is set to the time zone of the computer.
OSDTimeZone

(output)
Set to the time zone of the computer. The value is set only if the OSDMigrateTimeZone variable is set to true.

Connect to Network Folder

For more information, see Connect To Network Folder.

Details

Action Variable Name Description
SMSConnectNetworkFolderAccount

(input)
Specifies the administrator account that is used to connect to the network share.
SMSConnectNetworkFolderDriveLetter

(input)
Specifies the network drive letter to connect to. This value is optional; if it is not specified, then the network connection is not mapped to a drive letter. If this value is specified, the value must be in the range from D: to Z:. In addition, do not use X: as it is the drive letter used by Windows PE during the Windows PE phase.

Examples:

D:

E:
SMSConnectNetworkFolderPassword

(input)
Specifies the network password that is used to connect to the network share.
SMSConnectNetworkFolderPath

(input)
Specifies the network path for the connection.

Example:

\\servername\sharename

Enable BitLocker

For more information, see Enable BitLocker.

Details

Action Variable Name Description
OSDBitLockerRecoveryPassword

(input)
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.
OSDBitLockerStartupKey

(input)
Instead of generating a random startup key for the key management option Startup Key on USB only, the Enable BitLocker step uses the Trusted Platform Module (TPM) as the startup key. The value must be a valid, 256-bit Base64-encoded BitLocker startup key.

Format and Partition Disk

For more information, see Format and Partition Disk.

Details

Action Variable Name Description
OSDDiskIndex

(input)
Specifies the physical disk number to be partitioned.
OSDDiskpartBiosCompatibilityMode

(input)
When partitioning the hard disk for compatibility with certain types of BIOS, this variable specifies whether to disable cache alignment optimizations. This is necessary when deploying Windows XP or Windows Server 2003 operating systems. For more information, see article 931760 and article 931761 in the Microsoft Knowledge Base.

Valid values:

true

false (default)
OSDGPTBootDisk

(input)
Specifies whether to create an EFI partition on a GPT hard disk. EFI-based computers use this partition as the startup disk.

Valid values:

true

false (default)
OSDPartitions

(input)
Specifies an array of partition settings; see the SDK topic for accessing array variables in the task sequence environment.

This task sequence variable is an array variable. Each element in the array represents the settings for a single partition on the hard disk. Access the settings defined for each partition by combining the array variable name with the zero-based disk partition number and the property name.

For example, use the following variable names to define the properties for the first partition that this step creates on the hard disk:

- OSDPartitions0Type: Specifies the type of partition. This property is required. Valid values are Primary, Extended, Logical, and Hidden.
- OSDPartitions0FileSystem: Specifies the type of file system to use when formatting the partition. This property is optional. If you do not specify a file system, the step does not format the partition. Valid values are FAT32 and NTFS.
- OSDPartitions0Bootable: Specifies whether the partition is bootable. This property is required. If this value is set to TRUE for MBR disks, then the step marks this partition as active.
- OSDPartitions0QuickFormat: Specifies the type of format that is used. This property is required. If this value is set to TRUE, the step performs a quick format. Otherwise, the step performs a full format.
- OSDPartitions0VolumeName: Specifies the name that is assigned to the volume when it is formatted. This property is optional.
- OSDPartitions0Size: Specifies the size of the partition. Units are specified by the OSDPartitions0SizeUnits variable. This property is optional. If this property is not specified, the partition is created using all remaining free space.
- OSDPartitions0SizeUnits: The step uses these units to interpret the OSDPartitions0Size variable. This property is optional. Valid values are MB (default), GB, and Percent.
- OSDPartitions0VolumeLetterVariable: When this step creates partitions, it always uses the next available drive letter in Windows PE. Use this optional property to specify the name of another task sequence variable. The step uses this variable to save the new drive letter for future reference.

If you define multiple partitions with this task sequence action, the properties for the second partition are defined by using their index in the variable name. For example: OSDPartitions1Type, OSDPartitions1FileSystem, OSDPartitions1Bootable, OSDPartitions1QuickFormat, and OSDPartitions1VolumeName.
OSDPartitionStyle

(input)
Specifies the partition style to use when partitioning the disk. MBR indicates the master boot record partition style, and GPT indicates the GUID Partition Table style.

Valid Values:

GPT

MBR

Install Application

For more information, see Install Application.

Details

Action Variable Name

(input)
Description
TSErrorOnWarning Specify whether the task sequence engine considers a detected warning as an error during this step. The task sequence sets the _TSAppInstallStatus variable to Warning when one or more applications, or a required dependency, did not install because it did not meet a requirement. When you set this variable to True, and the task sequence sets _TSAppInstallStatus to Warning, the outcome is an error. A value of False is the default behavior.
SMSTSMPListRequestTimeoutEnabled Use this variable to enable repeated MPList requests to refresh the client if the client is not on the intranet.
By default, this variable is set to True. When clients are on the internet, you can set this variable to False to avoid unnecessary delays. This variable is applicable only to the Install Application and Install Software Updates task sequence steps.
SMSTSMPListRequestTimeout Specify how many milliseconds a task sequence waits before it retries to install an application after it fails to retrieve the management point list from location services. By default, the task sequence waits 60000 milliseconds (60 seconds) before it retries the step, and retries up to three times.

Install Software Updates

For more information, see Install Software Updates.

Details

Action Variable Name

(input)
Description
SMSInstallUpdateTarget

(input)
Specifies whether to install all updates or only mandatory updates.

Valid values:

All

Mandatory
SMSTSSoftwareUpdateScanTimeout Control the timeout for the software updates scan during this step. For example, increase the value if you expect numerous updates during the scan. The default value is 1800 seconds (30 minutes). The variable value is set in seconds.
SMSTSWaitForSecondReboot This optional task sequence variable controls client behavior when a software update installation requires two restarts. Set this variable before this step to prevent a task sequence from failing because of a second restart from software update installation.

Set the SMSTSWaitForSecondReboot value in seconds to specify how long the task sequence pauses on this step while the computer restarts. Allow sufficient time in case there is a second restart.
For example, if you set SMSTSWaitForSecondReboot to 600, the task sequence pauses for 10 minutes after a restart before additional steps run. This variable is useful when a single Install Software Updates task sequence step installs hundreds of software updates.
SMSTSMPListRequestTimeoutEnabled Use this variable to enable repeated MPList requests to refresh the client if the client is not on the intranet.
By default, this variable is set to True. When clients are on the internet, you can set this variable to False to avoid unnecessary delays. This variable is applicable only to the Install Application and Install Software Updates task sequence steps.
SMSTSMPListRequestTimeout Specify how many milliseconds a task sequence waits before it retries to install a software update after it fails to retrieve the management point list from location services. By default, the task sequence waits 60000 milliseconds (60 seconds) before it retries the step, and retries up to three times.

Join Domain or Workgroup

For more information, see Join Domain or Workgroup.

Details

Action Variable Name Description
OSDJoinAccount

(input)
Specifies the account that is used by the destination computer to join the Active Directory domain. This variable is required when joining a domain.
OSDJoinDomainName

(input)
Specifies the name of an Active Directory domain the destination computer joins. The length of the domain name must be between 1 and 255 characters.
OSDJoinDomainOUName

(input)
Specifies the RFC 1779 format name of the organizational unit (OU) that the destination computer joins. If specified, the value must contain the full path. The length of the OU name must be between 0 and 32,767 characters. This value is not set if the OSDJoinType variable is set to 1 (join workgroup).

Example:

LDAP://OU=MyOu,DC=MyDom,DC=MyCompany,DC=com
OSDJoinPassword

(input)
Specifies the network password that the destination computer uses to join the Active Directory domain. If the task sequence environment does not include this variable, then Windows Setup tries a blank password. If the variable OSDJoinType variable is set to 0 (join domain), this value is required.
OSDJoinSkipReboot

(input)
Specifies whether to skip restarting after the destination computer joins the domain or workgroup.

Valid values:

true

false
OSDJoinType

(input)
Specifies whether the destination computer joins a Windows domain or a workgroup. To join the destination computer to a Windows domain, specify 0. To join the destination computer to a workgroup, specify 1.

Valid values:

0

1
OSDJoinWorkgroupName

(input)
Specifies the name of a workgroup that the destination computer joins. The length of the workgroup name must be between 1 and 32 characters.

Example:

Accounting

Prepare Windows for Capture

For more information, see Prepare Windows for Capture.

Details

Action Variable Name Description
OSDBuildStorageDriverList

(input)
Specifies whether Sysprep builds a mass storage device driver list. This setting applies to only Windows XP and Windows Server 2003. This variable populates the [SysprepMassStorage] section of sysprep.inf with information on all the mass storage drivers that are supported by the image to be captured.

Valid values:

true

false (default)
OSDKeepActivation

(input)
Specifies whether sysprep resets the product activation flag.

Valid values:

true

false (default)
OSDTargetSystemRoot

(output)
Specifies the path to the Windows directory of the installed operating system on the reference computer. This operating system is verified as being a supported operating system for capture by Configuration Manager.

Release State Store

For more information, see Release State Store.

Details

Action Variable Name Description
OSDStateStorePath

(input)
The UNC or local pathname to the location from which the user state is restored. This value is used by both the Capture User State task sequence action and the Restore User State task sequence action.

Request State Store

For more information, see Release State Store.

Details

Action Variable Name Description
OSDStateFallbackToNAA

(input)
When the computer account fails to connect to the state migration point, this variable specifies whether the task sequence falls back to use the network access account (NAA).

Valid values:

true

false (default)
OSDStateSMPRetryCount

(input)
Specifies the number of times that the task sequence step tries to find a state migration point before the step fails. The specified count must be between 0 and 600.
OSDStateSMPRetryTime

(input)
Specifies the number of seconds that the task sequence step waits between retry attempts. The number of seconds can be a maximum of 30 characters.
OSDStateStorePath

(output)
The UNC path to the folder on the state migration point where the user state is stored.

Restart Computer

For more information, see Restart Computer.

Details

Action Variable Name Description
SMSRebootMessage

(input)
Specifies the message to be displayed to users before restarting the destination computer. If this variable is not set, the default message text is displayed. The specified message must not exceed 512 characters.

Example:

Save your work before the computer restarts.
SMSRebootTimeout

(input)
Specifies the number of seconds that the warning is displayed to the user before the computer restarts. Specify zero seconds to indicate that no reboot message is displayed.

Examples:

0 (default)

60

Restore User State

For more information, see Restore User State.

Details

Action Variable Name Description
OSDStateStorePath

(input)
The UNC or local pathname of the folder from which the user state is restored.
OSDMigrateContinueOnRestore

(input)
Continue the process, even if USMT cannot restore some files.

Valid values:

true (default)

false
OSDMigrateEnableVerboseLogging

(input)
Enables verbose logging for the USMT tool. This value is required by the action.

Valid values:

true

false (default)
OSDMigrateLocalAccounts

(input)
Specifies whether the local computer account is restored.

Valid values:

true

false (default)
OSDMigrateLocalAccountPassword

(input)
If the OSDMigrateLocalAccounts variable is "true," this variable must contain the password assigned to all migrated local accounts. USMT assigns the same password to all migrated local accounts. Consider this password as temporary, and change it later by some other method.
OSDMigrateAdditionalRestoreOptions

(input)
Specifies additional user state migration tool (USMT) command-line options that are used when restoring the user state. The additional options are specified in the form of a string that is appended to the automatically generated USMT command line. The USMT options specified with this task sequence variable are not validated for accuracy prior to running the task sequence.
_OSDMigrateUsmtRestorePackageID

(input)
Specifies the package ID of the Configuration Manager package that contains the USMT files. This variable is required.

Run Command Line

For more information, see Run Command Line.

Details

Action Variable Name Description
SMSTSDisableWow64Redirection

(input)
By default on a 64-bit operating system, the task sequence locates and runs the program in the command line using the WOW64 file system redirector. This behavior allows the command to find 32-bit versions of operating system programs and DLLs. Setting this variable to true disables the use of the WOW64 file system redirector. The command finds native 64-bit versions of operating system programs and DLLs. This variable has no effect when running on a 32-bit operating system.
WorkingDirectory

(input)
Specifies the starting directory for a command-line action. The specified directory name must not exceed 255 characters.

Examples:

- C:\
- %SystemRoot%
SMSTSRunCommandLineUserName

(input)
Specifies the account by which the command line is run. The value is a string of the form username or domain\username.
SMSTSRunCommandLinePassword

(input)
Specifies the password for the account specified by the SMSTSRunCommandLineUserName variable.

Set Dynamic Variables

For more information, see Set Dynamic Variables.

Details

Action Variable Name

(input)
Description
_SMSTSMake Specifies the make of the computer.
_SMSTSModel Specifies the model of the computer.
_SMSTSMacAddresses Specifies the MAC addresses used by the computer.
_SMSTSIPAddresses Specifies the IP addresses used by the computer.
_SMSTSSerialNumber Specifies the serial number of the computer.
_SMSTSAssetTag Specifies the asset tag for the computer.
_SMSTSUUID Specifies the UUID of the computer.
_SMSTSDefaultGateways Specifies the default gateways used by the computer.

Setup Windows and ConfigMgr

For more information, see Setup Windows and ConfigMgr.

Details

Action Variable Name

(input)
Description
SMSClientInstallProperties

(input)
Specifies the client installation properties that are used when installing the Configuration Manager client.

Upgrade Operating System

For more information, see Upgrade Operating System.

Details

Action Variable Name

(input)
Description
OSDSetupAdditionalUpgradeOptions

(input)
Specifies the additional command-line options that are added to Windows Setup during a Windows 10 upgrade. The task sequence does not verify the command-line options.

For more information, see Windows Setup Command-Line Options.