Get-VBOMailboxProtectionReport

In this article

    Short Description

    Generates reports on mailboxes added to a Microsoft organization.

    Syntax

    Get-VBOMailboxProtectionReport -Path <String> -Format <VBOReportFormat> [-Organization <VBOOrganization>][<CommonParameters>]

    Detailed Description

    This cmdlet generates a report on mailboxes that added to the Microsoft Office 365 and on-premises Microsoft Exchange organizations. This report contains statistical data on protected and unprotected users mailboxes.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept Pipeline Input

    Accept Wildcard Characters

    Path

    Specifies a path to the folder. The cmdlet will save a report to this folder.

    True

    Named

    False

    False

    Format

    Specifies a format of the report. You can select the following types:

    • PDF
    • CSV

    True

    Named

    False

    False

    Organization

    Specifies an organization. The cmdlet will generate a report on mailboxes that are added to this organization.

    Accepts the VBOOrganization object. To get this object, run the Get-VBOOrganization cmdlet.

    False

    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

    <CommonParameters>

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

    Examples

    Get-VBOMailboxProtectionReportExample 1. Generating Mailbox Report

    This command generates a report for mailboxes added to the ABC Microsoft organization. The report is generated with the following settings:

    • The cmdlet will save the report to the folder that is located at the following path: C:\tmp.
    • The cmdlet will generate the report in a CSV format.
    • The cmdlet will generate the report in the UTC timezone.

    $org = Get-VBOOrganization -Name ABC

    Get-VBOMailboxProtectionReport -Path C:\tmp -Format csv -Organization $org

    Perform the following steps:

    1. Run the Get-VBOOrganization cmdlet. Save the result to the $org variable.
    2. Run the Get-VBOMailboxProtectionReport cmdlet. Specify the following settings:
    • Set the $org variable as the Organization parameter value.
    • Specify the Path parameter value.
    • Specify the Format parameter value.

    Get-VBOMailboxProtectionReportExample 2. Generating Mailbox Report with Timezone

    This example shows how to generate a report for mailboxes added to the ABC Microsoft organization. The report is generated with the following settings:

    • The cmdlet will save the report to the folder that is located at the following path: C:\share.
    • The cmdlet will generate the report in a CSV format.
    • The cmdlet will generate the report in the specified timezone.

    $timezone = Get-TimeZone

    Get-VBOMailboxProtectionReport -Path C:\share -Format CSV -TimeZone $timezone

    Perform the following steps:

    1. Run the Get-TimeZone cmdlet. Save the result to the $timezone variable.
    2. Run the Get-VBOMailboxProtectionReport cmdlet. Specify the following settings:
    • Provide the Path parameter.
    • Provide the Format parameter.
    • Set the $timezone variable as the TimeZone parameter value.

    Related Commands