Add-VBRTapeMediaPool

Short Description

Creates a new media pool.

Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License

Syntax

Add-VBRTapeMediaPool -Name <String> [-Description <String>] -Library <VBRTapeLibrary[]>

[-Medium <VBRTapeMedium[]>] [-MoveFromFreePool] [-MoveOfflineToVault] [-Vault <VBRTapeVault>]

[-EnableEncryption] [-EncryptionKey <VBREncryptionKey>] [-KMSServer <VBRKMSServer>]

[-MediaSetCreationPolicy <VBRTapeMediaSetCreationPolicy>] [-MediaSetName <String>]

[-RetentionPolicy <VBRTapeMediaPoolRetentionPolicy>] [-NextLibOffline] [-NextLibDrivesBusy] [-NextLibNoMedia]

[-SplitJobFilesBetweenDrives] [-NumberOfStreams <Int32>] [-WORM] [<CommonParameters>]

Detailed Description

This cmdlet creates a new custom media pool.

Run the Add-VBRTapeGFSMediaPool cmdlet to create a GFS media pool.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Description	Specifies the description for the created media pool. If not set, Veeam Backup & Replication will enter date and time of creation by default.	`String`	False	Named	False
EnableEncryption	Enables encryption for the data archived to tape. Use the `EncryptionKey` or `KMSServer` parameters to specify the encryption key you want to use to encrypt the data.	`SwitchParameter`	False	Named	False
EncryptionKey	Used to set the encryption key for the `EnableEncryption` parameter. Specifies the encryption key you want to use to encrypt the data. Accepts the `VBREncryptionKey` object. To get this object, run the `Get-VBREncryptionKey` cmdlet.	`VBREncryptionKey`	False	Named	False
KMSServer	Used to set the encryption key for the `EnableEncryption` parameter if you use the KMS Server for encryption. Specifies the KMS Server you want to use to encrypt the data. Accepts the `VBRKMSServer` object. To get this object, run the `Get-VBRKMSServer` cmdlet.	`VBRKMSServer`	False	Named	False
Library	Specifies the array of tape libraries. The media pool will use tapes from these libraries. For tape library failover, use `NextLibOffline`, `NextLibDrivesBusy` and/or `NextLibNoMedia` parameters to manage the failover events. Veeam will switch to the next library in order they are added to the `VBRTapeLibrary` object. Accepts the `VBRTapeLibrary` object, GUID or string. To get this object, run the `Get-VBRTapeLibrary` cmdlet.	`VBRTapeLibrary[]`	True	Named	True (ByPropertyName, ByValue)
MediaSetCreationPolicy	Specifies the settings of media set you want to apply to this media pool. If you omit this parameter, the media creation policy will be set to `Never` by default. Accepts the `VBRTapeMediaSetCreationPolicy` object. To create this object, run the `New-VBRTapeMediaSetCreationPolicy` cmdlet.	`VBRTapeMediaSetCreationPolicy`	False	Named	False
MediaSetName	Specifies the new name you want to assign to the media sets created in this media pool. If you omit this parameter, the media set name will be set to `Media set %date%` by default.	`String`	False	Named	False
Medium	Specifies the array of tapes. The cmdlet will add these tapes to the media pool. Accepts the `VBRTapeMedium[]` object, GUID or string. To get this object, run the `Get-VBRTapeMedium` cmdlet.	`VBRTapeMedium[]`	False	Named	False
MoveFromFreePool	Defines that the media pool will be replenished by tapes from the Free media pool.	`SwitchParameter`	False	Named	False
MoveOfflineToVault	Defines that the tapes that go offline must be automatically moved to a vault. Use the `Vault` parameter to specify the vault to which you want to move the tapes from this media pool.	`SwitchParameter`	False	Named	False
Name	Specifies the name you want to assign to the media pool.	`String`	True	Named	False
NextLibDrivesBusy	Defines that the media pool will switch to the next library if the primary library has no available drives. Default: `True`. Note: To disable this option, set the parameter value to `$false`. That is, parameter_name`:$false`.	`SwitchParameter`	False	Named	False
NextLibNoMedia	Defines that the media pool will switch to the next library if the primary library has no available media. Default: `True`. Note: To disable this option, set the parameter value to `$false`. That is, parameter_name`:$false`.	`SwitchParameter`	False	Named	False
NextLibOffline	Defines that the media pool will switch to the next library if the primary library is offline. Default: `True`. Note: To disable this option, set the parameter value to `$false`. That is, parameter_name`:$false`.	`SwitchParameter`	False	Named	False
NumberOfStreams	Used to set value for the `EnableMultiStreaming` parameter. Specifies the maximum number of drives that the media pool can use. Default: `2`.	`Int32`	False	Named	False
RetentionPolicy	Specifies the retention settings you want to apply to this media pool. If you omit this parameter, the media set name will be set to `Never` by default. Note: This parameter will not work in case you use the `WORM` parameter. Accepts the `VBRTapeMediaPoolRetentionPolicy` object. To get this object, run the cmdlet.	`VBRTapeMediaPoolRetentionPolicy`	False	Named	False
SplitJobFilesBetweenDrives	Defines that one tape job will use multiple drives to write data. Drives will process source backup jobs one by one. Default: one drive is used for one tape job.	`SwitchParameter`	False	Named	False
Vault	Used to set vault for the `MoveOfflineToVault` parameter. Specifies the vault to which you want to automatically move the tapes. You can use one vault for several media pools. Accepts the `VBRTapeVault` cmdlet, GUID or string. To get this object, run the `Get-VBRTapeVault` cmdlet.	`VBRTapeVault`	False	Named	False
WORM	Defines that the cmdlet will add the WORM Media Pool. Note: you cannot set retention policy when the `WORM` parameter is set to true. Default: `False`.	`SwitchParameter`	False	Named	False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

