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

Topic Last Modified: 2012-11-19

Use the New-AdminAuditLogSearch cmdlet to search the contents of the administrator audit log and send the results to one or more mailboxes that you specify.

Syntax

New-AdminAuditLogSearch [-Organization <OrganizationIdParameter>] -EndDate <ExDateTime> -StartDate <ExDateTime> -StatusMailRecipients <MultiValuedProperty> [-Cmdlets <MultiValuedProperty>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-Name <String>] [-ObjectIds <MultiValuedProperty>] [-Parameters <MultiValuedProperty>] [-UserIds <MultiValuedProperty>] [-WhatIf [<SwitchParameter>]]

Detailed Description

After the New-AdminAuditLogSearch cmdlet is run, the report is delivered to the mailboxes you specify within 15 minutes. The log is included as an XML attachment on the report e-mail message. The maximum size of the log that can be generated is 10 MB.

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.

Parameters

Parameter Required Type Description

EndDate

Required

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.

StartDate

Required

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.

StatusMailRecipients

Required

Microsoft.Exchange.Data.MultiValuedProperty

The StatusMailRecipients parameter specifies the recipients that should receive the administrator audit log report. The recipients must be valid mailboxes, contacts, or distribution groups in your Exchange organization.

You can use the following values:

  • GUID

  • Distinguished name (DN)

  • Domain\Account

  • User principal name (UPN)

  • Legacy Exchange DN

  • SMTP address

  • Alias

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.

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.

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.

Name

Optional

System.String

The Name parameter specifies the name of the administrator audit log search. The name is shown in the subject line of the audit log report e-mail message.

If the name of the report contains spaces, enclose the name in quotation marks (").

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 mailboxes, aliases, Send connector names, and so on.

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

Organization

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 Organization parameter specifies the organization in which you'll perform this action. This parameter doesn't accept wildcard characters, and you must use the exact name of the organization.

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.

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.

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.

Examples

EXAMPLE 1

This example finds all the administrator audit log entries that contain either the New-RoleGroup or New-ManagementRoleAssignment cmdlet and sends the results to the mailbox David Strome.

Copy Code 
New-AdminAuditLogSearch -Name "Role Group Change Audit" -Cmdlets New-RoleGroup, New-ManagementRoleAssignment -StatusMailRecipients "David Strome"

EXAMPLE 2

This example finds all the administrator audit log entries that match the following criteria and sends the results to the Compliance Group distribution group and the chrisd alias:

  • Cmdlets   Set-Mailbox

  • Parameters   UseDatabaseQuotaDefaults, ProhibitSendReceiveQuota, ProhibitSendQuota

  • StartDate   01/24/2010

  • EndDate   02/12/2010

Copy Code 
New-AdminAuditLogSearch -Name "Mailbox Quota Change Audit" -Cmdlets Set-Mailbox -Parameters UseDatabaseQuotaDefaults, ProhibitSendReceiveQuota, ProhibitSendQuota -StartDate 01/24/2010 -EndDate 02/12/2010 -StatusMailRecipients "Compliance Group", chrisd