Skip to content

Invoke-PodeTask

SYNOPSIS

Invoke a Task.

SYNTAX

Invoke-PodeTask [-Name] <String> [[-ArgumentList] <Hashtable>] [[-Timeout] <Int32>] [-Wait]
 [<CommonParameters>]

DESCRIPTION

Invoke a Task either asynchronously or synchronously, with support for returning values.

EXAMPLES

EXAMPLE 1

Invoke-PodeTask -Name 'Example1' -Wait -Timeout 5

EXAMPLE 2

$task = Invoke-PodeTask -Name 'Example1'

EXAMPLE 3

Invoke-PodeTask -Name 'Example1' | Wait-PodeTask -Timeout 3

PARAMETERS

-ArgumentList

A hashtable of arguments to supply to the Task's ScriptBlock.

Type: Hashtable
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Name

The Name of the Task.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Timeout

A Timeout, in seconds, to abort running the task. (Default: -1 [never timeout])

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: -1
Accept pipeline input: False
Accept wildcard characters: False

-Wait

If supplied, Pode will wait until the Task has finished executing, and then return any values.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

Back to top