New-PSUSchedule

Creates a new schedule within PSU.

SYNOPSIS

Creates a new schedule within PSU.

SYNTAX

Script-Cron (Default)

New-PSUSchedule [-Script] <Script> [-Cron] <String> [-Credential <Variable>] [-TimeZone <String>]
 [-Environment <String>] [-Name <String>] [-Paused] [-RandomDelay] [-RandomDelayMaximum <Int32>]
 [-Timeout <Int32>] [-Condition <ScriptBlock>] [-Folder <String>] [-Description <String>] [-Computer <String>]
 [-Parameters <Hashtable>] [-AvailableInBranch <String[]>] [-ComputerName <String>] [-AppToken <String>]
 [-UseDefaultCredentials] [-Integrated] [-TrustCertificate] [-Cookies]
 [<CommonParameters>]

Script-Continuous

New-PSUSchedule [-Script] <Script> [-Credential <Variable>] [-TimeZone <String>] [-Continuous]
 [-Delay <TimeSpan>] [-DelaySecond <Int32>] [-DelayMinute <Int32>] [-DelayHour <Int32>] [-Environment <String>]
 [-Name <String>] [-Paused] [-RandomDelay] [-RandomDelayMaximum <Int32>] [-Timeout <Int32>]
 [-Condition <ScriptBlock>] [-Folder <String>] [-Description <String>] [-Computer <String>]
 [-Parameters <Hashtable>] [-AvailableInBranch <String[]>] [-ComputerName <String>] [-AppToken <String>]
 [-UseDefaultCredentials] [-Integrated] [-TrustCertificate] [-Cookies]
 [<CommonParameters>]

Script-OneTime

New-PSUSchedule [-Script] <Script> [-Credential <Variable>] [-TimeZone <String>] [-Environment <String>]
 [-Name <String>] [-Paused] [-RandomDelay] [-RandomDelayMaximum <Int32>] [-Timeout <Int32>]
 [-Condition <ScriptBlock>] [-Folder <String>] [-OneTime <DateTime>] [-Description <String>]
 [-Computer <String>] [-Parameters <Hashtable>] [-AvailableInBranch <String[]>] [-ComputerName <String>]
 [-AppToken <String>] [-UseDefaultCredentials] [-Integrated] [-TrustCertificate] [-Cookies]
 [<CommonParameters>]

Script-EveryHour

New-PSUSchedule [-Script] <Script> [-Credential <Variable>] [-TimeZone <String>] [-Environment <String>]
 [-Name <String>] [-Paused] [-RandomDelay] [-RandomDelayMaximum <Int32>] [-Timeout <Int32>]
 [-Condition <ScriptBlock>] [-EveryHour] [-Minute <Int32>] [-Folder <String>] [-Description <String>]
 [-Computer <String>] [-Parameters <Hashtable>] [-AvailableInBranch <String[]>] [-ComputerName <String>]
 [-AppToken <String>] [-UseDefaultCredentials] [-Integrated] [-TrustCertificate] [-Cookies]
 [<CommonParameters>]

Script-EveryDay

New-PSUSchedule [-Script] <Script> [-Credential <Variable>] [-TimeZone <String>] [-Environment <String>]
 [-Name <String>] [-Paused] [-RandomDelay] [-RandomDelayMaximum <Int32>] [-Timeout <Int32>]
 [-Condition <ScriptBlock>] [-Minute <Int32>] [-Hour <Int32>] [-EveryDay] [-Folder <String>]
 [-Description <String>] [-Computer <String>] [-Parameters <Hashtable>] [-AvailableInBranch <String[]>]
 [-ComputerName <String>] [-AppToken <String>] [-UseDefaultCredentials] [-Integrated] [-TrustCertificate]
 [-Cookies] [<CommonParameters>]

Script-DayOfWeek

New-PSUSchedule [-Script] <Script> [-Credential <Variable>] [-TimeZone <String>] [-Environment <String>]
 [-Name <String>] [-Paused] [-RandomDelay] [-RandomDelayMaximum <Int32>] [-Timeout <Int32>]
 [-Condition <ScriptBlock>] [-Minute <Int32>] [-Hour <Int32>] [-DayOfWeek] -Day <String[]> [-Folder <String>]
 [-Description <String>] [-Computer <String>] [-Parameters <Hashtable>] [-AvailableInBranch <String[]>]
 [-ComputerName <String>] [-AppToken <String>] [-UseDefaultCredentials] [-Integrated] [-TrustCertificate]
 [-Cookies] [<CommonParameters>]

Script-EveryMonth

