Get-VBRNASServer

Short Description

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

Applies to

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

Syntax

This cmdlet provides parameter sets that allow you to:

  • Get all file shares that are added to the Veeam Backup & Replication infrastructure.

Get-VBRNASServer  [<CommonParameters>]

  • Get file shares by the file shares name.

Get-VBRNASServer -Name <string[]>  [<CommonParameters>]

  • Get file shares by the file shares ID.

Get-VBRNASServer -Id <guid[]>  [<CommonParameters>]

  • Get file shares by the name of the enterprise NAS system storage on which they are residing.

Get-VBRNASServer -SANEntity <VBRSANEntity[]>  [<CommonParameters>]

  • Get file shares by the backup that protects these file shares.

Get-VBRNASServer [-Backup <VBRNASBackup>]  [<CommonParameters>]

Detailed Description

This cmdlet returns an array of file shares that are added to the Veeam Backup & Replication infrastructure.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Name

Specifies a name of a file share. The cmdlet will return an array of file shares with the specified name.

String[]

True

Named

False

Id

Specifies an ID of a file share. The cmdlet will return an array of file shares with the specified ID.

Guid[]

True

Named

False

SANEntity

Specifies a name of an enterprise NAS system. The cmdlet will return an array of file shares residing on this NAS system.

VBRSANEntity[]

True

Named

False

Backup

Specifies a backup. The cmdlet will return an array of file shares protected with this backup.

Accepts the VBRNASBackup object. To create this object, run the Get-VBRNASBackup cmdlet.

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.

Output Object

The cmdlet returns the VBRNASServer object that contains settings of file shares added to the Veeam Backup & Replication infrastructure.

Examples

Get-VBRNASServerExample 1. Getting All File Shares

This command gets all file shares added to the Veeam Backup & Replication infrastructure. The cmdlet output will contain settings of these file shares.

Get-VBRNASServer

Type                : SMB

Path                : \\WinSRV2049\Documents

AccessCredentials   :

ProcessingMode      : Direct

StorageSnapshotPath :

ProxyMode           : Automatic

SelectedProxyServer : {}

Id                  : 4916c13e-08bf-488f-ab1b-1624d02189c5

CacheRepository     : Veeam.Backup.Core.CBackupRepository

 

Type                : NFS

Path                : \\LinuxSRV2049\Reports

AccessCredentials   :

ProcessingMode      : Direct

StorageSnapshotPath :

ProxyMode           : Automatic

SelectedProxyServer : {}

Id                  : 678eafe4-ad76-4878-8230-561b4226333c

CacheRepository     : Veeam.Backup.Core.CBackupRepository

Get-VBRNASServerExample 2. Getting File Shares by Name

This command gets the WinSRV2049\Documents file share. The cmdlet output will contain settings of these file shares.

Get-VBRNASServer -Name "\\WinSRV2049\Documents"

Type                : SMB

Path                : \\WinSRV2049\Documents

AccessCredentials   :

ProcessingMode      : Direct

StorageSnapshotPath :

ProxyMode           : Automatic

SelectedProxyServer : {}

Id                  : 4916c13e-08bf-488f-ab1b-1624d02189c5

CacheRepository     : Veeam.Backup.Core.CBackupRepository

Get-VBRNASServerExample 3. Getting File Share by ID

This command gets file share by the file share ID. The cmdlet output will contain settings of these file shares.

Get-VBRNASServer -Id "678eafe4-ad76-4878-8230-561b4226333c"

Type                : NFS

Path                : \\LinuxSRV2049\Reports

AccessCredentials   :

ProcessingMode      : Direct

StorageSnapshotPath :

ProxyMode           : Automatic

SelectedProxyServer : {}

Id                  : 678eafe4-ad76-4878-8230-561b4226333c

CacheRepository     : Veeam.Backup.Core.CBackupRepository

Get-VBRNASServerExample 4. Getting File Share by Backup

This example shows how to get the Fileserv05 (SMB) DB file shares by the backup that protects them. The cmdlet output will contain settings of these file shares.

$nasbackup = Get-VBRNASBackup -Name "Fileserv05 (SMB) DB"
Get-VBRNASServer -Backup $nasbackup

Type                        : SMB
Path                        : \\fileserv05\Documents
AccessCredentials           : fileserv05\Administrator
ProcessingMode              : Direct
StorageSnapshotPath         :
ProxyMode                   : Automatic
SelectedProxyServer         : {}
DirectBackupFailoverEnabled : True
Id                          : a830d2ab-a879-44ed-8107-7e76b8d4b817
CacheRepository             : Veeam.Backup.Core.CBackupRepository
BackupIOControlLevel        : Medium

Perform the following steps:

  1. Run the Get-VBRNASBackup cmdlet. Specify the Name parameter value. Save the result to the $nasbackup variable.
  2. Run the Get-VBRNASServer cmdlet. Set the $nasbackup variable as the Backup parameter value.

Related Commands

Get-VBRNASBackup