Set-VBRTapeVault

Short Description

Modifies a 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.

Note

To modify settings, specify new values for the necessary parameters. The cmdlet will overwrite the previous parameters values with new values. The parameters that you omit will remain unchanged.

Parameters

Parameter

Description

Type

Required

Position

Accept
Pipeline
Input

Vault

Specifies the vault you want to modify.

Accepts the VBRTapeVault object, GUID or string. To get this object, run the Get-VBRTapeVault cmdlet.

True

Named

True (ByValue,
ByProperty
Name)

Name

Specifies the name you want to assign to the vault.

String

True

Named

False

Description

Specifies the description of the vault.

String

False

Named

False

Protect

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

SwitchParameter

False

Named

False

PassThru

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

SwitchParameter

False

Named

False

<CommonParameters>

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

Output Object

VBRTapeVault

Examples

Set-VBRTapeVaultExample 1. Modifying Tape Vault Name and Description [Using Pipeline]

This example shows how to modify the name and the description of the vault named Vault 01.

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

Perform the following steps:

  1. Run the Get-VBRTapeVault cmdlet. Specify the Name parameter value.
  2. Pipe the cmdlet output to the Set-VBRTapeVault cmdlet. Specify the Name and Description parameter values. Provide the PassThru parameter.

Set-VBRTapeVaultExample 2. Modifying Tape Vault Name [Using Variable]

This example shows how to modify the name of the vault to Sydney Remote Storage 02.

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

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

Perform the following steps:

  1. Run the Get-VBRTapeVault cmdlet. Specify the Name parameter value.
  2. Run the Set-VBRTapeVault cmdlet. Set the $vault variable as the Vault parameter values. Specify the Name parameter value.

Related Commands

Get-VBRTapeVault