Help Center
Choose product document...
Veeam Backup & Replication 9.5 Update 4
Veeam Explorers PowerShell Reference

Get-VEXMailbox

Short Description

Returns mailboxes.

Applies to

Product Edition: Community, Standard, Enterprise, Enterprise Plus

Syntax

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

Detailed Description

This cmdlet returns mailboxes from the specified mailbox database.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Database

Specifies a mailbox database. The cmdlet will return all 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 mailbox. The cmdlet will return the mailbox with this name.

False

1

False

True

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Example 1

[For Veeam Backup for Microsoft Office 365] This example shows how to get the sales mailbox.

  1. Get a mailbox database:
  1. Run the Get-VBOExchangeItemRestoreSession cmdlet to get an active restore session. Save the result to the $session variable.
  2. Run the Get-VEXDatabase cmdlet with the $session variable to get the mailbox database. Save the result to the $database variable.
  1. Run the Get-VEXMailbox cmdlet with the $database variable and the Name parameter to get the specific mailbox from the mailbox database.

$session = Get-VBOExchangeItemRestoreSession

$database = Get-VEXDatabase -Session $session

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

Example 2

[For Veeam Backup & Replication]  This example shows how to get the sales mailbox.

  1. Get a mailbox database:
  1. Run the Get-VBRExchangeItemRestoreSession cmdlet to get an active restore session. Save the result to the $session variable.
  2. Run the Get-VEXDatabase cmdlet with the $session variable to get the mailbox database. Save the result to the $database variable.
  1. Run the Get-VEXMailbox cmdlet with the $database variable and the Name parameter to get the specific mailbox from the mailbox database.

$session = Get-VBRExchangeItemRestoreSession

$database = Get-VEXDatabase -Session $session

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

Related Commands

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Agent Management Guide

Veeam Explorers User Guide

Backup and Restore of SQL Server Databases

Veeam Plug-ins for Enterprise Applications

PowerShell Reference

Veeam Explorers PowerShell Reference

RESTful API Reference

Required Permissions

Veeam Availability for Nutanix AHV

Veeam Backup for Microsoft Office 365 Documentation

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation