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. | Accepts the VBRSANEntity[] object. To create this object, run the Get-NetAppHost cmdlet. | 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 Microsoft Docs.
Output Object
The cmdlet returns the VBRNASServer object that contains settings of file shares added to the Veeam Backup & Replication infrastructure.
Examples
Example 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.
|
Example 2. Getting File Shares by Name
This command gets the WinSRV2049\Documents file share. The cmdlet output will contain settings of these file shares.
|
Example 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.
|
Example 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.
Perform the following steps:
|
Related Commands