Set-VBRTapeVault

In this article

    Short Description

    Modifies tape vault.

    Applies to

    Platform: VMware, Hyper-V

    Product Edition: Enterprise, Enterprise Plus, Veeam Universal License

    Syntax

    Set-VBRTapeVault -Vault <VBRTapeVault> [-Name <String>] [-Description <String>] [-Protect] [-PassThru] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

    Detailed Description

    This cmdlet modifies tape vault 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

    Vault

    Specifies the vault you want to modify.

    Accepts VBRTapeVault, GUID or string type.

    True

    Named

    True (ByValue,
    ByProperty
    Name)

    False

    Name

    Specifies the name you want to assign to the vault.

    True

    Named

    False

    False

    Description

    Specifies the description of the vault.

    False

    Named

    False

    False

    Protect

    Indicates that all tapes moved to this media vault are automatically protected.

    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

    VBRTapeVault

    Example 1

    This command modifies the name and the description of the vault named "Vault 01". The vault object is obtained by running Get-VBRTapeVault and piped down. The PassThru parameter is set to get the output and view the details.

    Get-VBRTapeVault -Name "Vault 01" | Set-VBRTapeVault -Name "Sydney Remote Storage" -Description "Secondary Sydney Remote Storage" -PassThru

    Location    : Sydney Offsite Storage
    Medium      : {}
    Id          : 4be3b4c9-a620-4abd-a68b-b8a697115781
    Name        : Sydney Remote Storage 02
    Description : Secondary Sydney Remote Storage

    Example 2

    This command modifies the name of the vault represented by the $vault variable. The vault object is obtained by running Get-VBRTapeVault and assigned to the variable beforehand.

    Set-VBRTapeVault -Vault $vault -Name "Sydney Remote Storage 02"

    Related Commands

    Get-VBRTapeVault