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

Get-VEXMailbox

In this article

    Short Description

    Returns Microsoft Exchange mailboxes.

    Applies to

    Product Edition: Community, Standard, Enterprise, Enterprise Plus

    Syntax

    Get-VEXMailbox -Database <VEXDatabase> [-Name <string[]>]  [<CommonParameters>]

    Detailed Description

    This cmdlet returns an array of Microsoft Exchange mailboxes from the specified mailbox database.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    Accept Wildcard Characters

    Database

    Specifies a Microsoft Exchange mailbox database. The cmdlet will return an array of mailboxes from this mailbox database.

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

    True

    0

    True (ByValue)

    False

    Name

    Specifies a name of the Microsoft Exchange mailbox. The cmdlet will return an array of mailbox with this name.

    String[]

    False

    1

    False

    True

    <CommonParameters>

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

    Examples

    Applied to Veeam Backup & Replication

    Getting a specific mailbox

    This example shows how to get a specific mailbox backed up on the Veeam Backup & Replication sever.

    $session = Get-VBOExchangeItemRestoreSession

    $database = Get-VEXDatabase -Session $session

    Get-VEXMailbox -Database $database -Name "sales"

    You must perform the following steps:

    1. Run the Get-VBOExchangeItemRestoreSession. Save the result to the $session variable.
    2. Run the Get-VEXDatabase cmdlet. Set the $session variable as the Session parameter value.
    3. Run the Get-VEXMailbox cmdlet. Set the $database as the Database parameter value. Specify the Name parameter value

    Applied to Veeam Backup for Microsoft Office 365

    Getting a specific mailbox

    This example shows how to get a specific mailbox backed up on the Veeam Backup for Microsoft Office 365 sever.

    $session = Get-VBRExchangeItemRestoreSession

    $database = Get-VEXDatabase -Session $session

    Get-VEXMailbox -Database $database -Name "sales"

    You must perform the following steps:

    1. Run the Get-VBRExchangeItemRestoreSession cmdlet. Save the result to the $session variable.
    2. Run the Get-VEXDatabase cmdlet. Set the $session variable as the Session parameter value.
    3. Run the Get-VEXMailbox cmdlet. Set the $database as the Database parameter value. Specify the Name parameter value

    Related Commands