Help Center
Choose product document...
Veeam Backup & Replication 9.5
PowerShell Reference

Set-VBRTapeVault

Short Description

Modifies tape vault.

Applies to

Platform: VMware, Hyper-V

Product Edition: Enterprise, Enterprise Plus

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 enter the corresponding parameters with new values. 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 (by Value
FromPipeline,
ValueFromPipeline
ByPropertyName)

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 about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

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.

PS C:\PS> 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.

PS C:\PS> Set-VBRTapeVault -Vault $vault -Name "Sydney Remote Storage 02"

Related Commands

Get-VBRTapeVault

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Backup Explorers User Guide

PowerShell Reference

RESTful API Reference

Veeam Backup FREE Edition User Guide

Veeam Backup for Microsoft Office 365

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation