This is an archive version of the document. To get the most up-to-date information, see the current version.

Get-VBOLicenseOverviewReport

In this article

Short Description

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

Syntax

Get-VBOLicenseOverviewReport -StartTime <datetime> -EndTime <datetime> -Path <string> -Format <VBOReportFormat> {PDF | CSV} [-Timezone <TimeZoneInfo>] [<CommonParameters>]

Detailed Description

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

Parameters

Parameter	Description	Required	Position	Accept Pipeline Input	Accept Wildcard Characters
StartTime	Specifies the start date for the report period. The cmdlet will generate a report which contains information on the Veeam Backup for Microsoft Office 365 licensing for a period starting from the specified date.	True	Named	False	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 Office 365 licensing for a period ending on the specified date.	True	Named	False	False
Path	Specifies a target path for the log export. This cmdlet will export the report to this destination.	True	Named	False	False
Format	Specifies in which format the cmdlet will save the report: PDF CSV	True	Named	False	False
Timezone	Specifies a timezone that you want to show in the report. The timezone is displayed at the bottom of the report page. Accepts the TimeZoneInfo object. To get this object, run the Get-TimeZone cmdlet. Note: If you do not provide this parameter, the cmdlet will generate a report in the UTC timezone.	False	Named	False	False

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see 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/2018 to 11/01/2018.
The cmdlet will generate the report in a CSV format.
The cmdlet will generate the report in the UTC timezone.

Get-VBOLicenseOverviewReport -StartTime 09/30/2018 -EndTime 11/01/2018 -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/2018 to 11/01/2018.
The cmdlet will generate the report in a CSV format.
The cmdlet will generate the report in the specified timezone.

$timezone = Get-TimeZone

Get-VBOLicenseOverviewReport -StartTime 09/30/2018 -EndTime 11/01/2018 -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.

Related Commands

Get-TimeZone