Remove-WBSystemState
Remove-WBSystemState
Removes the request to include all items needed for a system state recovery from the current backup policy (WBPolicy object).
Syntax
Remove-WBSystemState [-Policy] <WBPolicy> [<CommonParameters>]
Detailed Description
The Remove-WBSystemState cmdlet removes the request to include all items needed for a system state recovery from the backup policy (WBPolicy object). Depending on what is included in the WBPolicy object, some of the items that are part of the system state may still be backed up, but you may not be able to use the backup 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? |
1 |
-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 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>Remove-WBSystemState -Policy $policy
None
Description
-----------
Removes the request to include the system state in the items to be backed up from the WBPolicy object $policy. Verify this by looking for the value: $policy.SystemState.