Get-VBOLicenseOverviewReport

Short Description

Generates reports on the Veeam Backup for Microsoft 365 license usage.

Syntax

Get-VBOLicenseOverviewReport -StartTime <DateTime> -EndTime <DateTime> -Path <String> -Format <VBOReportFormat> [-Timezone <TimeZoneInfo>] [<CommonParameters>]

Detailed Description

This cmdlet generates reports that contain information on the Veeam Backup for Microsoft 365 license usage.

Parameters

Parameter	Description	Type	Required	Position	Accept Pipeline Input
StartTime	Specifies the start date for the report period. The cmdlet will generate a report which contains information on the Veeam Backup for Microsoft 365 licensing for a period starting from the specified date.	DateTime	True	Named	False
EndTime	Specifies the end date for the report period. The cmdlet will generate a report which contains information on the Veeam Backup for Microsoft 365 licensing for a period ending on the specified date.	DateTime	True	Named	False
Path	Specifies a path to the folder. The cmdlet will save a report to this folder.	String	True	Named	False
Format	Specifies in which format the cmdlet will save the report: PDF CSV	VBOReportFormat	True	Named	False
Timezone	Specifies a timezone that you want to show in the report. The timezone is displayed at the bottom of the report page. Note: If you do not provide this parameter, the cmdlet will generate a report in the UTC timezone.	Accepts the TimeZoneInfo object. To get this object, run the Get-TimeZone cmdlet.	False	Named	False

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

Examples

Get-VBOLicenseOverviewReport Example 1. Generating License Usage Report

This command generates the license usage report with the following settings:

The report period is set from 09/30/2023 to 11/01/2023.
The cmdlet will generate the report in the CSV format.
The cmdlet will generate the report in the UTC timezone.

Get-VBOLicenseOverviewReport -StartTime 09/30/2023 -EndTime 11/01/2023 -Path "C:\share" -Format CSV

Get-VBOLicenseOverviewReport Example 2. Generating License Usage Report with Timezone

This example shows how to generate the license usage report with the following settings:

The report period is set from 09/30/2023 to 11/01/2023.
The cmdlet will generate the report in the CSV format.
The cmdlet will generate the report in the specified timezone.

$timezone = Get-TimeZone

Get-VBOLicenseOverviewReport -StartTime 09/30/2023 -EndTime 11/01/2023 -Path "C:\share" -Format CSV -TimeZone $timezone

Perform the following steps:

Run the Get-TimeZone cmdlet. Save the result to the $timezone variable.

Run the Get-VBOLicenseOverviewReport cmdlet. Specify the following settings:

Provide the StartTime parameter.
Provide the EndTime parameter.
Provide the Path parameter.
Provide the Format parameter.
Set the $timezone variable as the TimeZone parameter value.

Get-VBOLicenseOverviewReport Example 3. Generating License Usage Report for Last Month

This command generates the license usage report with the following settings:

The report period is set for 1 month before today.
The cmdlet will generate the report in the CSV format.
The cmdlet will generate the report in the UTC timezone.

Get-VBOLicenseOverviewReport -StartTime (Get-Date).AddMonths(-1) -EndTime (Get-Date) -Path "C:\share" -Format CSV

Related Commands

Get-TimeZone