Export (0) Print
Expand All
Related Help Topics
Loading
No resources found.
Related Blog Articles
Loading
No resources found.
Expand Minimize

Search-AdminAuditLog

 

Applies to: Exchange Server 2010 SP3, Exchange Server 2010 SP2

Topic Last Modified: 2012-11-19

Use the Search-AdminAuditLog cmdlet to search the contents of the administrator audit log.


Search-AdminAuditLog [-Identity <OrganizationIdParameter>] [-Cmdlets <MultiValuedProperty>] [-DomainController <Fqdn>] [-EndDate <ExDateTime>] [-IsSuccess <$true | $false>] [-ObjectIds <MultiValuedProperty>] [-Parameters <MultiValuedProperty>] [-ResultSize <Int32>] [-StartDate <ExDateTime>] [-StartIndex <Int32>] [-UserIds <MultiValuedProperty>]

If you run the Search-AdminAuditLog cmdlet without any parameters, up to 1,000 log entries are returned by default.

The Search-AdminAuditLog cmdlet searches the Microsoft Exchange Server 2010 Service Pack 1 (SP1) audit log only. You can't use this cmdlet to search the Exchange 2010 release to manufacturing (RTM) audit log. You must continue to access the Exchange 2010 RTM audit log using an e-mail client, such as Microsoft Outlook, or use Microsoft Office Outlook Web App.

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 "View-only administrator audit logging" entry in the Exchange and Shell Infrastructure Permissions topic.

 

Parameter Required Type Description

Cmdlets

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The Cmdlets parameter specifies the cmdlets you want to search for in the administrator audit log. Only the log entries that contain the cmdlets you specify are returned.

If you want to specify more than one cmdlet, separate each cmdlet with a comma.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

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

EndDate

Optional

Microsoft.Exchange.ExchangeSystem.ExDateTime

The EndDate parameter specifies the scope of the administrator audit log results to log entries that occurred on or before the specified date.

Specify the day, month, and year in the format specified in your regional settings.

Identity

Optional

Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter

This parameter is available for multi-tenant deployments. It isn't available for on-premises deployments. For more information about multi-tenant deployments, see Multi-Tenant Support.

The Identity parameter specifies the name of the tenant organization.

IsSuccess

Optional

System.Boolean

The IsSuccess parameter specifies whether only administrator audit log entries that indicated a success or failure should be returned. Valid values are $true and $false.

ObjectIds

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ObjectIds parameter specifies that only administrator audit log entries that contain the specified changed objects should be returned. This parameter accepts a variety of objects, such as mailbox aliases, Send connector names, and so on.

If you want to specify more than one object ID, separate each ID with a comma.

Parameters

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The Parameters parameter specifies the parameters you want to search for in the administrator audit log. Only the log entries that contain the parameters you specify are returned. You can only use this parameter if you use the Cmdlets parameter.

If you want to specify more than one parameter, separate each parameter with a comma.

ResultSize

Optional

System.Int32

The ResultSize parameter specifies the maximum number of administrator audit log entries to return. The minimum value is 1 and the maximum value is 250000. The default value is 1000.

StartDate

Optional

Microsoft.Exchange.ExchangeSystem.ExDateTime

The StartDate parameter specifies the scope of the administrator audit log results to log entries that occurred on or after the specified date.

Specify the day, month, and year in the format specified in your regional settings.

StartIndex

Optional

System.Int32

The StartIndex parameter specifies the position in the result set where the displayed results start.

UserIds

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The UserIds parameter specifies that only the administrator audit log entries that contain the specified ID of the user who ran the cmdlet should be returned.

If you want to specify more than one user ID, separate each ID with a comma.

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.

This example finds all of the administrator audit log entries that contain either the New-RoleGroup or New-ManagementRoleAssignment cmdlets.

Search-AdministratorAuditLog -Cmdlets New-RoleGroup, New-ManagementRoleAssignment

This example finds all of the administrator audit log entries that match the following criteria:

  • Cmdlets   Set-Mailbox
  • Parameters   UseDatabaseQuotaDefaults, ProhibitSendReceiveQuota, ProhibitSendQuota
  • StartDate   01/24/2010
  • EndDate   02/12/2010
  • The command completed successfully
Search-AdminAuditLog -Cmdlets Set-Mailbox -Parameters UseDatabaseQuotaDefaults, ProhibitSendReceiveQuota, ProhibitSendQuota -StartDate 01/24/2010 -EndDate 02/12/2010 -IsSuccess $true

This example displays all of the comments written to the administrator audit log by the Write-AdminAuditLog cmdlet.

First, store the audit log entries in a temporary variable using the following command:

$LogEntries = Search-AdminAuditLog -Cmdlets Write-AdminAuditLog

Then, iterate through all the audit log entries returned and display the Parameters property using the following command.

$LogEntries | ForEach { $_.CmdletParameters }
 © 2010 Microsoft Corporation. All rights reserved.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft