Edit

Share via

Get-WBSystemState

  • Reference
Module:
WindowsServerBackup

Gets a Boolean value that indicates whether system state recovery was added to the backup policy.

Syntax

Get-WBSystemState
   [-Policy] <WBPolicy>
   [<CommonParameters>]

Description

The Get-WBSystemState cmdlet gets a Boolean value that indicates whether the ability to perform system state recoveries along with the backups was added to the WBPolicy object. If the system state is not in the list of items to be backed up, use the Add-WBSystemState cmdlet to add it to the list.

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

Examples

Example 1: Get the system state setting from the backup

PS C:\> $Policy = Get-WBPolicy
PS C:\> Get-WBSystemState -Policy $Policy

This example displays a Boolean value that indicates whether the system state setting was added to the WBPolicy object $Policy. The system state setting enables you to use the backups to perform system state recoveries.

The first command stores the result of the Get-WBPolicy cmdlet to the variable named $Policy

The second command displays the result of the Get-WBSystemState cmdlet using the variable named $Policy.

Parameters

-Policy

Specifies a WBPolicy object that contains the backup policy to display.

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

Inputs

WBPolicy

The Get-WBSystemState cmdlet queries the WBPolicy object for the backup policy.

Outputs

boolean

The Get-WBSystemState cmdlet displays a Boolean value to indicate whether the system state is included in the WBPolicy object.