< Back
Get-PSFTaskEngineCache
Post
NAME Get-PSFTaskEngineCache
SYNOPSIS
Retrieve values from the cache for a task engine task.
SYNTAX
Get-PSFTaskEngineCache [-Module] <String> [-Name] <String> [<CommonParameters>]
DESCRIPTION
Retrieve values from the cache for a task engine task.
Tasks scheduled under the PSFramework task engine do not have a way to directly pass information to the primary
runspace.
Using Set-PSFTaskEngineCache, they can store the information somewhere where the main runspace can retrieve it
using this function.
PARAMETERS
-Module <String>
The name of the module that generated the task.
Use scriptname in case of using this within a script.
Note: Must be the same as the name used within the task when calling 'Set-PSFTaskEngineCache'
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Name <String>
The name of the task for which the cache is.
Note: Must be the same as the name used within the task when calling 'Set-PSFTaskEngineCache'
Required? true
Position? 2
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
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-PSFTaskEngineCache -Module 'mymodule' -Name 'maintenancetask'
Retrieves the information stored under 'mymodule.maintenancetask'
RELATED LINKS
SYNOPSIS
Retrieve values from the cache for a task engine task.
SYNTAX
Get-PSFTaskEngineCache [-Module] <String> [-Name] <String> [<CommonParameters>]
DESCRIPTION
Retrieve values from the cache for a task engine task.
Tasks scheduled under the PSFramework task engine do not have a way to directly pass information to the primary
runspace.
Using Set-PSFTaskEngineCache, they can store the information somewhere where the main runspace can retrieve it
using this function.
PARAMETERS
-Module <String>
The name of the module that generated the task.
Use scriptname in case of using this within a script.
Note: Must be the same as the name used within the task when calling 'Set-PSFTaskEngineCache'
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Name <String>
The name of the task for which the cache is.
Note: Must be the same as the name used within the task when calling 'Set-PSFTaskEngineCache'
Required? true
Position? 2
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
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-PSFTaskEngineCache -Module 'mymodule' -Name 'maintenancetask'
Retrieves the information stored under 'mymodule.maintenancetask'
RELATED LINKS