[Feature] Provide a way to only enable SuppressRebootPassThru when running in a Task Sequence

[DanGough]

Summary of the new feature / enhancement

You would normally want 3010 exit codes to be reported to the deployment system so that they can advise the user a reboot is required. This is fine since those requests can be ignored and acted upon later.

However a task sequence reboots instantly when it gets a 3010 from an application install.

It's not possible to change the SuppressRebootPassThru property of the session after it's been opened, nor is there a public command for determining if we're in a TS that we can use to work out if SuppressRebootPassThru should be enabled before opening the session.

Proposed technical implementation details (optional)

So one way to make this easier would be to change this to a read/write property. This would still need some custom code in the template to achieve the desired outcome, so it would be nicer still if there was a dedicated switch for it, either by making SuppressRebootPassThru an enum to support a 3rd option, or a new switch e.g. -SuppressRebootPassThruInTaskSequence.

For now, one way of achieving this is to place this code before Exit-ADTSession in the current template:

if ($RunningTaskSequence -and $adtSession.GetExitCode() -eq '3010')
{
    Write-ADTLogEntry -Message 'Supressing reboot due to running task sequence.'
    $adtSession.SetExitCode(0)
}

You could also modify the template to set SuppressRebootPassThru dependent on if we are in a TS (this is the method PSADT uses to set the $RunningTaskSequence variable):

SuppressRebootPassThru = (!![System.Type]::GetTypeFromProgID('Microsoft.SMS.TSEnvironment'))

[mjr4077au]

Just adding that testing whether the exit code is 3010 is not the best way to do this as you might have defined your own reboot codes, etc. The best way is by calling the GetDeploymentStatus() method on the DeploymentSession object:

PS C:\Repos\PSAppDeployToolkit\src> Import-Module .\PSAppDeployToolkit
PS C:\Repos\PSAppDeployToolkit\src> $adtSession = Open-ADTSession -PassThru 6>$null
PS C:\Repos\PSAppDeployToolkit\src> $adtSession.GetDeploymentStatus()
Complete
PS C:\Repos\PSAppDeployToolkit\src> $adtSession.SetExitCode(3010)
PS C:\Repos\PSAppDeployToolkit\src> $adtSession.GetDeploymentStatus()
RestartRequired
PS C:\Repos\PSAppDeployToolkit\src>

[mjr4077au]

Following some chatter, will move this over to the website repo for documentation purpuses rather than a programmed solution.