Task Sequence Variables
This is a reference guide for the task sequence variables that are supported by DeployR. These can be used in the task sequence for step definitions, conditions, and other related tasks. Task sequence variables that start with an underscore ("_") are read only variables and cannot be set.
To see examples of how to create Task Sequence Variables and leverage them with PowerShell, see the PowerShell Modules section, Scripting for OSD
Below you will see several variables that are created in a few methods, either by DeployR Gather Script which is called before the start of the Task Sequence, we've added example values in the description field for those, or the DeployR TS itself, as it builds DeployR environment information. Other variables outside of those two processes can be used to toggle settings or task sequence behavior, such as PEERING or FINISHACTION.
Task Sequence Variable List
_DEPLOYRLOGS
DeployR log location Example Value: X:\_2P\logs
Set by DeployR
_SEQUENCESTATE
Current task sequence state Example Value: {"f4b57e76-184a-47c4-8631-eae8cf7f4f8d":"Success","ba87d732-5df3-44c2-a98b-258123f62370":"InProgress"}
Set by DeployR
_SMSTSLOGPATH
X:\Windows\TEMP
Set by DeployR
_TSIDENTIFIER
6f40f996-8db5-49f3-b8ca-8671ea9edf5a
Set by DeployR
_UIPORT
7283
Set by DeployR
_UISOCKET
X:\_2P\state\ui.socket
Set by DeployR
_VARIABLEPORT
7282
Set by DeployR
_VARIABLESOCKET
X:\_2P\state\variables.socket
Set by DeployR
ANONYMOUS
TRUE
Set by DeployR
ARCHITECTURE
x64
Set by DeployR Gather
ASSETTAG
4102-7492-9856-5816-5097-6344-26
Set by DeployR Gather
BASEBOARDPRODUCT
Virtual Machine
Set by DeployR Gather
CHASSIS
Desktop
Set by DeployR Gather
CSPVERSION
Hyper-V UEFI Release v4.1
Set by DeployR Gather
CUSTOM
TRUE
DEBUG
TRUE
Set by BootStrap Config
DEFAULTGATEWAY001
192.168.10.1
Set by DeployR Gather
DEPLOYRCONTENT
X:\_2P\content
Set by DeployR
DEPLOYRHOST
https://deployr.corp.viamonstra.com:7281
Set by DeployR
DEPLOYRROOT
X:\_2P
Set by DeployR
DEPLOYRSTATE
X:\_2P\state
Set by DeployR
DEPLOYRTASKSEQUENCEID
00000002-0000-0000-0000-000000000001
Set by DeployR
DEPLOYRTASKSEQUENCEVERSIONID
8fd68264-2d37-4000-55ab-08dca0511f05
Set by DeployR
DEPLOYRTASKSEQUENCEVERSIONNO
1
Set by DeployR
FINISHACTION
Tell the Task Sequence what to do after the TS finishes - Default is NOT Set, and does nothing.
reboot, shutdown, logoff, reseal
GATHERLOCALONLY
TRUE
INLINE
TRUE
Set by DeployR Step
IPADDRESS001
192.168.10.137
Set by DeployR Gather
IPADDRESS002
fe80::ef31:32ca:d547:ca8a
Set by DeployR Gather
ISDESKTOP
TRUE
Set by DeployR Gather
ISLAPTOP
FALSE
Set by DeployR Gather
ISSERVER
FALSE
Set by DeployR Gather
ISSERVERCOREOS
FALSE
Set by DeployR Gather
ISSERVEROS
FALSE
Set by DeployR Gather
ISSFF
FALSE
Set by DeployR Gather
ISTABLET
FALSE
Set by DeployR Gather
ISUEFI
TRUE
Set by DeployR Gather
ISVM
TRUE
Set by DeployR Gather
MACADDRESS001
00:15:5D:A6:3A:64
Set by DeployR Gather
MAKE
Microsoft Corporation
Set by DeployR Gather
MAKEALIAS
Microsoft
Set by DeployR Gather
MANUFACTURER
Microsoft Corporation
Set by DeployR Gather
MEMORY
4095
Set by DeployR Gather
MODEL
Virtual Machine
Set by DeployR Gather
MODELALIAS
Virtual Machine
Set by DeployR Gather
OSCURRENTBUILD
26100
Set by DeployR Gather
OSCURRENTVERSION
10.0.26100
Set by DeployR Gather
OSSKU
Ultimate Edition
Set by DeployR Gather
OSVERSION
WinPE
Set by DeployR Gather
PEERING
Enable or Disable BranchCache P2P during Task Sequence. Default = TRUE
TRUE/FALSE
PROCESSORSPEED
1608
Set by DeployR Gather
PRODUCT
Virtual Machine
Set by DeployR Gather
PSMODULEPATH
X:\Program Files\PowerShell\Modules;x:\program files\powershell\7\Modules;X:\Program Files\WindowsPowerShell\Modules;X:\Windows\system32\WindowsPowerShell\v1.0\Modules;X:\Program Files\PowerShell\;X:\Program Files\PowerShell\7\;X:\Windows\system32\config\systemprofile\Documents\PowerShell\Modules\
Set by DeployR
SCRIPT
Set by DeployR Step
SERIALNUMBER
4102-7492-9856-5816-5097-6344-26
Set by DeployR Gather
SETUPMODE
UEFI
Set by DeployR Gather
SUPPORTSSLAT
FALSE
Set by DeployR Gather
SYSTEMALIAS
Hyper-V UEFI Release v4.1
Set by DeployR Gather
SYSTEMSKU
None
Set by DeployR Gather
TSID
The ID (GUID) of the task sequence to be executed. An example: 00000002-0000-0000-0000-000000000001
Set by DeployR
UUID
B4F64D47-CA2D-4030-AB3F-400E256419B1
Set by DeployR
Last updated