Get-VEXMailbox

Short Description

Returns Microsoft Exchange mailboxes.

Applies to

Veeam Backup & Replication, Veeam Backup for Microsoft 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
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)
Name	Specifies an array of Microsoft Exchange mailbox names. The cmdlet will return an array of mailboxes with these names. This parameter accepts wildcard characters.	String[]	False	1	False

Parameter

Description

Type

Required

Position

Accept Pipeline Input

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

True (ByValue)

Name

Specifies an array of Microsoft Exchange mailbox names. The cmdlet will return an array of mailboxes with these names.

This parameter accepts wildcard characters.

String[]

False

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

Output Object

The cmdlet returns the VEXMailbox[] array that contains Microsoft Exchange mailboxes.

Examples

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

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

$session = Get-VBRExchangeItemRestoreSession

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

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

Perform the following steps:

Run the Get-VBRExchangeItemRestoreSession. Save the result to the $session variable.
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.
Run the Get-VEXMailbox cmdlet. Set the $database variable as the Database parameter value. Specify the Name parameter value.

Get-VEXMailbox Example 2. Getting Specific Mailbox [For Veeam Backup for Microsoft 365]

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

$session = Get-VBOExchangeItemRestoreSession

$database = Get-VEXDatabase -Session $session -Name "support3backup*"

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

Perform the following steps:

Run the Get-VBOExchangeItemRestoreSession cmdlet. Save the result to the $session variable.
Run the Get-VEXDatabase cmdlet. Set the $session variable as the Session parameter value. Specify the Name parameter value. Use the * wildcard character to substitute the timestamp. Save the result to the $database variable.
Run the Get-VEXMailbox cmdlet. Set the $database variable as the Database parameter value. Specify the Name parameter value.

Related Commands