Add-WBVolume
Add-WBVolume
Adds the list of source volumes to the backup policy (WBPolicy object).
Syntax
Add-WBVolume [-Policy] <WBPolicy> [-Volume] <WBVolume[]> [<CommonParameters>]
Detailed Description
The Add-WBVolume cmdlet adds the list of source volumes to the backup policy (WBPolicy object).
Parameters
-Policy <WBPolicy>
Specifies the backup policy (WBPolicy object) to update.
Attributes
| Name | Value |
|---|---|
Required? |
true |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
true (ByPropertyName) |
Position? |
1 |
-Volume <WBVolume[]>
Specifies the volumes to add to the current backup policy (WBPolicy object).
Attributes
| Name | Value |
|---|---|
Required? |
true |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
true (ByPropertyName) |
Position? |
2 |
-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-WBVolume -Policy $policy -Volume $volumes
The list of added volumes specified for backup in the WBPolicy object, $policy, including the items that are specified by the $volumes object.
Description
-----------
Adds the list of volumes $volumes for backup to the WBPolicy object $policy.