Applies to: Exchange Server 2010 SP3, Exchange Server 2010 SP2
Topic Last Modified: 2012-11-19
Use the Write-AdminAuditLog cmdlet to write a comment to the administrator audit log.
Syntax
Write-AdminAuditLog [-Identity
<OrganizationIdParameter>] -Comment <String> [-Confirm
[<SwitchParameter>]] [-DomainController <Fqdn>]
[-WhatIf [<SwitchParameter>]]
|
Detailed Description
When the Write-AdminAuditLog cmdlet runs, the value provided in the Comment parameter is included in the log entry.
For the Write-AdminAuditLog cmdlet to write to the audit log, it must be included in the list of cmdlets being logged by administrator audit logging. For more information about configuring administrator audit logging, see Configure Administrator Audit Logging.
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 "Write to audit log" entry in the Exchange and Shell Infrastructure Permissions topic.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Comment |
Required |
System.String |
The Comment parameter specifies the comment to add to the administrator audit log. The maximum length is 500 characters. If the comment you specify contains spaces, enclose the comment in quotation marks ("). |
|
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 writes this configuration change to Active Directory. |
|
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 identity of the tenant organization. |
|
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 adds a comment to the administrator audit log.
 Copy Code |
|
|---|---|
Write-AdminAuditLog -Comment "Ran custom script." |
|