Get-WBSystemState
Get-WBSystemState
Gets a Boolean value that indicates whether the ability to perform system state recoveries with the backups has been added to the backup policy (WBPolicy object).
Syntax
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 with the backups has been added to the backup policy (WBPolicy object). If the system state is not included in the list of items to be backed up, use the Add-WBSystemState cmdlet to add it to the list.
Parameters
-Policy <WBPolicy>
Specifies the backup policy (WBPolicy object) to display information for.
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
- To use Windows Server Backup cmdlets, you must be a member of the Administrators group or Backup Operators group.
Examples
EXAMPLE 1
C:\PS>Get-WBSystemState -Policy $policy
A Boolean value of False or True.
Description
-----------
Displays whether the system state setting was added to the WBPolicy object $policy to enable the backups to be used to perform system state recoveries.