Show-ADTInstallationRestartPrompt

SYNOPSIS

Displays a restart prompt with a countdown to a forced restart.

SYNTAX

Countdown (Default)

Show-ADTInstallationRestartPrompt [-CountdownSeconds <UInt32>] [-CountdownNoHideSeconds <UInt32>] [-NotTopMost]
 -Title <String> -Subtitle <String> [<CommonParameters>]

NoCountdown

Show-ADTInstallationRestartPrompt [-NoCountdown] [-NotTopMost] -Title <String> -Subtitle <String>
 [<CommonParameters>]

SilentRestart

Show-ADTInstallationRestartPrompt [-SilentRestart] [-SilentCountdownSeconds <UInt32>] [-NotTopMost]
 -Title <String> -Subtitle <String> [<CommonParameters>]

DESCRIPTION

Displays a restart prompt with a countdown to a forced restart. The prompt can be customized with a title, countdown duration, and whether it should be topmost. It also supports silent mode where the restart can be triggered without user interaction.

EXAMPLES

EXAMPLE 1

Show-ADTInstallationRestartPrompt -NoCountdown

Displays a restart prompt without a countdown.

EXAMPLE 2

Show-ADTInstallationRestartPrompt -CountdownSeconds 300

Displays a restart prompt with a 300-second countdown.

EXAMPLE 3

Show-ADTInstallationRestartPrompt -CountdownSeconds 600 -CountdownNoHideSeconds 60

Displays a restart prompt with a 600-second countdown and triggers a silent restart with a 60-second countdown in silent mode.

PARAMETERS

-NoCountdown

Specifies whether the user should receive a prompt to immediately restart their workstation.

Type: SwitchParameter
Parameter Sets: NoCountdown
Aliases:

Required: True
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-CountdownSeconds

Specifies the number of seconds to display the restart prompt. Default: 60

Type: UInt32
Parameter Sets: Countdown
Aliases:

Required: False
Position: Named
Default value: 60
Accept pipeline input: False
Accept wildcard characters: False

-CountdownNoHideSeconds

Specifies the number of seconds to display the restart prompt without allowing the window to be hidden. Default: 30

Type: UInt32
Parameter Sets: Countdown
Aliases:

Required: False
Position: Named
Default value: 30
Accept pipeline input: False
Accept wildcard characters: False

-SilentRestart

Specifies whether the restart should be triggered when DeployMode is silent or very silent.

Type: SwitchParameter
Parameter Sets: SilentRestart
Aliases:

Required: True
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-SilentCountdownSeconds

Specifies number of seconds to countdown for the restart when the toolkit is running in silent mode and -SilentRestart isn't specified. Default: 5

Type: UInt32
Parameter Sets: SilentRestart
Aliases:

Required: False
Position: Named
Default value: 5
Accept pipeline input: False
Accept wildcard characters: False

-NotTopMost

Specifies whether the prompt shouldn't be topmost, above all other windows.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Subtitle

Subtitle of the prompt. Default: the application deployment type.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Title

Title of the prompt. Default: the application installation name.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

None

You cannot pipe objects to this function.

OUTPUTS

None

This function does not generate any output.

NOTES

Be mindful of the countdown you specify for the reboot as code directly after this function might NOT be able to execute - that includes logging.

Tags: psadt
Website: https://psappdeploytoolkit.com
Copyright: (C) 2025 PSAppDeployToolkit Team (Sean Lillis, Dan Cunningham, Muhammad Mashwani, Mitch Richters, Dan Gough).
License: https://opensource.org/license/lgpl-3-0

RELATED LINKS

https://psappdeploytoolkit.com/docs/reference/functions/Show-ADTInstallationRestartPrompt