Get-WBVssBackupOption
Get-WBVssBackupOption
Retrieves a VSS setting from the backup policy.
Syntax
Parameter Set: Default
Get-WBVssBackupOption [-Policy] <WBPolicy> [ <CommonParameters>]
Detailed Description
The Get-WBVSSBackupOptions cmdlet retrieves a setting that determines whether the backups created through the WBPolicy object are Volume Shadow Copy Service (VSS) copy backups or VSS full backups. For more information about VSS copy backups and VSS full backups, or to change this setting, refer to the Set-WBVSSBackupOptions cmdlet.
To use Windows Server 2012 Backup cmdlets, you must be a member of the Administrators group or Backup Operators group.
Parameters
-Policy<WBPolicy>
Specifies the WBPolicy object to display.
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 (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
WBPolicy
The Get-WBVssBackupOptions cmdlet queries the WBPolicy object.
Outputs
The output type is the type of the objects that the cmdlet emits.
Microsoft.Windows.ServerBackup.Commands.VssBackupOptions
The Get-WBVssBackupOptions cmdlet returns either VssCopyBackup or VssFullBackup, depending on the option specified in the WBPolicy object.
Examples
Example 1: Get the VSS setting from the backup policy
This example gets the VSS setting, either VssCopyBackup or VssFullBackup.
The first command stores the result ofthe Get-WBPolicy cmdlet in the variable named $Policy.
The second command gets the VSS setting from the variable $Policy.
PS C:\> $Policy = Get-WBPolicy
PS C:\> Get-WBVssBackupOptions -Policy $Policy
Related topics
Set-WBVSSBackupOptions