Export (0) Print
Expand All

Get-WBSystemState

Updated: June 3, 2013

Applies To: Windows Server 2012

Get-WBSystemState

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

Syntax

Parameter Set: Default
Get-WBSystemState [-Policy] <WBPolicy> [ <CommonParameters>]




Detailed 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 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 a WBPolicy object that contains the backup policy to display.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • WBPolicy

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



Outputs

The output type is the type of the objects that the cmdlet emits.

  • boolean

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


Examples

Example 1: Get the system state setting from the backup

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.


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

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft