Share via

Start-Sleep

  • Reference
Module:
Microsoft.PowerShell.Utility

Suspends the activity in a script or session for the specified period of time.

Syntax

Start-Sleep
     [-Seconds] <Double>
     [<CommonParameters>]
Start-Sleep
     -Milliseconds <Int32>
     [<CommonParameters>]
Start-Sleep
     -Duration <TimeSpan>
     [<CommonParameters>]

Description

The Start-Sleep cmdlet suspends the activity in a script or session for the specified period of time. You can use it for many tasks, such as waiting for an operation to complete or pausing before repeating an operation.

Examples

Example 1: Pause execution for 1.5 seconds

In this example, the execution of commands pauses for one and one-half seconds.

Start-Sleep -Seconds 1.5

Example 2: Pause execution at the command line

This example shows that execution is paused for 5 seconds when run from the command line.

PS> Get-Date; Start-Sleep -Seconds 5; Get-Date

Friday, May 13, 2022 9:38:15 AM
Friday, May 13, 2022 9:38:20 AM

PowerShell cannot execute the second Get-Date command until the sleep timer expires.

Example 3: Sleep commands using a **TimeSpan**

This example makes all the commands in the session sleep for 30 seconds.

Start-Sleep -Duration (New-TimeSpan -Seconds 30)

Parameters

-Duration

Uses a TimeSpan object to specify how long the resource sleeps in milliseconds. The value must not be a negative TimeSpan and must not exceed [int]::MaxValue milliseconds.

Type:TimeSpan
Aliases:ts
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Milliseconds

Specifies how long the resource sleeps in milliseconds. The parameter can be abbreviated as m.

Type:Int32
Aliases:ms
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Seconds

Specifies how long the resource sleeps in seconds. You can omit the parameter name or you can abbreviate it as s. Beginning in PowerShell 6.2.0, this parameter now accepts fractional values.

Type:Double
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

Inputs

Int32

You can pipe the number of seconds to this cmdlet.

Outputs

None

This cmdlet returns no output.

Notes

PowerShell includes the following aliases for Start-Sleep:

  • Windows:

    • sleep

  • Ctrl+C breaks out of Start-Sleep.

  • Ctrl+C does not break out of [Threading.Thread]::Sleep. For more information, see Thread.Sleep Method.