Suspend-KrSchedule

SYNOPSIS

Suspends a schedule, preventing it from running until resumed.

SYNTAX

Suspend-KrSchedule [[-Server] <KestrunHost>] [-Name] <String> [<CommonParameters>]

DESCRIPTION

This function pauses a scheduled task, allowing it to be resumed later.

EXAMPLES

EXAMPLE 1

Suspend-KrSchedule -Name 'ps-inline'
Suspends the schedule named 'ps-inline'.

PARAMETERS

-Server

The Kestrun host object that manages the schedule.

Type: KestrunHost
Parameter Sets: (All)
Aliases:

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

-Name

The name of the schedule to suspend.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
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

OUTPUTS

Returns the Kestrun host object after suspending the schedule.

NOTES

This function is part of the Kestrun scheduling module.

RELATED LINKS