Test-PopConnectivity
Applies to: Exchange Server 2007 SP1, Exchange Server 2007 SP2, Exchange Server 2007 SP3
Use the Test-PopConnectivity cmdlet to verify that the POP3 service is running as expected. The Test-PopConnectivity cmdlet can be used to test the POP3 functionality for a specified Client Access server.
Syntax
Test-PopConnectivity [-ClientAccessServer <ServerIdParameter>] [-Confirm [<SwitchParameter>]] [-ConnectionType <Plaintext | Tls | Ssl>] [-DomainController <Fqdn>] [-LightMode <SwitchParameter>] [-MailboxCredential <PSCredential>] [-MailboxServer <ServerIdParameter>] [-MonitoringContext <SwitchParameter>] [-PerConnectionTimeout <Int32>] [-PortClientAccessServer <Int32>] [-ResetTestAccountCredentials <SwitchParameter>] [-Timeout <UInt32>] [-TrustAnySSLCertificate <SwitchParameter>] [-WhatIf [<SwitchParameter>]]
Detailed Description
Use the Test-PopConnectivity cmdlet to verify that the POP3 service is running as expected. The Test-PopConnectivity cmdlet can be used to test the POP3 functionality for a specified Client Access server.
To run the Test-PopConnectivity cmdlet to test POP3 functionality on a Client Access server, the account you use must be delegated the Exchange Server Administrator role and membership in the local Administrators group for the target server.
For more information about permissions, delegating roles, and the rights that are required to administer Exchange Server 2007, see Permission Considerations.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
ClientAccessServer |
Optional |
Microsoft.Exchange.Configuration.Tasks.ServerIdParameter |
This parameter specifies the name of the Client Access server to test. Do not use this parameter with the URL parameter. |
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
The Confirm parameter causes the command to pause processing and requires that you acknowledge what the command will do before processing continues. You do not have to specify a value with the Confirm parameter. |
ConnectionType |
Optional |
Microsoft.Exchange.Monitoring.ProtocolConnectionType |
This parameter specifies the type of connection that is used to connect to the Client Access server. |
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
To specify the fully qualified domain name (FQDN) of the domain controller that retrieves data from the Active Directory directory service, include the DomainController parameter in the cmdlet. |
LightMode |
Optional |
System.Management.Automation.SwitchParameter |
This parameter is not implemented for the Test-PopConnectivity cmdlet. Using this parameter does not change the behavior of the cmdlet. Note This cmdlet is implemented for other Exchange 2007 diagnostic cmdlets. |
MailboxCredential |
Optional |
System.Management.Automation.PSCredential |
This parameter includes the mailbox credential for a single URL test. |
MailboxServer |
Optional |
Microsoft.Exchange.Configuration.Tasks.ServerIdParameter |
This parameter specifies the name of the Mailbox server to test. If not specified, all Mailbox servers in the local Active Directory site will be tested. |
MonitoringContext |
Optional |
System.Management.Automation.SwitchParameter |
If this parameter is included, the task will be run by Microsoft Operations Manager (MOM). Running the task with this parameter without MOM will cause the task to fail. If this parameter is excluded, the task must be run interactively by an administrator. |
PerConnectionTimeout |
Optional |
System.Int32 |
This parameter specifies the amount of time to wait per connection, in seconds, for the test operation to finish. The default value for the PerConnectionTimeout parameter is 24 seconds. You must specify a time-out value greater than 0 seconds and less than 120 seconds. We recommend that you always configure this parameter with a value of 5 seconds or more. |
PortClientAccessServer |
Optional |
System.Int32 |
This parameter specifies the port to use to connect to the Client Access server that you will use with the Test-PopConnectivity cmdlet. |
ResetTestAccountCredentials |
Optional |
System.Management.Automation.SwitchParameter |
The ResetTestAccountCredentials parameter resets the password for the test account used to perform this command. The password for the test account is typically reset every seven days if you're using Microsoft System Center Operations Manager to manage your Exchange environment. Use of this flag forces a password reset at any time if it's required for security reasons. |
Timeout |
Optional |
System.UInt32 |
This parameter specifies the amount of time to wait, in seconds, for the test operation to finish. The default value for Timeout is 30 seconds. You must specify a time-out value greater than 0 seconds and less than 1 hour (3600 seconds). We recommend that you always configure this parameter with a value of 5 seconds or more. |
TrustAnySSLCertificate |
Optional |
System.Management.Automation.SwitchParameter |
If this parameter is used, Secure Sockets Layer (SSL) certificate validation failures will not be reported. This parameter lets the Test-PopConnectivity cmdlet check the POP3 service without generating an error when the certificate does not match the URL of the Client Access server. |
WhatIf |
Optional |
System.Management.Automation.SwitchParameter |
The WhatIf parameter instructs the command to simulate the actions that it would take on the object. By using the WhatIf parameter, you can view what changes would occur without having to apply any of those changes. You do not have to specify a value with the WhatIf parameter. |
Input Types
Return Types
Errors
| Error | Description |
|---|---|
|
|
Example
The first code example tests the connectivity for the Client Access server Contoso12 by using the credentials for the user contoso\kweku.
The second code example tests the connectivity of a specific Client Access server named Contoso12 and will test all Exchange 2007 mailboxes.
Test-PopConnectivity -ClientAccessServer:Contoso12 -MailboxCredential:(get-credential contoso\kweku)
Test-PopConnectivity -ClientAccessServer:Contoso12