New-PSUSchedule [-Script] <Script> [-Credential <Variable>] [-TimeZone <String>] [-Environment <String>]
 [-Name <String>] [-Paused] [-RandomDelay] [-RandomDelayMaximum <Int32>] [-Timeout <Int32>]
 [-Condition <ScriptBlock>] [-Minute <Int32>] [-Hour <Int32>] [-EveryMonth] -DayOfMonth <Int32>
 [-Folder <String>] [-Description <String>] [-Computer <String>] [-Parameters <Hashtable>]
 [-AvailableInBranch <String[]>] [-ComputerName <String>] [-AppToken <String>] [-UseDefaultCredentials]
 [-Integrated] [-TrustCertificate] [-Cookies] [<CommonParameters>]

Script-SpecificMonth

New-PSUSchedule [-Script] <Script> [-Credential <Variable>] [-TimeZone <String>] [-Environment <String>]
 [-Name <String>] [-Paused] [-RandomDelay] [-RandomDelayMaximum <Int32>] [-Timeout <Int32>]
 [-Condition <ScriptBlock>] [-Minute <Int32>] [-Hour <Int32>] -DayOfMonth <Int32> [-SpecificMonth]
 -Month <String[]> [-Folder <String>] [-Description <String>] [-Computer <String>] [-Parameters <Hashtable>]
 [-AvailableInBranch <String[]>] [-ComputerName <String>] [-AppToken <String>] [-UseDefaultCredentials]
 [-Integrated] [-TrustCertificate] [-Cookies] [<CommonParameters>]

Workflow-Cron

New-PSUSchedule -Workflow <Workflow> [-Cron] <String> [-Credential <Variable>] [-TimeZone <String>]
 [-Environment <String>] [-Name <String>] [-Paused] [-RandomDelay] [-RandomDelayMaximum <Int32>]
 [-Timeout <Int32>] [-Condition <ScriptBlock>] [-Folder <String>] [-Description <String>] [-Computer <String>]
 [-Parameters <Hashtable>] [-AvailableInBranch <String[]>] [-ComputerName <String>] [-AppToken <String>]
 [-UseDefaultCredentials] [-Integrated] [-TrustCertificate] [-Cookies]
 [<CommonParameters>]

Workflow-Continuous

New-PSUSchedule -Workflow <Workflow> [-Credential <Variable>] [-TimeZone <String>] [-Continuous]
 [-Delay <TimeSpan>] [-DelaySecond <Int32>] [-DelayMinute <Int32>] [-DelayHour <Int32>] [-Environment <String>]
 [-Name <String>] [-Paused] [-RandomDelay] [-RandomDelayMaximum <Int32>] [-Timeout <Int32>]
 [-Condition <ScriptBlock>] [-Folder <String>] [-Description <String>] [-Computer <String>]
 [-Parameters <Hashtable>] [-AvailableInBranch <String[]>] [-ComputerName <String>] [-AppToken <String>]
 [-UseDefaultCredentials] [-Integrated] [-TrustCertificate] [-Cookies]
 [<CommonParameters>]

Workflow-OneTime

New-PSUSchedule -Workflow <Workflow> [-Credential <Variable>] [-TimeZone <String>] [-Environment <String>]
 [-Name <String>] [-Paused] [-RandomDelay] [-RandomDelayMaximum <Int32>] [-Timeout <Int32>]
 [-Condition <ScriptBlock>] [-Folder <String>] [-OneTime <DateTime>] [-Description <String>]
 [-Computer <String>] [-Parameters <Hashtable>] [-AvailableInBranch <String[]>] [-ComputerName <String>]
 [-AppToken <String>] [-UseDefaultCredentials] [-Integrated] [-TrustCertificate] [-Cookies]
 [<CommonParameters>]

Workflow-EveryHour

New-PSUSchedule -Workflow <Workflow> [-Credential <Variable>] [-TimeZone <String>] [-Environment <String>]
 [-Name <String>] [-Paused] [-RandomDelay] [-RandomDelayMaximum <Int32>] [-Timeout <Int32>]
 [-Condition <ScriptBlock>] [-EveryHour] [-Minute <Int32>] [-Folder <String>] [-Description <String>]
 [-Computer <String>] [-Parameters <Hashtable>] [-AvailableInBranch <String[]>] [-ComputerName <String>]
 [-AppToken <String>] [-UseDefaultCredentials] [-Integrated] [-TrustCertificate] [-Cookies]
 [<CommonParameters>]

Workflow-EveryDay

New-PSUSchedule -Workflow <Workflow> [-Credential <Variable>] [-TimeZone <String>] [-Environment <String>]
 [-Name <String>] [-Paused] [-RandomDelay] [-RandomDelayMaximum <Int32>] [-Timeout <Int32>]
 [-Condition <ScriptBlock>] [-Minute <Int32>] [-Hour <Int32>] [-EveryDay] [-Folder <String>]
 [-Description <String>] [-Computer <String>] [-Parameters <Hashtable>] [-AvailableInBranch <String[]>]
 [-ComputerName <String>] [-AppToken <String>] [-UseDefaultCredentials] [-Integrated] [-TrustCertificate]
 [-Cookies] [<CommonParameters>]

