NAME

New-PSUSchedule

SYNOPSIS

Creates a new schedule within PSU.

SYNTAX

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

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

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

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

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

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

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

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

DESCRIPTION

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

PARAMETERS

-AppToken <String>

An app token to access the PSU API.

Required? false

Position? named

Default value None

Accept pipeline input? False

Aliases none

Accept wildcard characters? false

-ComputerName <String>

The HTTP address of the PSU REST API server.

Required? false

Position? named

Default value None

Accept pipeline input? False

Aliases Uri

Accept wildcard characters? false

-Continuous [<SwitchParameter>]

Runs a job continously with an optional delay between executions.

Required? true

Position? named

Default value False

Accept pipeline input? False

Aliases none

Accept wildcard characters? false

-Credential <Variable>

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

Required? false

Position? named

Default value None

Accept pipeline input? False

Aliases none

Accept wildcard characters? false

-Cron <String>

The CRON schedule to use for this schedule.

Required? true

Position? 2

Default value None

Accept pipeline input? False

Aliases none

Accept wildcard characters? false

-Delay <TimeSpan>

The delay inbetween continous job executions.

Required? false

Position? named

Default value None

Accept pipeline input? False

Aliases none

Accept wildcard characters? false

-DelayHour <Int32>

The delay in hours inbetween continous job executions.

Required? false

Position? named

Default value None

Accept pipeline input? False

Aliases none

Accept wildcard characters? false

-DelayMinute <Int32>

The delay in minutes inbetween continous job executions.

Required? false

Position? named

Default value None

Accept pipeline input? False

Aliases none

Accept wildcard characters? false

-DelaySecond <Int32>

The delay in seconds inbetween continous job executions.

Required? false

Position? named

Default value None

Accept pipeline input? False

Aliases none

Accept wildcard characters? false

-Script <Script>

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

Required? true

Position? 1

Default value None

Accept pipeline input? True (ByValue)

Aliases none

Accept wildcard characters? false

-TimeZone <String>

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

Required? false

Position? named

Default value None

Accept pipeline input? False

Aliases none

Accept wildcard characters? false

-Environment <String>

The name of the environment to run the script within.

Required? false

Position? named

Default value None

Accept pipeline input? False

Aliases none

Accept wildcard characters? false

-OneTime <DateTime>

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.

Required? false

Position? named

Default value None

Accept pipeline input? False

Aliases none

Accept wildcard characters? false

-Description <String>

Description for the schedule.

Required? false

Position? named

Default value None

Accept pipeline input? False

Aliases none

Accept wildcard characters? false

-Name <String>

Name of the schedule to display in the admin console.

Required? false

Position? named

Default value None

Accept pipeline input? False

Aliases none

Accept wildcard characters? false

-UseDefaultCredentials [<SwitchParameter>]

Use default credentials when connecting to the management API

Required? false

Position? named

Default value False

Accept pipeline input? False

Aliases none

Accept wildcard characters? false

-Condition <ScriptBlock>

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

Required? false

Position? named

Default value None

Accept pipeline input? False

Aliases none

Accept wildcard characters? false

-Integrated [<SwitchParameter>]

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

Required? false

Position? named

Default value False

Accept pipeline input? False

Aliases none

Accept wildcard characters? false

-Paused [<SwitchParameter>]

Whether this schedule is paused.

Required? false

Position? named

Default value False

Accept pipeline input? False

Aliases none

Accept wildcard characters? false

-Timeout <Int32>

The timeout in minutes for this schedule.

Required? false

Position? named

Default value None

Accept pipeline input? False

Aliases none

Accept wildcard characters? false

-RandomDelay [<SwitchParameter>]

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

Required? false

Position? named

Default value False

Accept pipeline input? False

Aliases none

Accept wildcard characters? false

-AvailableInBranch <String[]>

Branches that this schedule will run in.

Required? false

Position? named

Default value None

Accept pipeline input? False

Aliases none

Accept wildcard characters? false

-Computer <String>

Computer or computer group that will run this schedule.

Required? false

Position? named

Default value None

Accept pipeline input? False

Aliases none

Accept wildcard characters? false

-Parameters <Hashtable>

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

Required? false

Position? named

Default value None

Accept pipeline input? False

Aliases none

Accept wildcard characters? false

-RandomDelayMaximum <Int32>

The maximum number of seconds to delay.

Required? false

Position? named

Default value None

Accept pipeline input? False

Aliases none

Accept wildcard characters? false

-TrustCertificate [<SwitchParameter>]

Whether the cmdlet should ignore certificate issues.

Required? false

Position? named

Default value False

Accept pipeline input? False

Aliases none

Accept wildcard characters? false

-Day <String[]>

The day of the week to run the script.

Required? true

Position? named

Default value None

Accept pipeline input? False

Aliases none

Accept wildcard characters? false

-DayOfMonth <Int32>

The day of the month to run the script.

Required? true

Position? named

Default value None

Accept pipeline input? False

Aliases none

Accept wildcard characters? false

-DayOfWeek [<SwitchParameter>]

The day of the week to run the script.

Required? true

Position? named

Default value False

Accept pipeline input? False

Aliases none

Accept wildcard characters? false

-EveryDay [<SwitchParameter>]

Whether to run the script every day.

Required? true

Position? named

Default value False

Accept pipeline input? False

Aliases none

Accept wildcard characters? false

-EveryHour [<SwitchParameter>]

Whether to run the script every hour.

Required? true

Position? named

Default value False

Accept pipeline input? False

Aliases none

Accept wildcard characters? false

-EveryMonth [<SwitchParameter>]

Whether to run the script every month.

Required? true

Position? named

Default value False

Accept pipeline input? False

Aliases none

Accept wildcard characters? false

-Hour <Int32>

The hour to run the script.

Required? false

Position? named

Default value None

Accept pipeline input? False

Aliases none

Accept wildcard characters? false

-Minute <Int32>

The minute to run the script.

Required? false

Position? named

Default value None

Accept pipeline input? False

Aliases none

Accept wildcard characters? false

-Month <String[]>

The months to run the script.

Required? true

Position? named

Default value None

Accept pipeline input? False

Aliases none

Accept wildcard characters? false

-SpecificMonth [<SwitchParameter>]

Whether to run the script in specific months.

Required? true

Position? named

Default value False

Accept pipeline input? False

Aliases none

Accept wildcard characters? false

-Folder <String>

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

Required? false

Position? named

Default value None

Accept pipeline input? False

Aliases none

Accept wildcard characters? false

<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

UniversalAutomation.Script

OUTPUTS

System.Object

NOTES

-------------------------- 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.

RELATED LINKS