< Back
Register-PSFRunspace
Post
NAME Register-PSFRunspace
SYNOPSIS
Registers a scriptblock to run in the background.
SYNTAX
Register-PSFRunspace -ScriptBlock <ScriptBlock> -Name <String> [-NoMessage] [<CommonParameters>]
DESCRIPTION
This function registers a scriptblock to run in separate runspace.
This is different from most runspace solutions, in that it is designed for permanent background tasks that need to
be done.
It guarantees a single copy of the task to run within the powershell process, even when running the same module in
many runspaces in parallel.
The scriptblock must be built with some rules in mind, for details on using this system run:
Get-Help about_psf_runspace
Updating:
If this function is called multiple times, targeting the same name, it will update the scriptblock.
- If that scriptblock is the same as the previous scriptblock, nothing changes
- If that scriptblock is different from the previous ones, it will be registered, but will not be executed right
away!
Only after stopping and starting the runspace will it operate under the new scriptblock.
PARAMETERS
-ScriptBlock <ScriptBlock>
The scriptblock to run in a dedicated runspace.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Name <String>
The name to register the scriptblock under.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-NoMessage [<SwitchParameter>]
Setting this will prevent messages be written to the message / logging system.
This is designed to make the PSFramework not flood the log on each import.
Required? false
Position? named
Default value False
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
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Register-PSFRunspace -ScriptBlock $scriptBlock -Name 'mymodule.maintenance'
Registers the script defined in $scriptBlock under the name 'mymodule.maintenance'
It does not start the runspace yet. If it already exists, it will overwrite the scriptblock without affecting the
running script.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Register-PSFRunspace -ScriptBlock $scriptBlock -Name 'mymodule.maintenance'
PS C:\\> Start-PSFRunspace -Name 'mymodule.maintenance'
Registers the script defined in $scriptBlock under the name 'mymodule.maintenance'
Then it starts the runspace, running the registered $scriptBlock
RELATED LINKS
SYNOPSIS
Registers a scriptblock to run in the background.
SYNTAX
Register-PSFRunspace -ScriptBlock <ScriptBlock> -Name <String> [-NoMessage] [<CommonParameters>]
DESCRIPTION
This function registers a scriptblock to run in separate runspace.
This is different from most runspace solutions, in that it is designed for permanent background tasks that need to
be done.
It guarantees a single copy of the task to run within the powershell process, even when running the same module in
many runspaces in parallel.
The scriptblock must be built with some rules in mind, for details on using this system run:
Get-Help about_psf_runspace
Updating:
If this function is called multiple times, targeting the same name, it will update the scriptblock.
- If that scriptblock is the same as the previous scriptblock, nothing changes
- If that scriptblock is different from the previous ones, it will be registered, but will not be executed right
away!
Only after stopping and starting the runspace will it operate under the new scriptblock.
PARAMETERS
-ScriptBlock <ScriptBlock>
The scriptblock to run in a dedicated runspace.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Name <String>
The name to register the scriptblock under.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-NoMessage [<SwitchParameter>]
Setting this will prevent messages be written to the message / logging system.
This is designed to make the PSFramework not flood the log on each import.
Required? false
Position? named
Default value False
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
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Register-PSFRunspace -ScriptBlock $scriptBlock -Name 'mymodule.maintenance'
Registers the script defined in $scriptBlock under the name 'mymodule.maintenance'
It does not start the runspace yet. If it already exists, it will overwrite the scriptblock without affecting the
running script.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Register-PSFRunspace -ScriptBlock $scriptBlock -Name 'mymodule.maintenance'
PS C:\\> Start-PSFRunspace -Name 'mymodule.maintenance'
Registers the script defined in $scriptBlock under the name 'mymodule.maintenance'
Then it starts the runspace, running the registered $scriptBlock
RELATED LINKS