Table of contents
TLS
TOC
Collapse the table of content
Expand the table of content

Add-WBSystemState

Brian Lich|Last Updated: 4/3/2017

SYNOPSIS

Adds the system state components to the backup policy.

SYNTAX

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

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 cmdlet, you must be a member of the Administrators group or Backup Operators group.

EXAMPLES

Example 1: Add system state to the backup policy

PS C:\> $Policy = Get-WBPolicy -Editable
PS C:\> Add-WBSystemState -Policy $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.

PARAMETERS

-Policy

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

Type: WBPolicy
Parameter Sets: (All)
Aliases: 

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

CommonParameters

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

INPUTS

WBPolicy

This cmdlet accepts a WBPolicy object as input.

OUTPUTS

None

NOTES

Get-WBPolicy

Get-WBSystemState

Remove-WBSystemState

© 2017 Microsoft