VBRTapeMediaPool

Examples

Add-VBRTapeMediaPool Example 1. Creating Media Pool with Default Settings

This example shows how to create a media pool with default settings.

Get-VBRTapeLibrary -Name "HP MSL G3 Series 3.00" | Add-VBRTapeMediaPool -Name "Monthly Full Backups" -MoveFromFreePool

Perform the following steps:

Run the Get-VBRTapeLibrary cmdlet. Specify the Name parameter values.
Pipe the cmdlet output to the Add-VBRTapeMediaPool cmdlet. Specify the Name parameter values. Provide the MoveFromFreePool parameter.

Add-VBRTapeMediaPool Example 2. Creating Media Pool with Specific Settings

This example shows how to create a media pool with the following settings:

Offline tape are moved to vault.
Data on tape is encrypted.

$mediasetpolicy = New-VBRTapeMediaSetCreationPolicy -Type Always

$retentionpolicy = New-VBRTapeMediaPoolRetentionPolicy -Type Cyclic

$library = Get-VBRTapeLibrary -Name "Sydney_Tape_Server"

$media = Get-VBRTapeMedium -Name "00110001"

$vault = Get-VBRTapeVault -Name "Sydney Remote Storage"

$securepassword = Get-VBREncryptionKey -Description "Veeam Administrator"

Add-VBRTapeMediaPool -Name "AD Backups Encrypted" -Description "Active Directory Encrypted Backups" -Library $library -Medium $media -MoveOfflineToVault -Vault $vault -EnableEncryption -EncryptionKey $securepassword -MediaSetCreationPolicy $mediasetpolicy -MediaSetName "AD Daily %date%" -RetentionPolicy $retentionpolicy

Perform the following steps:

Run the New-VBRTapeMediaSetCreationPolicy cmdlet. Set the Always option for the Type parameter. Save the result to the $mediasetpolicy variable.
Run the New-VBRTapeMediaPoolRetentionPolicy cmdlet. Set the Cyclic option for the Type parameter. Save the result to the $retentionpolicy variable.
Run the Get-VBRTapeLibrary cmdlet. Specify the Name parameter value. Save the result to the $library variable.
Run the Get-VBRTapeMedium cmdlet. Specify the Name parameter value. Save the result to the $media variable.
Run the Get-VBRTapeVault cmdlet. Specify the Name parameter value. Save the result to the $vault variable.
Run the Get-VBREncryptionKey cmdlet. Specify the Description parameter value. Save the result to the $securepassword variable.
Run the Add-VBRTapeMediaPool cmdlet. Specify the following settings:
- Specify the Name and the Description parameter values.
- Set the $library variable as the Library parameter value.
- Set the $media variable as the Medium parameter value.
- Provide the MoveOfflineToVault parameter.
- Set the $vault variable as the Vault parameter value.
- Provide the EnableEncryption parameter.
- Set the $securepassword variable as the EncryptionKey parameter value.
- Set the $mediasetpolicy variable as the MediaSetCreationPolicy parameter value.
- Specify the MediaSetName parameter value.
- Set the $retentionpolicy variable as the RetentionPolicy parameter value.