Set-PSUSchedule

Updates a schedule.

SYNOPSIS

Updates a schedule.

SYNTAX

Schedule (Default)

Set-PSUSchedule [-Schedule] <Schedule> [[-Cron] <String>] [-Description <String>] [[-Script] <String>]
 [-Workflow <String>] [-TimeZone <String>] [-Continuous <Boolean>] [-Delay <TimeSpan>] [-Credential <String>]
 [-OneTime <DateTime>] [-Environment <String>]
 [-Parameters <System.Collections.Generic.List`1[PowerShellUniversal.ScheduleParameter]>] [-Name <String>]
 [-Paused <Boolean>] [-Timeout <Int32>] [-Condition <String>] [-RandomDelay <Boolean>] [-Computer <String>]
 [-RandomDelayMaximum <Int32>] [-AvailableInBranch <System.Collections.Generic.List`1[System.String]>]
 [-Module <String>] [-EveryHour <Boolean>] [-Minute <Int32>] [-EveryDay <Boolean>] [-Hour <Int32>]
 [-DayOfWeek <Boolean>] [-Day <String[]>] [-EveryMonth <Boolean>] [-DayOfMonth <Int32>]
 [-SpecificMonth <Boolean>] [-Month <String[]>] [-ComputerGroup <String>]
 [-ComputerGroupInvocationType <ComputerGroupInvocationType>] [-Folder <String>] [-ComputerName <String>]
 [-AppToken <String>] [-UseDefaultCredentials] [-Integrated] [-TrustCertificate] [-Cookies]
 [<CommonParameters>]

Id

Set-PSUSchedule [-Id] <Int64> [[-Cron] <String>] [-Description <String>] [[-Script] <String>]
 [-Workflow <String>] [-TimeZone <String>] [-Continuous <Boolean>] [-Delay <TimeSpan>] [-Credential <String>]
 [-OneTime <DateTime>] [-Environment <String>]
 [-Parameters <System.Collections.Generic.List`1[PowerShellUniversal.ScheduleParameter]>] [-Name <String>]
 [-Paused <Boolean>] [-Timeout <Int32>] [-Condition <String>] [-RandomDelay <Boolean>] [-Computer <String>]
 [-RandomDelayMaximum <Int32>] [-AvailableInBranch <System.Collections.Generic.List`1[System.String]>]
 [-Module <String>] [-EveryHour <Boolean>] [-Minute <Int32>] [-EveryDay <Boolean>] [-Hour <Int32>]
 [-DayOfWeek <Boolean>] [-Day <String[]>] [-EveryMonth <Boolean>] [-DayOfMonth <Int32>]
 [-SpecificMonth <Boolean>] [-Month <String[]>] [-ComputerGroup <String>]
 [-ComputerGroupInvocationType <ComputerGroupInvocationType>] [-Folder <String>] [-ComputerName <String>]
 [-AppToken <String>] [-UseDefaultCredentials] [-Integrated] [-TrustCertificate] [-Cookies]
 [<CommonParameters>]

DESCRIPTION

Updates the configuration of an existing schedule by Id or by passing a schedule object through the pipeline.

EXAMPLES

Example 1

PS C:\> Set-PSUSchedule -Id 12 -Name "Nightly Cleanup" -Cron "0 0 * * *"

Updates schedule 12 to use a nightly CRON expression.

PARAMETERS

-AppToken

Specifies the app token to use when authenticating to the PowerShell Universal management API.

Type: String
Parameter Sets: (All)
Aliases:

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

-Computer

Specifies the computer to target.

Type: String
Parameter Sets: (All)
Aliases:

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

-ComputerName

Specifies the URL or host name of the target PowerShell Universal instance. Bare host names are normalized to an http://:5000 URL.

Type: String
Parameter Sets: (All)
Aliases: Uri

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

-Condition

Specifies a condition that must evaluate successfully before the resource runs.

