Set-SCDWJobSchedule
Set-SCDWJobSchedule
Sets the schedule for a Data Warehouse job.
Syntax
Parameter Set: Default
Set-SCDWJobSchedule -JobName <String> [-ComputerName <String> ] [-DailyFrequency <Nullable`1> ] [-DailyStart <Nullable`1> ] [-ScheduleType <ScheduleTypeEnum> ] [-WeeklyFrequency <String[]> ] [-WeeklyStart <Nullable`1> ] [ <CommonParameters>]
Detailed Description
The Set-SCDWJobSchedule cmdlet configures the schedule for Data Warehouse jobs. The schedule can be configured on a daily basis or on a weekly basis. For a daily schedule, you must specify the time interval at which the job recurs (DailyFrequency) and the time of day at which this recurrence starts (DailyStart). For a weekly schedule, you must specify the time of day (WeeklyStart) at which the job should run and the list of days for which this start time is effective (WeeklyFrequency).
Parameters
-ComputerName<String>
Specifies the name of the server on which the Data Warehouse management server is installed.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
. |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-DailyFrequency<Nullable`1>
Specifies the recurrence frequency of the scheduled job for a daily schedule.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-DailyStart<Nullable`1>
Specifies the time at which the scheduled job will start for a daily schedule. Specify the start time in the hh:mm format.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-JobName<String>
Specifies the Data Warehouse job for which the schedule is being configured.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ScheduleType<ScheduleTypeEnum>
Specifies the schedule as Daily or Weekly. The default value is Daily.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WeeklyFrequency<String[]>
Specifies the days on which the job will run for a weekly schedule. The job will start according to the time specified by the WeeklyStart parameter. Use a comma to separate multiple days (for example: "Tuesday, Thursday").
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WeeklyStart<Nullable`1>
Specifies the time of day at which the job will Start for a weekly schedule(for example: 8:00, 16:00). The job will begin at this time on the days specified by the WeeklyFrequency parameter. Specify the start time in the hh:mm format.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
- None.
Outputs
The output type is the type of the objects that the cmdlet emits.
- None.
Notes
- Valid schedule parameter combinations are as follows:
1. -ScheduleType (Daily), -DailyFrequency, -DailyStart
2. -ScheduleType (Weekly), -WeeklyFrequency, -WeeklyStart
You cannot configure a job with both a weekly schedule and a daily schedule.
Examples
-------------------------- EXAMPLE 1 --------------------------
Description
-----------
This command schedules the Extract_SM1 job to run daily, every hour, starting at 6 A.M. and recurring through the end of the day.
C:\PS>Set-SCDWJobSchedule -JobName Extract_SM1 -ScheduleType Daily -DailyStart 06:00 -DailyFrequency 01:00
-------------------------- EXAMPLE 2 --------------------------
Description
-----------
This command schedules the Extract_SM1 job to run on Tuesdays and Thursdays at 6 A.M.
C:\PS>Set-SCDWJobSchedule -JobName Extract_SM1 -ScheduleType Weekly -WeeklyFrequency Tuesday, Thursday -WeeklyStart 06:00
Related topics
Getting Started with Service Manager Cmdlets for Windows PowerShell
Disable-SCDWJobSchedule
Enable-SCDWJobSchedule
Get-SCDWJobSchedule