This is an archive version of the document. To get the most up-to-date information, see the current version.

Add-VBRTapeMediaPool

Short Description

Creates a new media pool.

Applies to

Platform: VMware, Hyper-V

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

Syntax

Add-VBRTapeMediaPool -Name <string> -Library <VBRTapeLibrary[]> [-Description <string>] [-Medium <VBRTapeMedium[]>] [-MoveFromFreePool] [-MoveOfflineToVault] [-Vault <VBRTapeVault>] [-EnableEncryption] [-EncryptionKey <VBREncryptionKey>] [-MediaSetCreationPolicy <VBRTapeMediaSetCreationPolicy>] [-MediaSetName <string>] [-RetentionPolicy <VBRTapeMediaPoolRetentionPolicy>] [-NextLibOffline] [-NextLibDrivesBusy] [-NextLibNoMedia] [-EnableMultiStreaming] [-SplitJobFilesBetweenDrives] [-NumberOfStreams <int>] [-WORM][<CommonParameters>]

Detailed Description

This cmdlet creates a new custom media pool.

Run Add-VBRTapeGFSMediaPool to create a GFS media pool.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Name

Specifies the name you want to assign to the media pool.

True

Named

False

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 VBRTapeLibrary, GUID or string type.

True

Named

True (ByValue,
ByProperty
Name)

False

Description

Specifies the description for the created media pool.

If not set, Veeam will enter date and time of creation by default.

False

Named

False

False

Medium

Specifies the array of tapes. The cmdlet will add these tapes to the media pool.

Accepts  VBRTapeMedium, GUID or string type.

False

Named

False

False

MoveFromFreePool

If set, the media pool will be replenished by tapes from the Free media pool.

False

Named

False

False

MoveOfflineToVault

Indicates 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.

False

Named

False

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 VBRTapeVault, GUID or string type.

False

Named

False

False

EnableEncryption

Indicates that Veeam Backup & Replication will encrypt data archived to tape.

Use the EncryptionKey parameter to specify the encryption key you want to use to encrypt the data.

False

Named

False

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 VBREncryptionKey type.

False

Named

False

False

MediaSetCreationPolicy

Specifies the settings of media set you want to apply to this media pool.

If omitted, the media creation policy will be set to 'Never' by default.

Accepts VBRTapeMediaSetCreationPolicy type.

False

Named

False

False

MediaSetName

Specifies the new name you want to assign to the media sets created in this media pool.

If omitted, the media set name will be set to "Media set %date%” by default.

False

Named

False

False

RetentionPolicy

Specifies the retention settings you want to apply to this media pool.

If omitted, the media set name will be set to 'Never' by default.

NOTE: This parameter won`t work in case you use the WORM parameter.

Accepts VBRTapeMediaPoolRetentionPolicy type.

False

Named

False

False

NextLibOffline

If set, the media pool will switch to the next library if the primary library is offline.

Default: true.

False

Named

False

False

NextLibDrivesBusy

If set, the media pool will switch to the next library if the primary library has no available drives.

Default: true.

False

Named

False

False

NextLibNoMedia

If set, the media pool will switch to the next library if the primary library has no available media.

Default: true.

False

Named

False

False

EnableMultiStreaming

Indicates that the media pool can use several drives simultaneously.

Use the NumberOfStreams parameter to set the maximum number of drives that can be used.

Use the SplitJobFilesBetweenDrives parameter to indicate if the multistreaming will be used to split data between tape jobs or between source backup jobs.

False

Named

False

False

SplitJobFilesBetweenDrives

If set, 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.

False

Named

False

False

NumberOfStreams

Used to set value for the EnableMultiStreaming parameter.

Indicates the maximum number of drives that the media pool can use.

Default: 2.

False

Named

False

False

WORM

If set, the cmdlet will add the WORM Media Pool.

NOTE: you cannot set retention policy when the WORM parameter is set to true.

Default: false.

False

Named

False

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

Return Type

VBRTapeMediaPool

Example 1

This command creates a media pool with default settings.

Get the library in which the media pool is created with Get-VBRTapeLibrary and pipe it to Add-VBRTapeMediaPool.

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

Example 2

This command creates a media pool with the following settings:

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

To create the media pool:

  1. Preconfigure media set creation policy. For details, see New-VBRTapeMediaSetCreationPolicy. Save the result to the $mediasetpolicy variable.
  2. Preconfigure retention policy. For details, see New-VBRTapeMediaPoolRetentionPolicy. Save the result to the $retentionpolicy variable.
  3. Run Get-VBRTapeLibrary to get the tape library. Save the result to the $library variable.
  4. Run Get-VBRTapeMedium to select tapes to add to the media pool. Save the array to the $media variable.
  5. Run Get-VBRTapeVault to get the vault for offline tapes. Save the result to the $vault variable.
  6. Run Get-VBREncryptionKey to get the encryption key. Save the result to the $securepassword variable.
  7. Run Add-VBRTapeMediaPool with the saved variables.

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

Related Commands

Get-VBRTapeLibrary

Get-VBRTapeMedium

Get-VBRTapeVault

Get-VBREncryptionKey

New-VBRTapeMediaPoolRetentionPolicy

New-VBRTapeMediaSetCreationPolicy