Applies to: Exchange Server 2013
Topic Last Modified: 2012-07-12
Use the Get-SiteMailboxDiagnostics cmdlet to view important event-related data for each site mailbox. This information can be used to troubleshoot site mailbox issues.
For information about the parameter sets in the Syntax section below, see Syntax.
Syntax
Get-SiteMailboxDiagnostics -Identity
<RecipientIdParameter> [-BypassOwnerCheck
<SwitchParameter>] [-Organization
<OrganizationIdParameter>] [-Confirm
[<SwitchParameter>]] [-SendMeEmail <SwitchParameter>]
[-WhatIf [<SwitchParameter>]]
|
Examples
EXAMPLE 1
This example returns the event information for the site mailbox by using its display name Marketing Events 2013.
 Copy Code |
|
|---|---|
Get-SiteMailboxDiagnostics -BypassOwnerCheck -Identity "Marketing Events 2013" |
|
EXAMPLE 2
This example returns the event information for the Marketing Events 2013 site mailbox and sends an email to the primary SMTP address of the user running this command.
| Copy Code |
|
|---|---|
Get-SiteMailboxDiagnostics -BypassOwnerCheck -Identity events2013@contoso.com -SendMeEmail |
|
Detailed Description
If you aren't a member or owner of the site mailbox that you want to view the diagnostics information for, you must use the BypassOwnerCheck parameter when running this cmdlet. If you aren't a member or owner of the site mailbox and you run this cmdlet without using the BypassOwnerCheck parameter, the command fails with an "object not found" error.
You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "Site mailboxes" entry in the Sharing and Collaboration Permissions topic.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Required |
Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter |
The Identity parameter specifies the site mailbox. You can use the following values:
|
|
BypassOwnerCheck |
Optional |
System.Management.Automation.SwitchParameter |
The BypassOwnerCheck switch is used by administrators who aren't members or owners of the site mailbox. If you aren't a member or owner of the site mailbox and you run this cmdlet without using the BypassOwnerCheck parameter, the command fails with an "object not found" error. |
|
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
The Confirm switch causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You don't have to specify a value with the Confirm switch. |
|
Organization |
Optional |
Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter |
The Organization parameter is reserved for internal Microsoft use. |
|
SendMeEmail |
Optional |
System.Management.Automation.SwitchParameter |
The SendMeEmail parameter specifies that the diagnostic information is sent to the primary SMTP email address for whichever user is logged into Remote PowerShell. |
|
WhatIf |
Optional |
System.Management.Automation.SwitchParameter |
The WhatIf switch instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, you can view what changes would occur without having to apply any of those changes. You don't have to specify a value with the WhatIf switch. |
Input Types
To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.
Return Types
To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.