Applies to: Exchange Server 2013
Topic Last Modified: 2013-01-14
Use the Invoke-MonitoringProbe cmdlet to run a monitoring probe on a selected server.
For information about the parameter sets in the Syntax section below, see Syntax.
Syntax
Invoke-MonitoringProbe -Identity <String> -Server
<ServerIdParameter> [-Account <String>] [-Endpoint
<String>] [-ItemTargetExtension <String>] [-Password
<String>] [-PropertyOverride <String>]
[-SecondaryAccount <String>] [-SecondaryEndpoint
<String>] [-SecondaryPassword <String>]
[-TimeOutSeconds <String>]
|
Examples
EXAMPLE 1
This example creates an Exchange ActiveSync monitoring probe on the EXCH01 server.
 Copy Code |
|
|---|---|
Invoke-MonitoringProbe -Identity ActiveSync.Protocol\ActiveSyncSelfTestProbe -Server EXCH01 |
|
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 "Shell infrastructure permissions" section in the Exchange and Shell Infrastructure Permissions topic.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Required |
System.String |
The Identity parameter specifies the identity of the monitoring probe to run. |
|
Server |
Required |
Microsoft.Exchange.Configuration.Tasks.ServerIdParameter |
The Server parameter specifies the Exchange server on which you want to run this command. You can use any value that uniquely identifies the server. For example:
If you don't use the Server parameter, the command is run on the local server. You can't use this parameter to configure other Edge Transport servers remotely. |
|
Account |
Optional |
System.String |
The Account parameter specifies the identity of the mailbox or user account that will run the monitoring probe. |
|
Endpoint |
Optional |
System.String |
The Endpoint parameter specifies the name of the monitoring probe endpoint to connect to, for example, contoso.mail.com. |
|
ItemTargetExtension |
Optional |
System.String |
The ItemTargetExtension parameter specifies cmdlet extension data that you can pass to the monitoring probe. The probe that runs on the server may require specific data for its execution. This data is presented to the probe on execution in an XML format. |
|
Password |
Optional |
System.String |
The Password parameter specifies the password of the mailbox or user account that will run the monitoring probe. |
|
PropertyOverride |
Optional |
System.String |
The PropertyOverride parameter specifies a property that you want to override, for example, to set the time-out value to be extended beyond the default value. |
|
SecondaryAccount |
Optional |
System.String |
The SecondaryAccount parameter specifies the identity of the delegate mailbox or user account that will run the monitoring probe. |
|
SecondaryEndpoint |
Optional |
System.String |
The SecondaryEndpoint parameter specifies the name of the secondary monitoring probe endpoint to connect to, for example, contoso.mail.fabrikam.com. |
|
SecondaryPassword |
Optional |
System.String |
The SecondaryPassword parameter specifies the password of the delegate mailbox or user account that will run the monitoring probe. |
|
TimeOutSeconds |
Optional |
System.String |
The TimeOutSeconds parameter specifies the monitoring operation time-out period. |
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.