< Back
Stop-PSFRunspace
Post
NAME Stop-PSFRunspace
SYNOPSIS
Stops a runspace that was registered to the PSFramework
SYNTAX
Stop-PSFRunspace [[-Name] <String[]>] [[-Runspace] <RunspaceContainer[]>] [-EnableException] [-WhatIf] [-Confirm]
[<CommonParameters>]
DESCRIPTION
Stops a runspace that was registered to the PSFramework
Will not cause errors if the runspace is already halted.
Runspaces may not automatically terminate immediately when calling this function.
Depending on the implementation of the scriptblock, this may in fact take a little time.
If the scriptblock hasn't finished and terminated the runspace in a seemingly time, it will be killed by the
system.
This timeout is by default 30 seconds, but can be altered by using the Configuration System.
For example, this line will increase the timeout to 60 seconds:
Set-PSFConfig -FullName PSFramework.Runspace.StopTimeout -Value 60
PARAMETERS
-Name <String[]>
The name of the registered runspace to stop
Required? false
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-Runspace <RunspaceContainer[]>
The runspace to stop. Returned by Get-PSFRunspace
Required? false
Position? 2
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-EnableException [<SwitchParameter>]
This parameters disables user-friendly warnings and enables the throwing of exceptions.
This is less user friendly, but allows catching exceptions in calling scripts.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
If this switch is enabled, no actions are performed but informational messages will be displayed that explain
what would happen if the command were to run.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
If this switch is enabled, you will be prompted for confirmation before executing any operations that change
state.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
Additional information about the function.
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Stop-PSFRunspace -Name 'mymodule.maintenance'
Stops the runspace registered under the name 'mymodule.maintenance'
RELATED LINKS
SYNOPSIS
Stops a runspace that was registered to the PSFramework
SYNTAX
Stop-PSFRunspace [[-Name] <String[]>] [[-Runspace] <RunspaceContainer[]>] [-EnableException] [-WhatIf] [-Confirm]
[<CommonParameters>]
DESCRIPTION
Stops a runspace that was registered to the PSFramework
Will not cause errors if the runspace is already halted.
Runspaces may not automatically terminate immediately when calling this function.
Depending on the implementation of the scriptblock, this may in fact take a little time.
If the scriptblock hasn't finished and terminated the runspace in a seemingly time, it will be killed by the
system.
This timeout is by default 30 seconds, but can be altered by using the Configuration System.
For example, this line will increase the timeout to 60 seconds:
Set-PSFConfig -FullName PSFramework.Runspace.StopTimeout -Value 60
PARAMETERS
-Name <String[]>
The name of the registered runspace to stop
Required? false
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-Runspace <RunspaceContainer[]>
The runspace to stop. Returned by Get-PSFRunspace
Required? false
Position? 2
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-EnableException [<SwitchParameter>]
This parameters disables user-friendly warnings and enables the throwing of exceptions.
This is less user friendly, but allows catching exceptions in calling scripts.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
If this switch is enabled, no actions are performed but informational messages will be displayed that explain
what would happen if the command were to run.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
If this switch is enabled, you will be prompted for confirmation before executing any operations that change
state.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
Additional information about the function.
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Stop-PSFRunspace -Name 'mymodule.maintenance'
Stops the runspace registered under the name 'mymodule.maintenance'
RELATED LINKS