Set-WBSchedule
Set-WBSchedule
Sets the current schedule for backups.
Syntax
Parameter Set: Default
Set-WBSchedule [-Policy] <WBPolicy> [-Schedule] <DateTime[]> [ <CommonParameters>]
Detailed Description
The Set-WBSchedule cmdlet sets the current schedule for backups and saves the settings in the WBPolicy object.
The WBPolicy object must be in edit mode. To put the WBPolicy object in edit mode, use the Get-WBPolicy cmdlet with the Editable parameter. The New-WBPolicy cmdlet creates a WBPolicy object that is already in edit mode.
To use this or any other Windows Server 2012 Backup cmdlets, you must be a member of the Administrators group or Backup Operators group.
Parameters
-Policy<WBPolicy>
Specifies the WBPolicy object to update.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Schedule<DateTime[]>
Specifies the times of day to create a backup. Time values are formatted as HH:MM and separated by a comma.
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
WBPolicy,Datetime []
The Set-WBSchedule cmdlet references a Datetime object for the scheduled times and the WBPolicy object for the backup policy to update.
Outputs
The output type is the type of the objects that the cmdlet emits.
DateTime[]
The Set-WBSchedule cmdlet returns the Datetime list that you use to update the policy.
Examples
Example 1: Set a backup policy schedule
This command sets the scheduled times to create backups and saves the information in the WBPolicy object. When you set this policy on the computer, backups are created daily at the specified times.
The first command stores the result of the Get-WBPolicy in the variable named $Policy.
The second command sets the backup schedule in the $Policy variable. The Schedule parameter indicates the times.
PS C:\> $Policy = Get-WBPolicy
PS C:\> Set-WBSchedule -Policy $Policy -Schedule 12:00,09:00