Share via

PSSessionOption.CancelTimeout Property

  • Reference

Definition

Namespace:
System.Management.Automation.Remoting
Assembly:
System.Management.Automation.dll
Package:
Microsoft.PowerShell.5.1.ReferenceAssemblies v1.0.0
Package:
System.Management.Automation v7.0.13
Package:
System.Management.Automation v7.1.7
Package:
System.Management.Automation v7.2.12
Package:
System.Management.Automation v7.3.5
Package:
System.Management.Automation v7.4.0
Package:
Microsoft.WSMan.Runtime v6.1.0
Package:
Microsoft.WSMan.Runtime v6.2.0

The duration for which PowerShell should wait before it times out on cancel operations (close runspace or stop powershell). For instance, when the user hits ctrl-C, New-PSSession cmdlet tries to call a stop on all remote runspaces which are in the Opening state. The user wouldn't mind waiting for 15 seconds, but this should be time bound and of a shorter duration. A high timeout here like 3 minutes will give the user a feeling that the PowerShell client is not responding.

Default: 60 * 1000 = 1 minute.

public:
 property TimeSpan CancelTimeout { TimeSpan get(); void set(TimeSpan value); };
public TimeSpan CancelTimeout { get; set; }
member this.CancelTimeout : TimeSpan with get, set
Public Property CancelTimeout As TimeSpan

Property Value

TimeSpan

Applies to