Remove-VBRNASServer

In this article

    Short Description

    Removes file shares that are added to the Veeam Backup & Replication infrastructure.

    Applies to

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

    Syntax

    Remove-VBRNASServer -Server <VBRNASServer[]> [-WhatIf] [-Confirm]  [<CommonParameters>]

    Detailed Description

    This cmdlet removes file shares that are added to the Veeam Backup & Replication infrastructure.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    Accept Wildcard Characters

    Server

    Specifies an array of file shares. The cmdlet will remove these file shares from the Veeam Backup & Replication infrastructure.

    Accepts the VBRNASServer[] object. To get this object, run the Get-VBRNASServer cmdlet.

    True

    Named

    True (ByValue, ByPropertyName)

     

    WhatIf

    Defines that the cmdlet will write a message that describes the effects of running the cmdlet without actually performing any action.

    SwitchParameter

    False

    Named

    False

     

    Confirm

    Defines that the cmdlet will display a prompt that asks if the user is sure that he wants to continue.

    SwitchParameter

    False

    Named

    False

     

    <CommonParameters>

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

    Examples

    Remove-VBRNASServerExample 1. Removing all File Shares

    This example shows how to remove all file shares that are added to the Veeam Backup & Replication infrastructure.

    $fileshare = Get-VBRNASServer

    Remove-VBRNASServer -Server $fileshare

    Perform the following steps:

    1. Run the Get-VBRNASServer cmdlet. Save the result to the $fileshare variable.
    2. Run the Remove-VBRNASServer cmdlet. Set the $fileshare variable as the Server parameter value.

    Remove-VBRNASServerExample 2. Removing Specific File Share

    This example shows how to remove the \\WinSRV2049\Documents file share that is added to the Veeam Backup & Replication infrastructure. The cmdlet will display a prompt that asks if the user is sure that he wants to continue.

    $fileshare = Get-VBRNASServer -Name "\\WinSRV2049\Documents"

    Remove-VBRNASServer -Server $fileshare -Confirm

    Perform the following steps:

    1. Run the Get-VBRNASServer cmdlet. Save the result to the $fileshare variable.
    2. Run the Remove-VBRNASServer cmdlet. Set the $fileshare variable as the Server parameter value. Specify the Confirm parameter.

    Related Commands

    Get-VBRNASServer

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.