Type: String
Parameter Sets: (All)
Aliases:

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

-Continuous

Runs the schedule continuously instead of using a fixed calendar expression.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-Credential

Credentials to login to the PowerShell Universal Management API.

Type: String
Parameter Sets: (All)
Aliases:

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

-Cron

Specifies the CRON expression for the schedule.

Type: String
Parameter Sets: (All)
Aliases:

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

-Delay

Specifies the delay between executions.

Type: TimeSpan
Parameter Sets: (All)
Aliases:

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

-Description

Specifies a description for the resource.

Type: String
Parameter Sets: (All)
Aliases:

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

-Environment

Specifies the execution environment to use.

Type: String
Parameter Sets: (All)
Aliases:

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

-Id

Specifies the numeric Id of the resource.

Type: Int64
Parameter Sets: Id
Aliases:

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

-Integrated

Uses the in-process integrated management client when the cmdlet runs inside PowerShell Universal.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Name

Specifies the name of the resource.

Type: String
Parameter Sets: (All)
Aliases:

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

-OneTime

Schedules the resource to run once at the specified date and time.

Type: DateTime
Parameter Sets: (All)
Aliases:

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

-Parameters

Specifies parameter values to pass to the resource when it runs.

Type: System.Collections.Generic.List`1[PowerShellUniversal.ScheduleParameter]
Parameter Sets: (All)
Aliases:

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

-Paused

Creates or updates the schedule in a paused state.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-RandomDelay

Adds a randomized delay before the schedule runs.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-RandomDelayMaximum

Specifies the maximum randomized delay, in seconds.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-Schedule

Specifies the schedule to target.

Type: Schedule
Parameter Sets: Schedule
Aliases:

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

-Script

Specifies the script to target.

Type: String
Parameter Sets: (All)
Aliases:

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

-TimeZone

Specifies the time zone used when interpreting schedule times.

Type: String
Parameter Sets: (All)
Aliases:

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

-Timeout

Specifies the timeout, in seconds, for the operation.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-UseDefaultCredentials

Uses the current Windows credentials when authenticating to the management API.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-AvailableInBranch

Specifies the Git branches where the resource is available.

Type: System.Collections.Generic.List`1[System.String]
Parameter Sets: (All)
Aliases:

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

-ComputerGroup

Specifies the computer group to target or assign.

Type: String
Parameter Sets: (All)
Aliases:

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

-ComputerGroupInvocationType

Specifies how jobs are invoked across the selected computer group.

Type: ComputerGroupInvocationType
Parameter Sets: (All)
Aliases:

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

-Cookies

Reuses and persists authentication cookies for the current PowerShell session.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Day

Specifies the days of the week on which the schedule should run.

Type: String[]
Parameter Sets: (All)
Aliases:

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

-DayOfMonth

Specifies the day of the month on which the schedule should run.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-DayOfWeek

Schedules execution on specific days of the week.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-EveryDay

Schedules execution every day.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-EveryHour

Schedules execution every hour.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-EveryMonth

Schedules execution every month.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-Folder

Specifies the folder to target.

Type: String
Parameter Sets: (All)
Aliases:

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

-Hour

Specifies the hour component of the schedule.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-Minute

Specifies the minute component of the schedule.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-Module

Specifies the PowerShell module name to use.

Type: String
Parameter Sets: (All)
Aliases:

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

-Month

Specifies the months in which the schedule should run.

Type: String[]
Parameter Sets: (All)
Aliases:

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

-SpecificMonth

Schedules execution only during the months specified by Month.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-TrustCertificate

Allows connections to servers with untrusted TLS certificates.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Workflow

Specifies the workflow to target.

Type: String
Parameter Sets: (All)
Aliases:

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, -OutBuffer, -OutVariable, -PipelineVariable, -Verbose, -WarningAction, -WarningVariable, and -ProgressAction. For more information, see about_CommonParameters.