Add-VBRTapeGFSMediaPool

Short Description

Creates a new GFS media pool.

Product Edition: Enterprise, Enterprise Plus, Veeam Universal License

Syntax

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

[-Medium <VBRTapeMedium[]>] [-MoveFromFreePool] [-EnableEncryption] [-EncryptionKey <VBREncryptionKey>]

[-KMSServer <VBRKMSServer>] [-NextLibOffline] [-NextLibDrivesBusy] [-NextLibNoMedia]

[-DailyOverwritePeriod <Int32>] [-WeeklyOverwritePeriod <Int32>] [-MonthlyOverwritePeriod <Int32>]

[-QuarterlyOverwritePeriod <Int32>] [-YearlyOverwritePeriod <Int32>]

[-DailyMediaSetPolicy <VBRTapeGFSMediaSetPolicy>] [-WeeklyMediaSetPolicy <VBRTapeGFSMediaSetPolicy>]

[-MonthlyMediaSetPolicy <VBRTapeGFSMediaSetPolicy>] [-QuarterlyMediaSetPolicy <VBRTapeGFSMediaSetPolicy>]

[-YearlyMediaSetPolicy <VBRTapeGFSMediaSetPolicy>] [-SplitJobFilesBetweenDrives] [-NumberOfStreams <Int32>]

[-WORM] [<CommonParameters>]

Detailed Description

This cmdlet creates a new GFS media pool. The media sets are created with default settings.

Run the New-VBRTapeGFSMediaSetPolicy cmdlet to set other options for media sets.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
DailyMediaSetPolicy	Specifies settings for the daily media set. Accepts the `VBRTapeGFSMediaSetPolicy` object. To create this object, run the `New-VBRTapeGFSMediaSetPolicy` cmdlet.	`VBRTapeGFSMediaSetPolicy`	False	Named	False
DailyOverwritePeriod	Indicates the data retention period for the daily media set (days).	`Int32`	False	Named	False
Description	Specifies the description for the created media pool. If not set, Veeam will enter date and time of creation by default.	`String`	False	Named	False
EnableEncryption	Enables data encryption for data archived to tape. Use the `EncryptionKey` or `KMSServer` parameter 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)
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
MonthlyMediaSetPolicy	Specifies settings for the monthly media set. Accepts the `VBRTapeGFSMediaSetPolicy` object. To create this object, run the `New-VBRTapeGFSMediaSetPolicy` cmdlet.	`VBRTapeGFSMediaSetPolicy`	False	Named	False
MonthlyOverwritePeriod	Indicates the data retention period for the monthly media set (months).	`Int32`	False	Named	False
MoveFromFreePool	Defines that the media pool will be replenished by tapes from the Free 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	Indicates the maximum number of drives that the media pool can use. Set the value to `1` to disable parallel processing. Default: `2`.	`Int32`	False	Named	False
QuarterlyMediaSetPolicy	Specifies settings for the quarterly media set. Accepts the `VBRTapeGFSMediaSetPolicy` object. To create this object, run the `New-VBRTapeGFSMediaSetPolicy` cmdlet.	`VBRTapeGFSMediaSetPolicy`	False	Named	False
QuarterlyOverwritePeriod	Indicates the data retention period for the quarterly media set (months).	`Int32`	False	Named	False
SplitJobFilesBetweenDrives	Defines that Veeam Backup & Replication will use multiple drives simultaneously to process multiple source backup chains within one tape job. Default: one drive is used for one tape job.	`SwitchParameter`	False	Named	False
WeeklyMediaSetPolicy	Specifies settings for the weekly media set. Accepts the `VBRTapeGFSMediaSetPolicy` object. To create this object, run the `New-VBRTapeGFSMediaSetPolicy` cmdlet.	`VBRTapeGFSMediaSetPolicy`	False	Named	False
WeeklyOverwritePeriod	Indicates the data retention period for the weekly media set (weeks).	`Int32`	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
YearlyMediaSetPolicy	Specifies settings for the yearly media set. Accepts the `VBRTapeGFSMediaSetPolicy` object. To create this object, run the `New-VBRTapeGFSMediaSetPolicy` cmdlet.	`VBRTapeGFSMediaSetPolicy`	False	Named	False
YearlyOverwritePeriod	Indicates the data retention period for the yearly media set (years).	`Int32`	False	Named	False

<CommonParameters>

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

Output Object

VBRTapeGFSMediaPool

Examples

Creating GFS Media Pool with Default Settings and Custom Retention Periods

This example shows how to create a GFS media pool with default settings and customized retention periods.

$library = Get-VBRTapeLibrary -Name "HP MSL G3 Series 9.50"

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

Add-VBRTapeGFSMediaPool -Name "GFS Media Pool" -Library $library -MoveFromFreePool -EnableEncryption -EncryptionKey $encryption -DailyOverwritePeriod 30 -WeeklyOverwritePeriod 8 -MonthlyOverwritePeriod 12 -QuarterlyOverwritePeriod 8 -YearlyOverwritePeriod 5

Perform the following steps:

Run the Get-VBRTapeLibrary cmdlet. Specify the Name parameter value. Save the result to the $library variable.
Run the Get-VBREncryptionKey cmdlet. Specify the Description parameter value. Save the result it to the $encryption variable.
Run the Add-VBRTapeGFSMediaPool cmdlet. Specify the following settings:
- Specify the Name parameter value.
- Set the $library variable as the Library parameter value.
- Provide the MoveFromFreePool parameter.
- Provide the EnableEncryption parameter.
- Set the $encryption variable as the EncryptionKey parameter value.
- To define retention settings, provide the DailyOverwritePeriod, WeeklyOverwritePeriod, MonthlyOverwritePeriod, QuarterlyOverwritePeriod, YearlyOverwritePeriod parameter values.