Get-VBRInstanceLicenseSummary
Short Description
Returns details on the per-instance license usage.
Applies to
Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License
Syntax
Get-VBRInstanceLicenseSummary -License <VBRInstalledLicense> [<CommonParameters>] |
Detailed Description
This cmdlet returns the VBRInstanceLicenseSummary object that contains details on the per-instance license usage.
Parameters
Parameter | Description | Type | Required | Position | Accept Pipeline Input |
|---|---|---|---|---|---|
License | Specifies a license. The cmdlet will return details on the per-instance license usage for this license. | Accepts the VBRInstalledLicense object. To get this object, run the Get-VBRInstalledLicense cmdlet. | True | Named | False |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.
Output Object
VBRInstanceLicenseSummary
Contains details on the per-instance license usage.
Properties
Property | Type | Description |
|---|---|---|
LicensedInstancesNumber | int | Total number of instances that are available in the license scope. |
UsedInstancesNumber | int | Number of instances that have already been used. |
NewInstancesNumber | int | Number of new instances. |
Object | Details on protected workloads. | |
Workload | Protected workloads. |
Examples
Getting Details on Per-Instance License
This example shows how to get details on the per-socket license usage.
$license = Get-VBRInstalledLicense Get-VBRInstanceLicenseSummary -License $license LicensedInstancesNumber : 1000 UsedInstancesNumber : 2 NewInstancesNumber : 0 RentalInstancesNumber : 0 Object : {Veeam.Backup.PowerShell.Infos.VBRInstanceLicenseSummaryObject} Workload : {BackupServer01, SQLServer05} |
Perform the following steps:
- Run the Get-VBRInstalledLicense cmdlet. Save the result to the $license variable.
- Run the Get-VBRInstanceLicenseSummary cmdlet. Set the $license variable as the License parameter value.
The cmdlet output will contain the following details on the per-instance license usage: LicensedInstancesNumber, UsedInstancesNumber, NewInstancesNumber, RentalInstancesNumber, Object and Workload.
Related Commands