Export (0) Print
Expand All

Export-MailboxDiagnosticLogs

 

Applies to: Exchange Server 2013, Exchange Online

Topic Last Modified: 2014-03-18

This cmdlet is available in on-premises Exchange Server 2013 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Export-MailboxDiagnosticLogs cmdlet to export diagnostic data from user and system mailboxes in Microsoft Exchange Server 2013 Enterprise.

For information about the parameter sets in the Syntax section below, see Syntax.

Export-MailboxDiagnosticLogs -ComponentName <String> -Identity <MailUserOrGeneralMailboxIdParameter> [-Archive <SwitchParameter>] <COMMON PARAMETERS>

Export-MailboxDiagnosticLogs -ExtendedProperties <SwitchParameter> -Identity <MailUserOrGeneralMailboxIdParameter> [-Archive <SwitchParameter>] <COMMON PARAMETERS>

COMMON PARAMETERS: [-Confirm [<SwitchParameter>]] [-Credential <PSCredential>] [-DomainController <Fqdn>] [-ReadFromDomainController <SwitchParameter>] [-ResultSize <Unlimited>] [-WhatIf [<SwitchParameter>]]

This example retrieves the out-of-office diagnostic log for the user John Smith.

Export-MailboxDiagnosticLogs -ComponentName OOF -Identity JohnSmith

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 "Shell infrastructure permissions" section in the Exchange and Shell infrastructure permissions topic.

 

Parameter Required Type Description

ComponentName

Required

System.String

The ComponentName parameter specifies the component for which to retrieve the logs. Any log that was created with the common logging code and is stored in the root of the mailbox works. The cmdlet accepts the following names:

  • OOF

  • Sharing

  • MeetingMessageProcessingAgent

  • SharingSyncAssistant

  • MRM

  • InternetCalendar

  • Calendar

ExtendedProperties

Required

System.Management.Automation.SwitchParameter

The ExtendedProperties parameter specifies whether to retrieve all of the well-known properties from the mailbox table that are useful for troubleshooting.

Identity

Required

Microsoft.Exchange.Configuration.Tasks.MailUserOrGeneralMailboxIdParameter

The Identity parameter specifies what mailbox the diagnostic logs are being retrieved from. The mailboxes can be piped from the Get-Mailbox cmdlet.

Archive

Optional

System.Management.Automation.SwitchParameter

The Archive parameter retrieves the diagnostics logs of the archive mailbox instead of the primary mailbox.

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch can be used to suppress the confirmation prompt that appears by default when this cmdlet is run. To suppress the confirmation prompt, use the syntax -Confirm:$False. You must include a colon ( : ) in the syntax.

Credential

Optional

System.Management.Automation.PSCredential

This parameter is available only in on-premises Exchange 2013.

The Credential parameter specifies the user name and password to use to access Active Directory.

This parameter requires the creation and passing of a credential object. This credential object is created by using the Get-Credential cmdlet. For more information, see Get-Credential.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

This parameter is available only in on-premises Exchange 2013.

The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that retrieves data from Active Directory.

ReadFromDomainController

Optional

System.Management.Automation.SwitchParameter

This parameter is available only in on-premises Exchange 2013.

The ReadFromDomainController parameter specifies that the user information is read from a domain controller in the user's domain. If you set the recipient scope to include all recipients in the forest and don't use this parameter, it's possible that the user information is read from a global catalog with outdated information. If you use this parameter, multiple reads might be necessary to get the information.

ResultSize

Optional

Microsoft.Exchange.Data.Unlimited

The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000.

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.

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.

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.

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft