Get-VBRVirtualLab
Short Description
Returns virtual labs with main settings.
Applies to
Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License
Syntax
Get-VBRVirtualLab [-Id <guid[]>] [-Name <string[]>] [-Platform <VBRVirtualLabPlatform> {VMWare | HyperV | vCD}] [<CommonParameters>] |
Detailed Description
This cmdlet returns the VBRVirtualLab>[] object that contains an array of virtual labs and their main settings. You can use this object with the following cmdlets:
- Remove-VBRVirtualLab - to remove virtual labs from Veeam Backup & Replication infrastructure.
- Add-VBRViSureBackupJob - to create a SureBackup job.
- Set-VBRViSureBackupJob - to modify settings of a SureBackup job.
Parameters
Parameter | Description | Type | Required | Position | Accept Pipeline Input |
|---|---|---|---|---|---|
Id | Specifies an array of IDs for virtual labs. The cmdlet will return an array of virtual labs with the specified ID. | Guid[] | False | Named | True (ByValue, |
Name | Specifies an array of names for virtual labs. The cmdlet will return an array of virtual labs with the specified names. | String[] | False | Named | True (ByValue, |
Platform | Specifies a type of server where the virtual lab is created. The cmdlet will return virtual labs created on the specified platform. You can specify either of the following virtual labs:
| VBRVirtualLabPlatform | 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 VBRVirtualLab>[] object that contains the main settings of VMware virtual labs.
Examples
Example 1. Getting All Virtual Labs
This command returns all virtual labs that are added to the Veeam Backup & Replication infrastructure. The cmdlet output will contain settings of virtual labs.
|
Example 2. Getting Virtual Lab by ID
This command returns the 6b2686ae-9e1b-4c6e-b6fb-842d7155a9ec virtual lab. The cmdlet output will contain settings of the virtual lab.
|
Example 3. Getting Virtual Lab by Name
This command returns the SQL Virtual Lab virtual lab. The cmdlet output will contain settings of the virtual lab.
|
Example 4. Getting Virtual Lab by Platform
This command returns virtual labs created on the VMware.
|