Edit

Share via

Get-WBPolicy

  • Reference
Module:
WindowsServerBackup

Retrieves the current backup policy for the computer.

Syntax

Get-WBPolicy
   [-Editable]
   [<CommonParameters>]

Description

The Get-WBPolicy cmdlet retrieves the backup policy object for the computer. Use the Editable parameter to return the policy information in edit mode.

To use this cmdlet, you must be a member of the Administrators group or Backup Operators group.

Examples

Example 1: Get a current backup policy

PS C:\> Get-WBPolicy

This command gets information about the backup policy object. The information includes all the settings for the backup policy, such as what items to back up, when to run backups, and where to store backups.

Example 2: Get a current backup policy in edit mode

PS C:\> Get-WBPolicy -Editable

This command gets information about the backup policy object, and it makes the policy editable.

Parameters

-Editable

Indicates that the cmdlet returns a current backup policy in edit mode.

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

Inputs

Editable

This cmdlet uses the Editable parameter to set the WBPolicy object in edit mode.

Outputs

WBPolicy

This cmdlet displays the WBPolicy object. The cmdlet returns a null value if no backup policy is set.

Notes

  • If you use the Editable parameter to make changes, set the updated policy as the current policy by using the Set-WBPolicy cmdlet.