This is an archive version of the document. To get the most up-to-date information, see the current version.

Set-VBRTapeMedium

Short Description

Modifies tape properties.

Applies to

Platform: VMware, Hyper-V

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

Syntax

Set-VBRTapeMedium -Medium <VBRTapeMedium> [-Name <String>] [-Description <String>] [-PassThru] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

Detailed Description

This cmdlet modifies properties of a selected tape. You can modify name and/or description of the tape. 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
Medium	Specifies tape you want to modify. Accepts VBRTapeMedium, GUID or string type.	True	Named	True (ByValue, ByProperty Name) or False	False
Name	Specifies the new name you want to assign to the tape.	False	Named	False	False
Description	Specifies the new description you want to assign to the tape.	False	Named	False	False
PassThru	Indicates that the command returns the output object to the Windows PowerShell console.	False	Named	False	False

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

Return Type

VBRTapeMedium

Example 1

This command renames the '0014001F' tape into 'SQL 9/2014' and sets a description for it.

The tape is obtained with Get-VBRTapeMedium and piped down.

Get-VBRTapeMedium -Name "0014001F" | Set-VBRTapeMedium -Name "SQL 9/2014" -Description "SQL DB monthly full backups: Sept/2014"

Example 2

This command renames a selected tape into 'SQL encrypted'.

The tape is obtained with Get-VBRTapeMedium and assigned to the '$tape' variable beforehand.

Set-VBRTapeMedium -Medium $tape -Name "SQL encrypted"

Related Commands

Get-VBRTapeMedium