Workflow-DayOfWeek

New-PSUSchedule -Workflow <Workflow> [-Credential <Variable>] [-TimeZone <String>] [-Environment <String>]
 [-Name <String>] [-Paused] [-RandomDelay] [-RandomDelayMaximum <Int32>] [-Timeout <Int32>]
 [-Condition <ScriptBlock>] [-Minute <Int32>] [-Hour <Int32>] [-DayOfWeek] -Day <String[]> [-Folder <String>]
 [-Description <String>] [-Computer <String>] [-Parameters <Hashtable>] [-AvailableInBranch <String[]>]
 [-ComputerName <String>] [-AppToken <String>] [-UseDefaultCredentials] [-Integrated] [-TrustCertificate]
 [-Cookies] [<CommonParameters>]

Workflow-EveryMonth

New-PSUSchedule -Workflow <Workflow> [-Credential <Variable>] [-TimeZone <String>] [-Environment <String>]
 [-Name <String>] [-Paused] [-RandomDelay] [-RandomDelayMaximum <Int32>] [-Timeout <Int32>]
 [-Condition <ScriptBlock>] [-Minute <Int32>] [-Hour <Int32>] [-EveryMonth] -DayOfMonth <Int32>
 [-Folder <String>] [-Description <String>] [-Computer <String>] [-Parameters <Hashtable>]
 [-AvailableInBranch <String[]>] [-ComputerName <String>] [-AppToken <String>] [-UseDefaultCredentials]
 [-Integrated] [-TrustCertificate] [-Cookies] [<CommonParameters>]

Workflow-SpecificMonth

New-PSUSchedule -Workflow <Workflow> [-Credential <Variable>] [-TimeZone <String>] [-Environment <String>]
 [-Name <String>] [-Paused] [-RandomDelay] [-RandomDelayMaximum <Int32>] [-Timeout <Int32>]
 [-Condition <ScriptBlock>] [-Minute <Int32>] [-Hour <Int32>] -DayOfMonth <Int32> [-SpecificMonth]
 -Month <String[]> [-Folder <String>] [-Description <String>] [-Computer <String>] [-Parameters <Hashtable>]
 [-AvailableInBranch <String[]>] [-ComputerName <String>] [-AppToken <String>] [-UseDefaultCredentials]
 [-Integrated] [-TrustCertificate] [-Cookies] [<CommonParameters>]

DESCRIPTION

Creates a new schedule within PSU. Schedules allow you to automate when jobs run and run jobs continuously.

EXAMPLES

Example 1

PS C:\> $Script = Get-PSUScript -Name 'Script1.ps1'
PS C:\> New-PSUSchedule -Script $Script -Cron '*/5 * * * *'

Creates a new schedule that runs every five minutes.

Example 2

PS C:\> $Script = Get-PSUScript -Name 'Script1.ps1'
PS C:\> New-PSUSchedule -Script $Script -Cron '*/5 * * * *' -Credential $Secret:Credential

Creates a new schedule that runs every five minutes as 'adam'.

Example 3

PS C:\> $Script = Get-PSUScript -Name 'Script1.ps1'
PS C:\> New-PSUSchedule -Script $Script -Continous -DelayMinute 5

Creates a schedule that runs continuously. It will start a new job once the previous one finishes with a delay of 5 minutes inbetween executions.

Example 4

PS C:\> $Script = Get-PSUScript -Name 'Script1.ps1'
PS C:\> $Time = (Get-Date).AddMinutes(30).ToUniversalTime()
PS C:\> New-PSUSchedule -Script $Script -OneTime $Time -TimeZone "America/Phoenix"

Creates a schedule that runs once in 30 minutes in the 'America/Phoenix' time zone.

PARAMETERS

-AppToken

An app token to access the PSU API.

Type: String
Parameter Sets: (All)
Aliases:

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

-ComputerName

The HTTP address of the PSU REST API server.

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

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

-Continuous

Runs a job continously with an optional delay between executions.

Type: SwitchParameter
Parameter Sets: Script-Continuous, Workflow-Continuous
Aliases:

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

-Credential

A credential for the user to run the job as. Use New-UACredential to create this credential object.

Type: Variable
Parameter Sets: (All)
Aliases:

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

-Cron

The CRON schedule to use for this schedule.

Type: String
Parameter Sets: Script-Cron, Workflow-Cron
Aliases:

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

-Delay

The delay inbetween continous job executions.

Type: TimeSpan
Parameter Sets: Script-Continuous, Workflow-Continuous
Aliases:

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

-DelayHour

The delay in hours inbetween continous job executions.

Type: Int32
Parameter Sets: Script-Continuous, Workflow-Continuous
Aliases:

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

-DelayMinute

The delay in minutes inbetween continous job executions.

Type: Int32
Parameter Sets: Script-Continuous, Workflow-Continuous
Aliases:

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

-DelaySecond

The delay in seconds inbetween continous job executions.

Type: Int32
Parameter Sets: Script-Continuous, Workflow-Continuous
Aliases:

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

-Script

The script to schedule. Use Get-UAScript to retrieve a script object.

Type: Script
Parameter Sets: Script-Cron, Script-Continuous, Script-OneTime, Script-EveryHour, Script-EveryDay, Script-DayOfWeek, Script-EveryMonth, Script-SpecificMonth
Aliases:

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

-TimeZone

The TimeZone to execute the script in. By default, it runs in the current user's time zone.

Type: String
Parameter Sets: (All)
Aliases:

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

-Environment

The name of the environment to run the script within.

Type: String
Parameter Sets: (All)
Aliases:

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

-OneTime

Schedules at a time in the future. The initial time zone is determined by the Kind property of the DateTime object. It the kind is Unknown, it will be assumed to be UTC.

Type: DateTime
Parameter Sets: Script-OneTime, Workflow-OneTime
Aliases:

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

-Description

Description for the schedule.

Type: String
Parameter Sets: (All)
Aliases:

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

-Name

Name of the schedule to display in the admin console.

Type: String
Parameter Sets: (All)
Aliases:

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

-UseDefaultCredentials

Use default credentials when connecting 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

-Condition

A script block that determines whether this schedule should execute. This script block should return $true or $false.

Type: ScriptBlock
Parameter Sets: (All)
Aliases:

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

-Integrated

Executes the command internally rather than using the Management API. Only works when running script from within PowerShell Universal.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Paused

Whether this schedule is paused.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Timeout

The timeout in minutes for this schedule.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-RandomDelay

A random delay will be applied to when this script is started. The random delay will be between 0 and 60 seconds.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-AvailableInBranch

Branches that this schedule will run in.

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

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

-Computer

Computer or computer group that will run this schedule.

Type: String
Parameter Sets: (All)
Aliases:

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

-Parameters

A hashtable of parameters for this schedule to pass to the target script.

Type: Hashtable
Parameter Sets: (All)
Aliases:

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

-RandomDelayMaximum

The maximum number of seconds to delay.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-TrustCertificate

Whether the cmdlet should ignore certificate issues.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Day

The day of the week to run the script.

Type: String[]
Parameter Sets: Script-DayOfWeek, Workflow-DayOfWeek
Aliases:

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

-DayOfMonth

The day of the month to run the script.

Type: Int32
Parameter Sets: Script-EveryMonth, Script-SpecificMonth, Workflow-EveryMonth, Workflow-SpecificMonth
Aliases:

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

-DayOfWeek

The day of the week to run the script.

Type: SwitchParameter
Parameter Sets: Script-DayOfWeek, Workflow-DayOfWeek
Aliases:

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

-EveryDay

Whether to run the script every day.

Type: SwitchParameter
Parameter Sets: Script-EveryDay, Workflow-EveryDay
Aliases:

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

-EveryHour

Whether to run the script every hour.

Type: SwitchParameter
Parameter Sets: Script-EveryHour, Workflow-EveryHour
Aliases:

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

-EveryMonth

Whether to run the script every month.

Type: SwitchParameter
Parameter Sets: Script-EveryMonth, Workflow-EveryMonth
Aliases:

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

-Hour

The hour to run the script.

Type: Int32
Parameter Sets: Script-EveryDay, Script-DayOfWeek, Script-EveryMonth, Script-SpecificMonth, Workflow-EveryDay, Workflow-DayOfWeek, Workflow-EveryMonth, Workflow-SpecificMonth
Aliases:

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

-Minute

The minute to run the script.

Type: Int32
Parameter Sets: Script-EveryHour, Script-EveryDay, Script-DayOfWeek, Script-EveryMonth, Script-SpecificMonth, Workflow-EveryHour, Workflow-EveryDay, Workflow-DayOfWeek, Workflow-EveryMonth, Workflow-SpecificMonth
Aliases:

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

-Month

The months to run the script.

Type: String[]
Parameter Sets: Script-SpecificMonth, Workflow-SpecificMonth
Aliases:

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

-SpecificMonth

Whether to run the script in specific months.

Type: SwitchParameter
Parameter Sets: Script-SpecificMonth, Workflow-SpecificMonth
Aliases:

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

-Folder

The folder in which to store this schedule. This is for visual use only.

Type: String
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

-Workflow

Specifies the workflow to target.

Type: Workflow
Parameter Sets: Workflow-Cron, Workflow-Continuous, Workflow-OneTime, Workflow-EveryHour, Workflow-EveryDay, Workflow-DayOfWeek, Workflow-EveryMonth, Workflow-SpecificMonth
Aliases:

Required: True
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.