Edit

Share via

Get-WBPolicy

Module:
WindowsServerBackup Module

Gets the current backup policy for the computer.

Syntax

Default (Default) 

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

Description

The Get-WBPolicy cmdlet gets 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.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

Outputs

Object

Notes

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