Edit

Set-WBSchedule

  • Reference
Module:
WindowsServerBackup

Sets the current schedule for backups.

Syntax

Set-WBSchedule
   [-Policy] <WBPolicy>
   [-Schedule] <DateTime[]>
   [<CommonParameters>]

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 cmdlet, you must be a member of the Administrators group or Backup Operators group.

Examples

Example 1: Set a backup policy schedule

PS C:\> $Policy = Get-WBPolicy
PS C:\> Set-WBSchedule -Policy $Policy -Schedule 12:00,09:00

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.

Parameters

-Policy

Specifies the WBPolicy object to update.

Type:WBPolicy
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Schedule

Specifies the times of day to create a backup. Time values are formatted as HH:MM and separated by a comma.

Type:DateTime[]
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

Inputs

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

DateTime[]

The Set-WBSchedule cmdlet returns the Datetime list that you use to update the policy.