> For the complete documentation index, see [llms.txt](https://documentation.2pintsoftware.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://documentation.2pintsoftware.com/deployr/task-sequence-variables.md).

# 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

<table><thead><tr><th width="251.800048828125">Variable</th><th width="322.400146484375">Description</th><th>Options</th></tr></thead><tbody><tr><td>_DEPLOYRLOGS</td><td>DeployR log location<br>Example Value: X:\_2P\logs</td><td>Set by DeployR</td></tr><tr><td>_ENCRYPT</td><td>true</td><td>Set by DeployR</td></tr><tr><td>_LASTACTIONSUCCEEDED</td><td>TRUE/FALSE</td><td>Set by step at the end of step</td></tr><tr><td>_LASTACTIONRETURNCODE</td><td>0 (Success) or another Number</td><td>Set by step at the end of step</td></tr><tr><td>_SEQUENCESTATE</td><td>Current task sequence state<br>Example Value: {"f4b57e76-184a-47c4-8631-eae8cf7f4f8d":"Success","ba87d732-5df3-44c2-a98b-258123f62370":"InProgress"}</td><td>Set by DeployR</td></tr><tr><td>_SMSTSLOGPATH</td><td>X:\Windows\TEMP</td><td>Set by DeployR</td></tr><tr><td>_TSIDENTIFIER</td><td>6f40f996-8db5-49f3-b8ca-8671ea9edf5a</td><td>Set by DeployR</td></tr><tr><td>_UIPORT</td><td>7283</td><td>Set by DeployR</td></tr><tr><td>_UISOCKET</td><td>X:\_2P\state\ui.socket</td><td>Set by DeployR</td></tr><tr><td>_UITSDEBUG</td><td>TRUE/FALSE</td><td>Set by running in Debug mode</td></tr><tr><td>_UITSLIST</td><td>GUIDs of task sequences</td><td>Set by DeployR</td></tr><tr><td>_VARIABLEPORT</td><td>7282</td><td>Set by DeployR</td></tr><tr><td>_VARIABLESOCKET</td><td>X:\_2P\state\variables.socket</td><td>Set by DeployR</td></tr><tr><td>ANONYMOUS</td><td>TRUE</td><td>Set by DeployR</td></tr><tr><td>ARCHITECTURE</td><td>x64</td><td>Set by DeployR Gather</td></tr><tr><td>ANONYMOUS</td><td>TRUE</td><td>Set by DeployR</td></tr><tr><td>ASSETTAG</td><td>4102-7492-9856-5816-5097-6344-26</td><td>Set by DeployR Gather</td></tr><tr><td>BASEBOARDPRODUCT</td><td>Virtual Machine</td><td>Set by DeployR Gather</td></tr><tr><td>CHASSIS</td><td>Desktop</td><td>Set by DeployR Gather</td></tr><tr><td>CSPVERSION</td><td>Hyper-V UEFI Release v4.1</td><td>Set by DeployR Gather</td></tr><tr><td>DEBUG</td><td>TRUE/FALSE</td><td>Set by BootStrap Config</td></tr><tr><td>DEFAULTGATEWAY001</td><td>192.168.10.1</td><td>Set by DeployR Gather</td></tr><tr><td>DEPLOYR_PROCESS</td><td>This is set to the process ID of the parent DeployR client shell process. By itself that is not useful. However, PSADT (4.2 and above) will look for this value so that wrapped app installers will behave as expected when run inside a DeployR task sequence (thanks to Dan Cunningham).</td><td>This will be set by the DeployR client shell and can be seen in any task sequence step. </td></tr><tr><td>DEPLOYRAUTHDEVICEFLOW</td><td>TRUE/FALSE</td><td>Set by DeployR</td></tr><tr><td>DEPLOYRAUTHWINDOWSAUTHENTICATION</td><td>TRUE/FALSE</td><td>Set by DeployR</td></tr><tr><td>DEPLOYRCLIENTVERSION</td><td>The DeployR client version currently running in the task sequence, which was included in the boot media.</td><td>Set by DeployR</td></tr><tr><td>DEPLOYRCONTENT</td><td>X:\_2P\content</td><td>Set by DeployR</td></tr><tr><td>DEPLOYRHOST</td><td>https://deployr.corp.viamonstra.com:7281</td><td>Set by DeployR</td></tr><tr><td>DEPLOYRROOT</td><td>X:\_2P</td><td>Set by DeployR</td></tr><tr><td>DEPLOYRSERVERVERSION</td><td>The DeployR server version, the client version and server version should match, if not, regenerate the boot media.</td><td>Set by DeployR</td></tr><tr><td>DEPLOYRSTATE</td><td>X:\_2P\state</td><td>Set by DeployR</td></tr><tr><td>DEPLOYRTASKSEQUENCEID</td><td>00000002-0000-0000-0000-000000000001</td><td>Set by DeployR once TS selected</td></tr><tr><td>DEPLOYRTASKSEQUENCENAME</td><td>Name of the TS currently running</td><td>Set by DeployR once TS selected</td></tr><tr><td>DEPLOYRTASKSEQUENCEVERSIONID</td><td>8fd68264-2d37-4000-55ab-08dca0511f05</td><td>Set by DeployR once TS selected</td></tr><tr><td>DEPLOYRTASKSEQUENCEVERSIONNO</td><td>1</td><td>Set by DeployR once TS selected</td></tr><tr><td>DEPLOYRTOKEN</td><td>String of the Token used for communications</td><td>Set by DeployR after Auth of the TS</td></tr><tr><td>DEPLOYRUSER</td><td>User or Method for Auth of the TS</td><td>Set by DeployR after Auth of the TS</td></tr><tr><td>DEPLOYRUSERROLE</td><td>When using Entra, a roll will be associated with the user</td><td>Set by DeployR after Auth of the TS</td></tr><tr><td>DEPLOYRUSERROLES001</td><td>Sevearl Roles can be assigned to a user, they will show up in a list here</td><td>Set by DeployR after Auth of the TS</td></tr><tr><td>DEVELOPMENTMODE</td><td>TRUE/FALSE</td><td>Set by running in Dev mode</td></tr><tr><td>FINISHACTION</td><td>Tell the Task Sequence what to do after the TS finishes - Default is NOT Set, and does nothing.</td><td>reboot, shutdown, logoff, reseal</td></tr><tr><td>GATHERLOCALONLY</td><td>TRUE</td><td></td></tr><tr><td>INLINE</td><td>TRUE</td><td>Set by DeployR Step</td></tr><tr><td>INPUTLOCALE</td><td>language code, ex: en-US<br>Used by Apply OS step</td><td>Set by step: Set Windows settings</td></tr><tr><td>INOOBE</td><td>TRUE/FALSE</td><td>Set by DeployR Gather</td></tr><tr><td>IPADDRESS001</td><td>192.168.10.137</td><td>Set by DeployR Gather</td></tr><tr><td>IPADDRESS002</td><td>fe80::ef31:32ca:d547:ca8a</td><td>Set by DeployR Gather</td></tr><tr><td>ISDESKTOP</td><td>TRUE/FALSE</td><td>Set by DeployR Gather</td></tr><tr><td>ISLAPTOP</td><td>TRUE/FALSE</td><td>Set by DeployR Gather</td></tr><tr><td>ISSERVER</td><td>TRUE/FALSE</td><td>Set by DeployR Gather</td></tr><tr><td>ISSERVERCOREOS</td><td>TRUE/FALSE</td><td>Set by DeployR Gather</td></tr><tr><td>ISSERVEROS</td><td>TRUE/FALSE</td><td>Set by DeployR Gather</td></tr><tr><td>ISSFF</td><td>TRUE/FALSE</td><td>Set by DeployR Gather</td></tr><tr><td>ISTABLET</td><td>TRUE/FALSE</td><td>Set by DeployR Gather</td></tr><tr><td>ISUEFI</td><td>TRUE/FALSE</td><td>Set by DeployR Gather</td></tr><tr><td>ISUSBMEDIA</td><td>TRUE/FALSE</td><td>Set by DeployR Gather</td></tr><tr><td>ISVM</td><td>TRUE/FALSE</td><td>Set by DeployR Gather</td></tr><tr><td>ISWINDOWSPE</td><td>TRUE/FALSE</td><td>Set by DeployR Gather</td></tr><tr><td>MACADDRESS001</td><td>00:15:5D:A6:3A:64</td><td>Set by DeployR Gather</td></tr><tr><td>MAKE</td><td>Microsoft Corporation</td><td>Set by DeployR Gather</td></tr><tr><td>MAKEALIAS</td><td>Microsoft</td><td>Set by DeployR Gather</td></tr><tr><td>MANUFACTURER</td><td>Microsoft Corporation</td><td>Set by DeployR Gather</td></tr><tr><td>MEMORY</td><td>4095</td><td>Set by DeployR Gather</td></tr><tr><td>MODEL</td><td>Virtual Machine</td><td>Set by DeployR Gather</td></tr><tr><td>MODELALIAS</td><td>Virtual Machine</td><td>Set by DeployR Gather</td></tr><tr><td>OSCURRENTBUILD</td><td>26100</td><td>Set by DeployR Gather</td></tr><tr><td>OSCURRENTVERSION</td><td>10.0.26100</td><td>Set by DeployR Gather</td></tr><tr><td>OSDSTARTTIME</td><td>Time Stamp</td><td>Set by step: Set Windows settings</td></tr><tr><td>OSSKU</td><td>Ultimate Edition</td><td>Set by DeployR Gather</td></tr><tr><td>OSVERSION</td><td>WinPE</td><td>Set by DeployR Gather</td></tr><tr><td>PEERING</td><td>Enable or Disable BranchCache P2P during Task Sequence. NoCache will use BranchCache to download but will not store the content in the BranchCache cache. Default = TRUE</td><td>Set via Variable TRUE/FALSE/<br>NoCache or Set by step: Set Windows settings</td></tr><tr><td>PROCESSORSPEED</td><td>1608</td><td>Set by DeployR Gather</td></tr><tr><td>PRODUCT</td><td>Virtual Machine</td><td>Set by DeployR Gather</td></tr><tr><td>PRODUCTKEY</td><td>YOUR MAK KEY<br>Example: XX123-NMH47-7TTHJ-W3FW7-8HV2C</td><td>Set by User using script or set variable step</td></tr><tr><td>PROGRESSTIMEOUT</td><td>Default 300, modify to have the final Progress UI close sooner or later</td><td>Set by variable at anytime or Set by step: Set Windows settings</td></tr><tr><td>PSMODULEPATH</td><td>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\</td><td>Set by DeployR</td></tr><tr><td>SCRIPT</td><td> </td><td>Set by DeployR Step</td></tr><tr><td>SERIALNUMBER</td><td>4102-7492-9856-5816-5097-6344-26</td><td>Set by DeployR Gather</td></tr><tr><td>SETUPMODE</td><td>UEFI</td><td>Set by DeployR Gather</td></tr><tr><td>SUPPORTSSLAT</td><td>FALSE</td><td>Set by DeployR Gather</td></tr><tr><td>SYSTEMALIAS</td><td>Hyper-V UEFI Release v4.1</td><td>Set by DeployR Gather</td></tr><tr><td>SYSTEMLOCALE</td><td>language code, ex: en-US<br>Used by Apply OS step</td><td>Set by step: Set Windows settings</td></tr><tr><td>SYSTEMSKU</td><td>None</td><td>Set by DeployR Gather</td></tr><tr><td>TIMEZONE</td><td>MS Name for TimeZone, ex: "Central Standard Time"<br>Used by Apply OS step</td><td>Set by step: Set Windows settings</td></tr><tr><td>TSID</td><td>The ID (GUID) of the task sequence to be executed.  An example:<br>00000002-0000-0000-0000-000000000001</td><td>Set by DeployR</td></tr><tr><td>UILANGUAGE</td><td>language code, ex: en-US<br>Used by Apply OS step</td><td>Set by step: Set Windows settings</td></tr><tr><td>USERLOCALE</td><td>language code, ex: en-US<br>Used by Apply OS step</td><td>Set by step: Set Windows settings</td></tr><tr><td>UUID</td><td>B4F64D47-CA2D-4030-AB3F-400E256419B1</td><td>Set by DeployR</td></tr><tr><td>WINPEBUILDINFO</td><td>The Windows build number of WinPE. Ex: 10.0.26100.8737</td><td>Set By DeployR</td></tr></tbody></table>

### From running Task Sequence

To view the current task sequence variables, you can launch PowerShell using the menu in the DeployR progress UI, then running a command to output them to the console.  The Menu is available by clicking on the 2 parallel lines, which resembles an equals sign (=), just past the "Close" button.

```powershell
Get-ChildItem -Path tsenv:
```

<figure><img src="https://content.gitbook.com/content/5H9jaYPEartpXiTyVZvm/blobs/BLEa1Qm4YWqnC2hFpTHF/image.png" alt=""><figcaption></figcaption></figure>

<figure><img src="https://content.gitbook.com/content/5H9jaYPEartpXiTyVZvm/blobs/u4o3gx9JeoXzcD0Cm7WV/image.png" alt=""><figcaption></figcaption></figure>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://documentation.2pintsoftware.com/deployr/task-sequence-variables.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.