Applies to: Exchange Server 2013
Topic Last Modified: 2012-06-25
Use the Search-AdminAuditLog cmdlet to search the contents of the administrator audit log.
For information about the parameter sets in the Syntax section below, see Syntax.
Syntax
Search-AdminAuditLog [-Cmdlets
<MultiValuedProperty>] [-EndDate <ExDateTime>]
[-Identity <OrganizationIdParameter>] [-IsSuccess <$true |
$false>] [-ObjectIds <MultiValuedProperty>] [-Parameters
<MultiValuedProperty>] [-ResultSize <Int32>]
[-StartDate <ExDateTime>] [-StartIndex <Int32>]
[-UserIds <MultiValuedProperty>] [-DomainController
<Fqdn>]
|
Examples
EXAMPLE 1
This example finds all the administrator audit log entries that contain either the New-RoleGroup or the New-ManagementRoleAssignment cmdlet.
 Copy Code |
|
|---|---|
Search-AdminAuditLog -Cmdlets New-RoleGroup, New-ManagementRoleAssignment |
|
EXAMPLE 2
This example finds all the administrator audit log entries that match the following criteria:
- Cmdlets Set-Mailbox
-
Parameters UseDatabaseQuotaDefaults,
ProhibitSendReceiveQuota, ProhibitSendQuota
- StartDate 01/24/2012
- EndDate 02/12/2012
- The command completed successfully
| Copy Code |
|
|---|---|
Search-AdminAuditLog -Cmdlets Set-Mailbox -Parameters UseDatabaseQuotaDefaults, ProhibitSendReceiveQuota, ProhibitSendQuota -StartDate 01/24/2012 -EndDate 02/12/2012 -IsSuccess $true |
|
EXAMPLE 3
This example displays all 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.
| Copy Code |
|
|---|---|
$LogEntries = Search-AdminAuditLog -Cmdlets Write-AdminAuditLog |
|
Then, iterate through all the audit log entries returned and display the Parameters property using the following command.
| Copy Code |
|
|---|---|
$LogEntries | ForEach { $_.CmdletParameters }
|
|
Detailed Description
If you run the Search-AdminAuditLog cmdlet without any parameters, up to 1,000 log entries are returned by default.
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 |
|---|---|---|---|
|
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 reserved for internal Microsoft use. |
|
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 |
|
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
|
|
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. |
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.