Get-VEXDatabase

Short Description

Returns Microsoft Exchange mailbox databases.

Applies to

Veeam Backup & Replication, Veeam Backup for Microsoft 365

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

Syntax

Get-VEXDatabase [-Session] <IExchangeRestoreSession> [-Name <String[]>] [<CommonParameters>]

Detailed Description

This cmdlet returns Microsoft Exchange mailbox databases. You can use these databases to perform operations with Microsoft Exchange objects by running the following cmdlets:

Parameters

Parameter	Description	Type	Required	Position	Accept Pipeline Input
Session	Specifies an active restore session. The cmdlet will return an array of Microsoft Exchange mailbox databases within the specified restore session.	Accepts the IExchangeRestoreSession object. To get this object, run the Get-VBOExchangeItemRestoreSession or Get-VBRExchangeItemRestoreSession cmdlet.	True	0	True (ByValue)
Name	[For Veeam Backup & Replication] Specifies a name of a Microsoft Exchange mailbox database. The cmdlet will return an array of Microsoft Exchange mailbox databases with this name. [For Veeam Backup for Microsoft 365] Specifies a name of a Microsoft Exchange organization. The cmdlet will return an array of Microsoft Exchange organizations with this name.	String[]	False	1	False

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Session

Specifies an active restore session. The cmdlet will return an array of Microsoft Exchange mailbox databases within the specified restore session.

Accepts the IExchangeRestoreSession object. To get this object, run the Get-VBOExchangeItemRestoreSession or Get-VBRExchangeItemRestoreSession cmdlet.

True

True (ByValue)

Name

[For Veeam Backup & Replication] Specifies a name of a Microsoft Exchange mailbox database. The cmdlet will return an array of Microsoft Exchange mailbox databases with this name.

[For Veeam Backup for Microsoft 365] Specifies a name of a Microsoft Exchange organization. The cmdlet will return an array of Microsoft Exchange organizations with this name.

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 VEXDatabase object that contains Microsoft Exchange mailbox databases.

Examples

Get-VEXDatabase Example 1. Getting Microsoft Exchange Databases within Specified Restore Session [For Veeam Backup & Replication]

This example shows how to get a list of Microsoft Exchange databases within the specified restore session.

$session = Get-VBRExchangeItemRestoreSession

Get-VEXDatabase -Session $session[1]

Perform the following steps:

Run the Get-VBRExchangeItemRestoreSession cmdlet. Save the result to the $session variable.

The cmdlet will return an array of active restore sessions. Note the ordinal number of the necessary restore session. In our example, it is the second restore session in the array.

Run the Get-VEXDatabase cmdlet. Set the $session variable as the Session parameter value.

Get-VEXDatabase Example 2. Getting Microsoft Exchange Database with Specified Name [For Veeam Backup & Replication]

This example shows how to get a specific mailbox database for exploring and restoring mailbox items.

$session = Get-VBRExchangeItemRestoreSession

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

Perform the following steps:

Run the Get-VBRExchangeItemRestoreSession cmdlet to get an active restore session. Save the result to the $session variable.

The cmdlet will return an array of active restore sessions. Note the ordinal number of the necessary restore session. In our example, it is the second restore session in the array.

Run the Get-VEXDatabase cmdlet. Set the $session variable as the Session parameter value. Specify the Name parameter value.

Get-VEXDatabase Example 3. Getting Microsoft Exchange Databases within Specified Restore Session [For Veeam Backup for Microsoft 365]

This example shows how to get mailbox databases for exploring and restoring mailbox items.

$session = Get-VBOExchangeItemRestoreSession

Get-VEXDatabase -Session $session[1]

Perform the following steps:

Run the Get-VBOExchangeItemRestoreSession cmdlet. Save the result to the $session variable.

The cmdlet will return an array of active restore sessions. Note the ordinal number of the necessary restore session. In our example, it is the second restore session in the array.

Run the Get-VEXDatabase cmdlet. Set the $session variable as the Session parameter value.

Get-VEXDatabase Example 4. Getting Microsoft Exchange Database with Specified Name [For Veeam Backup for Microsoft 365]

This example shows how to get a specific mailbox databases for exploring and restoring mailbox items.

$session = Get-VBOExchangeItemRestoreSession

Get-VEXDatabase -Session $session[1] -Name abc.onmicrosoft.com

Perform the following steps:

Run the Get-VBOExchangeItemRestoreSession cmdlet. Save the result to the $session variable.

The cmdlet will return an array of active restore sessions. Note the ordinal number of the necessary restore session. In our example, it is the second restore session in the array.

Run the Get-VEXDatabase cmdlet. Set the $session variable as the Session parameter value. Specify the Name parameter value.

Related Commands

Get-VBOExchangeItemRestoreSession

Get-VBRExchangeItemRestoreSession