Get-VEXMailbox

In this article

    Short Description

    Returns Microsoft Exchange mailboxes.

    Applies to: Veeam Backup & Replication, Veeam Backup for Microsoft Office 365

    Product Edition: Community, Standard, Enterprise, Enterprise Plus, Veeam Universal License

    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 Common Parameters section of Microsoft Docs.

    Output Object

    The cmdlet returns the VEXMailbox object that contains Microsoft Exchange mailboxes.

    Examples

    Get-VEXMailboxExample 1. Getting Specific Mailbox [For Veeam Backup & Replication]

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

    $session = Get-VBRExchangeItemRestoreSession

    $database = Get-VEXDatabase -Session $session[1] -Name "DB_0754907780.edb"

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

    Perform the following steps:

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

    Get-VEXMailboxExample 2. Getting Specific Mailbox [For Veeam Backup for Microsoft Office 365]

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

    $session = Get-VBOExchangeItemRestoreSession

    $database = Get-VEXDatabase -Session $session -Name support3backup.onmicrosoft.com

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

    Perform the following steps:

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

    Related Commands