Veeam Backup & Replication 10
Veeam Explorers PowerShell Reference
Related documents

Export-VEXItem

Short Description

Exports Exchange organization backups.

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

Product Edition: Community, Standard, Enterprise, Enterprise Plus

Syntax

This cmdlet provides parameter sets that allow you to:

  • To export Exchange organization mailbox items.

Export-VEXItem -Item <VEXItem[]> -To <string> [-PstSizeLimit <uint64>] [-Force]  [<CommonParameters>]

  • To export an Exchange organization mailbox folder.

Export-VEXItem -Folder <VEXFolder> -To <string> [-PstSizeLimit <uint64>] [-Force] [-ContentKeyword <string[]>][<CommonParameters>]

  • To export an Exchange organization mailbox.

Export-VEXItem -Mailbox <VEXMailbox> -To <string> [-PstSizeLimit <uint64>] [-Force] [-ContentKeyword <string[]>][<CommonParameters>]

  • To export databases of Exchange organization mailboxes.

Export-VEXItem -Database <VEXDatabase[]> -To <string> [-PstSizeLimit <uint64>] [-Force] [-ContentKeyword <string[]>]  [<CommonParameters>]

Detailed Description

This cmdlet exports Exchange organization mailbox databases, mailboxes, folders and mailbox items into Personal Folder Files (.PST files). Additionally, the cmdlet exports mailbox items to Outlook Message Files (.MSG files).

Export-VEXItem Note:

  • Before running this cmdlet, you must first start a restore session. For more information on how to start a restore session, see the Start-VBOExchangeItemRestoreSession cmdlet.
  • The machine on which you are going to run restore sessions must have a 64-bit version of Microsoft Outlook 2016, Microsoft Outlook 2013 or Microsoft Outlook 2010 installed.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Accept Wildcard Characters

Item

Specifies items of an Exchange organization mailbox. The cmdlet will export these items.

Accepts the VEXItem[] object. To get this object, run the Get-VEXItem cmdlet.

True

Named

True (ByValue)

False

Folder

Specifies a folder of an Exchange organization mailbox. The cmdlet will export this folder with all its subfolders.

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

True

Named

True (ByValue)

False

Mailbox

Specifies an Exchange organization mailbox that you want to export.

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

True

Named

True (ByValue)

False

Database

Specifies a database of an Exchange organization mailbox. The cmdlet will export this database.

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

True

Named

True (ByValue)

False

To

Specifies a path and a name for the .PST file or a path for .MSG files.

To export databases, mailboxes and folders to a .PST file, specify the path and the name for the .PST file. The cmdlet will create the .PST file with the specified name if it doesn't exist.

To export items to .MSG files, specify the path and the folder. The cmdlet will create the.MSG file for each item in the folder that you specified.

String

True

Named

False

False

PstSizeLimit

Specifies limitations of the .PST file.

Uint64

False

Named

False

 

Force

Defines that the cmdlet will perform export operations without notifying the user.

SwitchParameter

False

Named

False

False

ContentKeyWord

Specifies a keyword to query data for Exchange organization mailbox. The cmdlet will look for the specified keywords in all message fields (From, To, Subject, Body). After that, the cmdlet will export data that contains the specified keywords.

String[]

False

Named

False

False

<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

None.

Examples

Applied to Veeam Backup & Replication

Export-VEXItemExample 1. Exporting Mailbox Items

This example shows how to export mailbox items. The cmdlet will export items with the followiпg settings:

  • The cmdlet will export items that contain the smith keyword.
  • The cmdlet will export items from the Contacts folder to the Smith Contacts.pst file.

$session = Get-VBRExchangeItemRestoreSession

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

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

$contacts = Get-VEXFolder -Mailbox $salesmailbox -Name "Contacts"

$smith = Get-VEXItem -Folder $contacts -Query "smith"

Export-VEXItem -Item $smith -To "C:\North Backup\Sales\Contacts\Smith\Smith Contacts.pst"

Perform the following steps:

  1. Get items with names containing smith from the Contacts folder:
  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. Specify the Name parameter value. Save the result to the $database variable.
  3. Run the Get-VEXMailbox cmdlet. Set the $database variable as the Database parameter value. Specify the Name parameter value. Save the result to the $salesmailbox variable.
  4. Run the Get-VEXFolder cmdlet. Set the $salesmailbox variable as the Mailbox parameter value. Specify the Name parameter value. Save the result to the $contacts variable.
  5. Run the Get-VEXItem cmdlet. Set the $contacts variable as the Folder parameter value. Specify the Query parameter value. Save the result to the $smith variable.
  1. Run the Export-VEXitem cmdlet. Set the $smith variable as the Item parameter value. Specify the To parameter value.

Export-VEXItemExample 2. Exporting Mailbox Folder

This example shows how to export the Contacts folder to the Contacts.pst file.

$session = Get-VBRExchangeItemRestoreSession

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

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

$contacts = Get-VEXFolder -Mailbox $salesmailbox -Name "Contacts"

Export-VEXItem -Folder $contacts -To "C:\North Backup\Sales\Contacts\Contacts.pst"

Perform the following steps:

  1. Get the mailbox folder:
  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. Specify the Name parameter value. Save the result to the $database variable.
  3. Run the Get-VEXMailbox cmdlet. Set the $database variable as the Database parameter value. Specify the Name parameter value. Save the result to the $salesmailbox variable.
  4. Run the Get-VEXFolder cmdlet. Set the $salesmailbox variable as the Mailbox parameter value. Specify the Name parameter value. Save the result to the $contacts variable.
  1. Run the Export-VEXitem cmdlet. Set the $contacts variable as the Folder parameter value. Specify the To parameter value.

