Remove-VBRNASServer

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
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. Note: Microsoft PowerShell enables the Confirm parameter for this cmdlet by default. To disable this option, set the parameter value to $false. That is, Confirm:$false.	SwitchParameter	False	Named	False

Parameter

Description

Type

Required

Position

Accept Pipeline Input

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.

Note: Microsoft PowerShell enables the Confirm parameter for this cmdlet by default. To disable this option, set the parameter value to $false. That is, Confirm:$false.

SwitchParameter

False

Named

False

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

Output Object

None.

Examples

Remove-VBRNASServer) Example 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:

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

Remove-VBRNASServer) Example 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:

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

Related Commands

Get-VBRNASServer