Set-VBRTapeMediaPool

In this article

    Short Description

    Modifies media pool.

    Applies to

    Platform: VMware, Hyper-V

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

    Syntax

    Set-VBRTapeMediaPool -MediaPool <VBRTapeMediaPool> -Library <VBRTapeLibrary[]> [-Name <string>] [-Description <string>] [-MoveFromFreePool] [-MoveOfflineToVault] [-Vault <VBRTapeVault>] [-EnableEncryption] [-EncryptionKey <VBREncryptionKey>] [-MediaSetCreationPolicy <VBRTapeMediaSetCreationPolicy>] [-MediaSetName <string>][-RetentionPolicy <VBRTapeMediaPoolRetentionPolicy>] [-NextLibOffline] [-NextLibDrivesBusy] [-NextLibNoMedia][-EnableMultiStreaming] [-NumberOfStreams <int>] [-SplitJobFilesBetweenDrives] [-PassThru] [-Mode <string> {Paralleling | Failover}]  [<CommonParameters>]

    Detailed Description

    This cmdlet modifies media pool that was created before. To modify settings, you need to specify new values for the necessary parameters. The parameters that you omit will remain unchanged.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    MediaPool

    Specifies the media pool you want to modify.

    Accepts VBRTapeMediaPool type.

    True

    Named

    True (ByValue,
    ByProperty
    Name)

    False

    Library

    Specifies the array of tape libraries whose tapes will be used in this media pool.

    You can add several libraries and use them to switch to another library in case the primary library is offline, has no available drives or no available tapes. Use the NextLibOffline, NextLibDrivesBusy and/or NextLibNoMedia parameters to manage the libraries. Veeam will switch to the neхt library in order they are added to the VBRTapeLibrary object.

    Accepts VBRTapeLibrary, GUID or string type.

    True

    Named

    True (ByProperty
    Name)

    False

    Name

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

    False

    Named

    False

    False

    Description

    Specifies the description for the media pool.

    False

    Named

    False

    False

    Medium

    Specifies the array of tapes you want to add 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.

    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.

    False

    Named

    False

    False

    SplitJobFilesBetweenDrives

    If set, the backup files within one backup set will be written with several drives to several tapes.

    Otherwise, one tape job will use one drive.

    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

    PassThru

    Indicates that the command returns the output object to the Windows PowerShell console.

    False

    Named

    False

    False

    Mode

    Specifies the tape media pool mode.

    You can set either of the following modes:

    • Paralleling: if you set this mode, the tape job will use drives in all libraries parallelly.
    • Failover: if you set this mode, the tape job will use the first library in the list to write data. Other libraries from this media pool will be passive and will be used for failover.

    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 instructs a selected media pool to move the offline tapes to a tape vault.

    1. Run Get-VBRTapeMediaPool to get the media pool. Save it to the $mediapool variable.
    2. Run Get-VBRTapeLibrary to get the library. Save it to the $library variable.
    3. Run Get-VBRTapeVault to get the target vault. Save it to the $vault variable.
    4. Run Set-VBRTapeMediaPool with the saved variables. Use the MoveOfflineToVault parameter to instruct the media pool to move the offline tapes to a vault.

    Set-VBRTapeMediaPool -MediaPool $mediapool -Library $library -MoveOfflineToVault -Vault $vault

    Example 2

    This command adds encryption settings to a selected media pool.

    1. Run Get-VBRTapeMediaPool to get the media pool. Save it to the $mediapool variable.
    2. Run Get-VBRTapeLibrary to get the library. Save it to the $library variable.
    3. Run Get-VBREncryptionKey to get the encryption key. Save it to the $encryptionkey variable.
    4. Run Set-VBRTapeMediaPool with the saved variables. Use the EnableEncryption parameter to instruct the media pool to encrypt the archived data.

    Set-VBRTapeMediaPool -MediaPool $mediapool -Library $library -EnableEncryption -EncryptionKey $encryptionkey

    Related Commands

    Get-VBRTapeMediaPool

    Get-VBRTapeLibrary

    Get-VBRTapeMedium

    Get-VBRTapeVault

    Get-VBREncryptionKey

    New-VBRTapeMediaPoolRetentionPolicy

    New-VBRTapeMediaSetCreationPolicy