Applies to: Exchange Server 2013

Topic Last Modified: 2012-07-12

Use the Get-AgentLog cmdlet to parse log files that you specify as parameters and collect raw statistics from the filtering that anti-spam agents apply during a time period that you specify.

Syntax

Get-AgentLog [-EndDate <DateTime>] [-Location <LocalLongFullPath>] [-StartDate <DateTime>] [-TransportService <Hub | Edge | FrontEnd | MailboxSubmission | MailboxDelivery>]

Examples

EXAMPLE 1

This example returns a report that has statistics collected between 09:00 (9 A.M.), January 4, 2010 and 18:00 (6 P.M.), January 8, 2010 in the Front End Transport service on a Client Access server.

Copy Code
Get-AgentLog -StartDate "01/04/2010 9:00:00 AM" -EndDate "01/08/2010 6:00:00 PM" -TransportService FrontEnd

Detailed Description

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 "Anti-spam features" entry in the Anti-Spam and Anti-Malware Permissions topic.

Parameters

Parameter Required Type Description

EndDate

Optional

System.DateTime

The EndDate parameter specifies the date and time that you want to stop collecting statistics. The default time is the current time. When you enter a specific date, use the short date format defined in the Regional Options settings configured on the local computer. For example, if your computer is configured to use the short date format mm/dd/yyyy, enter 03/01/2010 to specify March 1, 2010. You can enter the date only, for example, 10/05/2010. Or you can enter the date and time of day. If you enter a time of day and date, you must enclose the argument in quotation marks ("), for example, "10/05/2010 5:00:00 PM".

Location

Optional

Microsoft.Exchange.Data.LocalLongFullPath

The Location parameter specifies the directory that contains the log files that you can use to build usage reports. The default path is %ExchangeInstallPath%TransportRoles\Logs\AgentLog. You must enclose the file path in quotation marks (").

StartDate

Optional

System.DateTime

The StartDate parameter specifies the date and time that the collection of statistics starts. The default time is the current time. When you enter a specific date, use the short date format defined in the Regional Options settings configured on the local computer. For example, if your computer is configured to use the short date format mm/dd/yyyy, enter 03/01/2010 to specify March 1, 2010. You can enter the date only, for example, 10/05/2010, or you can enter the date and time of day. If you enter a time of day and date, you must enclose the argument in quotation marks ("), for example, "10/05/2010 5:00:00 PM".

TransportService

Optional

Microsoft.Exchange.Data.TransportService

The TransportService parameter specifies the transport service that you want to view or modify. Valid values for this parameter are:

  • Hub for the Transport service on Mailbox servers.

  • MailboxSubmission for the Mailbox Transport Submission service on Mailbox servers.

  • MailboxDelivery for the Mailbox Transport Delivery service on Mailbox servers.

  • FrontEnd for the Front End Transport service on Client Access servers.

  • Edge on Edge Transport servers.

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.