Add-WBSystemState
Add-WBSystemState
Adds the items needed to the backup policy (WBPolicy object) so that later you can use backups created with this policy to perform a system state recovery.
Syntax
Add-WBSystemState -Policy <WBPolicy> [<CommonParameters>]
Detailed Description
The Add-WBSystemState cmdlet adds the items needed to the backup policy (WBPolicy object) so that later you can use backups created with this policy to perform a system state recovery.
Parameters
-Policy <WBPolicy>
Specifies the backup policy (WBPolicy object) to update.
Attributes
| Name | Value |
|---|---|
Required? |
true |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
true (ByValue) |
Position? |
named |
-CommonParameter
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, and OutVariable. For more information, see about_CommonParameters.
Input and Return Types
The input type is the type of the objects that you can pipe to the cmdlet. The return type is the type of the objects that the cmdlet emits.
Notes
The WBPolicy object must be in edit mode. To put the WBPolicy object in edit mode for a policy that has been 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 Windows Server Backup cmdlets, you must be a member of the Administrators group or Backup Operators group.
Examples
EXAMPLE 1
C:\PS>Add-WBSystemState -Policy $policy
None
Description
-----------
Adds the setting to the WBPolicy object $policy to include the system state in backups that are created with this policy.