Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

Add-WBSystemState

Updated: June 3, 2013

Applies To: Windows Server 2012

Add-WBSystemState

Adds the system state components to the backup policy.

Syntax

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




Detailed Description

The Add-WBSystemState cmdlet adds the system state components to a policy contained in the specified WBPolicy object. Use backups created through this policy to perform a system state recovery.

The WBPolicy object must be in edit mode. To put the WBPolicy object in edit mode for a policy that is set as the scheduled backup policy, use the Get-WBPolicy cmdlet with the Editable parameter. The New-WBPolicy cmdlet creates a new WBPolicy object that is already in edit mode.

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 update.


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 Add-WBSystemStateAdd-WBSystemState cmdlet accepts a WBPolicy object as input.


Outputs

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

  • None


    None


Examples

Example 1: Add system state to the backup policy

This example adds a setting to the WBPolicy object to include the system state in backups that you create by using this policy.

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

The second command adds the system state to the backup policy in the $Policy variable.


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

Related topics

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.