1 of 7

AutopilotOOBE

About

AutopilotOOBE is used to manually register a Device in Intune Autopilot. It is intended to run in OOBE (Out of Box Experience) by Client Support as a "friendly" method to use Get-WindowsAutopilotInfo

PowerShell Gallery

AutopilotOOBE is published in the PowerShell Gallery

GitHub

AutopilotOOBE code can be cloned from a GitHub Repository

Usage

OOBE

The easiest way to use AutopilotOOBE is in OOBE (Out of Box Experience). Open a command prompt by pressing Shift + F10

Parameters

AutopilotOOBE should be customized for your Client Support staff so you can ensure compliance. When testing Parameters, you can safely do this in Windows (or OOBE) on a Device that has not been Autopilot Registered yet. A Virtual Machine works quite well in accomplishing this task

Title

Start by adding a Title for your Organization

Reference

Get to know

Configuration Json

Every time AutopilotOOBE is run, it automatically creates a Configuration Json in the following location, so once you have your Parameters sorted out, save the file

OSDeploy.AutopilotOOBE.json

Here is what the contents looks like

Deployment

When you are ready to deploy your AutopilotOOBE Configuration Json, there are three methods to do this

Command Line

I'd advise against this as this is quite a bit to type in, but it is absolutely possible. Good Luck!

CustomProfile

You can easily send me your Configuration Json and I can add it to the AutopilotOOBE PowerShell Module. Once it is published, you will be able to use it right away as long as you install the latest AutopilotOOBE PowerShell Module

In OOBE, you simply add your CustomProfile name as an AutopilotOOBE parameter and it will import the CustomProfile to your ProgramData. This will ensure that any subsequent execution of AutopilotOOBE is customized for your Organization

Configuration Json Staging

If you are going to image the Device , then you can also save the Configuration Json in WinPE after your Operating System has been expanded to the Hard Disk. This will ensure that AutopilotOOBE will always be executed with your configuration

OSDHelp AutopilotOOBE

An example on how to do this is in OSDHelp which is part of the OSD PowerShell Module

OSDCloud

If you are using OSDCloud, you can apply the Configuration Json in a method similar to the script below, after Start-OSDCloud has completed

Autopilot CMD

To make things easier for my Support Staff, I like to drop an Autopilot CMD file on the OS during Deployment so they don't need to even think about Parameters or Configuration Json files

OSDHelp AutopilotOOBE

You can use OSDHelp to get the proper PowerShell code for creating an Autopilot.cmd with whatever settings you want

[CmdletBinding()]
param (
    [Parameter(ValueFromPipeline = $true)]
    [string]$CustomProfile,

    [ValidateSet (
        'GroupTag',
        'AddToGroup',
        'AssignedUser',
        'AssignedComputerName',
        'PostAction',
        'Assign'
    )]
    [string[]]$Disabled,

    [ValidateSet (
        'GroupTag',
        'AddToGroup',
        'AssignedUser',
        'AssignedComputerName',
        'PostAction',
        'Assign',
        'Register',
        'Run',
        'Docs'
    )]
    [string[]]$Hidden,

    [string]$AddToGroup,
    [string[]]$AddToGroupOptions,
    [switch]$Assign,
    [string]$AssignedUser,
    [string]$AssignedUserExample = '[email protected]',
    [string]$AssignedComputerName,
    [string]$AssignedComputerNameExample = 'Azure AD Join Only',
    [string]$GroupTag,
    [string[]]$GroupTagOptions,
    [ValidateSet (
        'Quit',
        'Restart',
        'Shutdown',
        'Sysprep',
        'SysprepReboot',
        'SysprepShutdown',
        'GeneralizeReboot',
        'GeneralizeShutdown'
    )]
    [string]$PostAction = 'Quit',
    [ValidateSet (
        'CommandPrompt',
        'PowerShell',
        'PowerShellISE',
        'WindowsExplorer',
        'WindowsSettings',
        'NetworkingWireless',
        'Restart',
        'Shutdown',
        'Sysprep',
        'SysprepReboot',
        'SysprepShutdown',
        'SysprepAudit',
        'EventViewer',
        'GetAutopilotDiagnostics',
        'MDMDiag',
        'MDMDiagAutopilot',
        'MDMDiagAutopilotTPM'
    )]
    [string]$Run = 'PowerShell',
    [string]$Docs,
    [string]$Title = 'Autopilot Manual Registration'
)

Deployment

When you are ready to deploy your AutopilotOOBE Configuration Json, there are three methods to do this

Command Line

I'd advise against this as this is quite a bit to type in, but it is absolutely possible. Good Luck!

$Params = @{
    Title = 'OSDeploy Autopilot Registration'
    GroupTag = 'Enterprise'
    GroupTagOptions = 'Development','Enterprise'
    Hidden = 'AddToGroup','AssignedComputerName','AssignedUser','PostAction'
    Assign = $true
    Run = 'NetworkingWireless'
    Docs = 'https://autopilotoobe.osdeploy.com/'
}
AutopilotOOBE @Params

CustomProfile

Configuration Json Staging

OSDHelp AutopilotOOBE

An example on how to do this is in OSDHelp which is part of the OSD PowerShell Module

OSDCloud

If you are using OSDCloud, you can apply the Configuration Json in a method similar to the script below, after Start-OSDCloud has completed

Sponsors

#=======================================================================
#   OS: Params and Start-OSDCloud
#=======================================================================
$Params = @{
    OSBuild = "21H1"
    OSEdition = "Pro"
    OSLanguage = "en-us"
    OSLicense = "Retail"
    SkipAutopilot = $true
    SkipODT = $true
}
Start-OSDCloud @Params



#=======================================================================
#   PostOS: AutopilotOOBE Staging
#=======================================================================
$AutopilotOOBEJson = @'
{
    "Assign":  {
                   "IsPresent":  true
               },
    "GroupTag":  "Enterprise",
    "GroupTagOptions":  [
                            "Development",
                            "Enterprise"
                        ],
    "Hidden":  [
                   "AddToGroup",
                   "AssignedComputerName",
                   "AssignedUser",
                   "PostAction"
               ],
    "PostAction":  "Quit",
    "Run":  "NetworkingWireless",
    "Docs":  "https://autopilotoobe.osdeploy.com/",
    "Title":  "OSDeploy Autopilot Registration"
}
'@
$AutopilotOOBEJson | Out-File -FilePath "C:\ProgramData\OSDeploy\OSDeploy.AutopilotOOBE.

#=======================================================================
#   OS: Params and Start-OSDCloud
#=======================================================================
$Params = @{
    OSBuild = "21H1"
    OSEdition = "Pro"
    OSLanguage = "en-us"
    OSLicense = "Retail"
    SkipAutopilot = $true
    SkipODT = $true
}
Start-OSDCloud @Params



#=======================================================================
#   PostOS: AutopilotOOBE Staging
#=======================================================================
$AutopilotOOBEJson = @'
{
    "Assign":  {
                   "IsPresent":  true
               },
    "GroupTag":  "Enterprise",
    "GroupTagOptions":  [
                            "Development",
                            "Enterprise"
                        ],
    "Hidden":  [
                   "AddToGroup",
                   "AssignedComputerName",
                   "AssignedUser",
                   "PostAction"
               ],
    "PostAction":  "Quit",
    "Run":  "NetworkingWireless",
    "Docs":  "https://autopilotoobe.osdeploy.com/",
    "Title":  "OSDeploy Autopilot Registration"
}
'@
$AutopilotOOBEJson | Out-File -FilePath "C:\ProgramData\OSDeploy\OSDeploy.AutopilotOOBE.