Export-VEXItemExample 3. Exporting Mailbox

This example shows how to export the sales mailbox to the Sales.pst file.

$session = Get-VBRExchangeItemRestoreSession

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

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

Export-VEXItem -Mailbox $salesmailbox -To "C:\North Backup\Sales\Sales.pst"

Perform the following steps:

  1. Get the sales mailbox:
  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. Specify the Name parameter value. Save the result to the $database variable.
  3. Run the Get-VEXMailbox cmdlet. Set the $database variable as the Database parameter value. Specify the Name parameter value. Save the result to the $salesmailbox variable.
  1. Run the Export-VEXitem cmdlet. Set the $salesmailbox variable as the Mailbox parameter value. Specify the To parameter value.

Export-VEXItemExample 4. Exporting Database

This example shows how to export the DB_0754907780.edb mailbox database to the DB_0754907780.pst file.

$session = Get-VBRExchangeItemRestoreSession

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

Export-VEXItem -Database $database -To "C:\Backup\DB_0754907780.pst"

Perform the following steps:

  1. Get the mailbox database:
  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. Specify the Name parameter value. Save the result to the $database variable.
  1. Run the Export-VEXitem cmdlet. Set the $database variable as the Database parameter value. Specify the To parameter value.

Applied to Veeam Backup for Microsoft Office 365

Export-VEXItemExample 5. Exporting Mailbox Items

This example shows how to export mailbox items. The cmdlet will export items with the followiпg settings:

  • The cmdlet will export items that contain the smith keyword.
  • The cmdlet will export items from the Contacts folder to the Smith Contacts.pst.

$session = Get-VBRExchangeItemRestoreSession

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

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

$contacts = Get-VEXFolder -Mailbox $mailbox -Name "Contacts"

$smith = Get-VEXItem -Folder $contacts -Query "smith"

Export-VEXItem -Item $smith -To "C:\North Backup\Sales\Contacts\Smith"

Perform the following steps:

  1. Get items with names containing smith from the Contacts folder:
  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. Specify the Name parameter value. Save the result to the $database variable.
  3. Run the Get-VEXMailbox cmdlet. Set the $database variable as the Database parameter value. Specify the Name parameter value. Save the result to the $mailbox variable.
  4. Run the Get-VEXFolder cmdlet. Set the $mailbox variable as the Mailbox parameter value. Specify the Name parameter value. Save the result to the $contacts variable.
  5. Run the Get-VEXItem cmdlet. Set the $contacts variable as the Folder parameter value. Specify the Query parameter value. Save the result to the $smith variable.
  1. Run the Export-VEXitem cmdlet. Set the $smith variable as the Item parameter value. Specify the To parameter value.

Export-VEXItemExample 6. Exporting Mailbox Folder

This example shows how to export the Contacts folder to the Contacts.pst file.

$session = Get-VBOExchangeItemRestoreSession

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

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

$contacts = Get-VEXFolder -Mailbox $salesmailbox

Export-VEXItem -Folder $contacts -To "C:\North Backup\Sales\Contacts\Contacts.pst"

Perform the following steps:

  1. Get the Contacts mailbox folder:
  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 variable as the Database parameter value. Specify the Name parameter value. Save the result to the $salesmailbox variable.
  4. Run the Get-VEXFolder cmdlet. Set the $salesmailbox variable as the Mailbox parameter value. Specify the Name parameter value. Save the result to the $contacts variable.
  1. Run the Export-VEXitem cmdlet. Set the $contacts variable as the Folder parameter value. Specify the To parameter value.

Export-VEXItemExample 7. Exporting Mailbox

This example shows how to export the sales mailbox to the Sales.pst file.

$session = Get-VBOExchangeItemRestoreSession

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

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

Export-VEXItem -Mailbox $salesmailbox -To "C:\North Backup\Sales\Sales.pst"

Perform the following steps:

  1. Get the sales mailbox:
  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 variable as the Database parameter value. Specify the Name parameter value. Save the result to the $salesmailbox variable.
  1. Run the Export-VEXitem cmdlet. Set the $salesmailbox variable as the Mailbox parameter value. Specify the To parameter value.

Export-VEXItemExample 8. Exporting Mailbox Database

This example shows how to export the northsales.onmicrosoft.com mailbox database to the North.pst file.

$session = Get-VBOExchangeItemRestoreSession

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

$salesmailbox = Get-VEXMailbox -Database $database -Name "northsales.onmicrosoft.com"

Export-VEXItem -Database $database -To "C:\North Backup\North.pst"

Perform the following steps:

  1. Get the northsales.onmicrosoft.com mailbox database:
  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 variable as the Database parameter value. Specify the Name parameter value. Save the result to the $salesmailbox variable.
  1. Run the Export-VEXitem cmdlet. Set the $database variable as the Database parameter value. Specify the To parameter value.

Related Commands

This Document Help Center
User Guide for VMware vSphereUser Guide for Microsoft Hyper-VVeeam Backup Enterprise Manager GuideVeeam Agent Management GuideVeeam Cloud Connect GuideVeeam Explorers User GuideVeeam Plug-ins for Enterprise Applications GuideVeeam PowerShell ReferenceVeeam Explorers PowerShell ReferenceVeeam RESTful API ReferenceRequired Permissions for VMware vSphereQuick Start Guide for VMware vSphereQuick Start Guide for Microsoft Hyper-VVeeam Backup for AWS DocumentationVeeam Availability for Nutanix AHV DocumentationVeeam Backup for Microsoft Office 365 DocumentationVeeam ONE DocumentationVeeam Agent for Windows DocumentationVeeam Agent for Linux DocumentationVeeam Management Pack Documentation
I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.