Get-VBRVirtualLab
Short Description
Returns virtual labs with main settings.
Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License
Syntax
This cmdlet provides the following parameter sets:
-
AllParameterSets (Default)Get-VBRVirtualLab [<CommonParameters>]
-
IdGet-VBRVirtualLab [-Id <Guid[]>] [<CommonParameters>]
-
NameGet-VBRVirtualLab [-Name <String[]>] [-Platform <VBRVirtualLabPlatform>] [<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-VBRVirtualLabRemoves virtual labs from Veeam Backup & Replication. — to remove virtual labs from Veeam Backup & Replication infrastructure.Add-VBRViSureBackupJobCreates a VMware SureBackup job. This cmdlet is obsolete. Run the Add-VBRSureBackupJob cmdlet instead. — to create a SureBackup job.Set-VBRViSureBackupJobModifies settings of VMware SureBackup jobs. This cmdlet is obsolete. For new SureBackup jobs, run the Set-VBRSureBackupJob cmdlet instead. — 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. |
|
False |
Named |
True (ByPropertyName, ByValue) |
|
Name |
Specifies an array of names for virtual labs. The cmdlet will return an array of virtual labs with the specified names. |
|
False |
Named |
True (ByPropertyName, 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:
|
|
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
|
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.
|