Get-WBPerformanceConfiguration
Get-WBPerformanceConfiguration
Retrieves the current volume backup performance settings.
Syntax
Parameter Set: OverallSetting
Get-WBPerformanceConfiguration [-OverallPerformanceSetting] [ <CommonParameters>]
Parameter Set: Volume
Get-WBPerformanceConfiguration [-Volume] <WBVolume> [ <CommonParameters>]
Detailed Description
The Get-WBPerformanceSetting cmdlet retrieves the current performance settings for volume backups. The settings are applicable only for volume backups; these settings are not applicable for files, folders, system state, or applications. The settings apply globally to all volumes in a backup, or to specific volumes. The valid settings are:
--AlwaysFull: The time to create a backup is proportional to the size of volume being backed up. This setting applies at a global level for all volumes or for specific volumes.
--AlwaysIncremental: Increase the backup speed by just tracking the changes between the last and current backup. This option is not recommended for servers with disk-intensive operation which may experience reduced disk throughput on volumes included in the backup. This can be set at a global level for all volumes or specific for some volumes.
--Custom: This is the global setting reported in case there is a specific volume level setting set.
Parameters
-OverallPerformanceSetting
If specified, indicates that the returned data is to be for the global setting.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Volume<WBVolume>
Specifies the WBVolume object for which the current performance settings are retrieved.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
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.
SwitchParameter, WBVolume
Indicates either global settings or volume settings.
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
Example 1:Retrieve global settings
This example retrieves the global settings for all volumes with the AlwaysIncremental setting.
PS C:\> Get-WBPerformanceSetting -OverallPerformanceSetting AlwaysIncremental
Example 2: Retrieve settings for a volume
This example retrieves the settings for a specific volume with the AlwaysFull setting.
PS C:\> $Backup = Get-WBBackupSet
PS C:\> Get-WBPerformanceSetting -Volume $Backup.Volume[1] AlwaysFull