Set-VBRTapeServer

In this article

    Short Description

    Modifies tape server.

    Applies to

    Platform: VMware, Hyper-V

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

    Syntax

    Set-VBRTapeServer -TapeServer <VBRTapeServer> [-Description <string>] [-PassThru] [<CommonParameters>]

    Detailed Description

    This cmdlet modifies tape server that was created before.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    TapeServer

    Specifies the tape server you want to modify.

    Accepts VBRTapeServer type.

    True

    Named

    True (ByValue,
    ByProperty
    Name)

    False

    Description

    Specifies the new description you want to apply to the tape server.

    False

    Named

    False

    False

    PassThru

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

    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

    VBRTapeServer

    Example

    This command modifies the description of the tape server named "Sydney_Tape_Server". The tape server is obtained by running Get-VBRTapeServer and piped down. The description is changed to "Sydney_Remote_Tape_Server". The PassThru parameter is set to get the output and view the details.

    Get-VBRTapeServer -Name "Sydney_Tape_Server" | Set-VBRTapeServer -Description "Sydney_Remote_Tape_Server" -PassThru

    ServerId    : 937f3556-e684-4b33-a8a9-d87d243948f6
    IsAvailable : True
    Id          : 6d3c4fd8-9d0a-454b-9ef0-32f72d577069
    Name        : Sydney_Tape_Server
    Description : Sydney Remote Tape Server

    Related Commands

    Get-VBRTapeServer