Start-R1Task

SYNOPSIS

Runs a task now.

SYNTAX

Start-R1Task [-id] <String> [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Starts a task immediately, rather than waiting for its next scheduled run.

EXAMPLES

Example 1

Start-R1Task -id 'e4ef6b3e'

Runs the task now.

PARAMETERS

-id

The identifier of the task.

Type: String
Parameter Sets: (All)
Aliases:

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
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

None

OUTPUTS

System.Void

NOTES

Get-R1Task

Stop-R1Task

Get-R1TaskLog