Initialize-WssBackupDisk
Initialize-WssBackupDisk
Prepares a disk for, or removes a disk from, a backup.
Syntax
Parameter Set: AddParamSet
Initialize-WssBackupDisk [-Disk] <Disk> [-Name] <String> [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: RemoveParamSet
Initialize-WssBackupDisk [-Disk] <Disk> [-Remove] [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Initialize-WssBackupDisk cmdlet prepares a disk to use as storage for a backup or removes a disk from a backup. When the cmdlet prepares a disk for backup storage, it automatically formats the disk.
Parameters
-Disk<Disk>
Specifies the disk to add to or remove from a backup.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-Force
Forces the command to run without asking for user confirmation.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Name<String>
Specifies the name of the backup disk.
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Remove
Indicates that the cmdlet removes the disk from a backup.
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
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.
Outputs
The output type is the type of the objects that the cmdlet emits.
- Disk
Examples
Example 1: Initialize a backup disk
This example initializes a backup disk.
The first command gets a list of available disks and stores it in the variable named $ContosoBUDisk515.
The second command initializes the first backup disk (located in position 0) in the array in $ContosoDisk515 and gives the new backup disk the name ContosoWSEBackup40.
PS C:\> $ContosoBUDisk515 = Get-WssDisk
PS C:\> Initialize-WssBackupDisk -Disk $ContosoDisk515[0] -Name "ContosoWSEBackup40"