Get-ReceiveConnector
Applies to: Exchange Server 2007 SP1, Exchange Server 2007 SP2, Exchange Server 2007 SP3
Use the Get-ReceiveConnector cmdlet to view the configuration information for a Receive connector on a computer that has the Hub Transport server role or the Edge Transport server role installed.
Syntax
Get-ReceiveConnector [-Identity <ReceiveConnectorIdParameter>] [-DomainController <Fqdn>]
Get-ReceiveConnector [-DomainController <Fqdn>] [-Server <ServerIdParameter>]
Detailed Description
The Get-ReceiveConnector cmdlet retrieves the configuration information for a Receive connector. You can use the Identity parameter to retrieve the configuration information for a specific Receive connector. To retrieve the configuration information for all Receive connectors, do not include the Identity parameter in the command. You can also use the Server parameter to retrieve a list of all Receive connectors that are configured on a specific computer.
To run the Get-ReceiveConnector cmdlet, the account you use must be delegated the following:
- Exchange View-Only Administrators role
To run the Get-ReceiveConnector cmdlet on a computer that has the Edge Transport server role installed, you must log on by using an account that is a member of the local Administrators group on that computer.
For more information about permissions, delegating roles, and the rights that are required to administer Microsoft Exchange Server 2007, see Permission Considerations.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Identity |
Optional |
Microsoft.Exchange.Configuration.Tasks.ReceiveConnectorIdParameter |
Use the Identity parameter to specify the GUID or connector name that represents a specific Receive connector. You can also include the server name using the format ServerName\ConnectorName. You can omit the parameter label Identity so that only the connector name or GUID is supplied. |
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
To specify the fully qualified domain name of the domain controller that retrieves data from the Active Directory directory server, include the DomainController parameter on the command. The DomainController parameter is not supported on computers that have the Edge Transport server role installed. The Edge Transport server role writes and reads only to the local Active Directory Application Mode (ADAM) instance. |
Server |
Optional |
Microsoft.Exchange.Configuration.Tasks.ServerIdParameter |
Use the Server parameter to specify the name of the server to query when the command is run. Only the Receive connectors that are configured on the server that you specify will be displayed. |
Input Types
Return Types
Errors
| Error | Description |
|---|---|
|
|
Example
The following code sample shows three examples that use the Get-ReceiveConnector cmdlet.
The first example displays a summary list of all Receive connectors on all Hub Transport servers or the local Edge Transport server on which the command is run.
The second example shows how to view the detailed configuration of a specific Receive connector by piping the results of the Get-ReceiveConnector cmdlet to the Format-List cmdlet.
The third example shows how to view a summary list of Receive connectors that are configured on a specific server.
For more information about pipelining, see Pipelining.
For more information about how to work with the output of a cmdlet, see Working with Command Output.
Get-ReceiveConnector
Get-ReceiveConnector "Receive Connector Name" | Format-List
Get-ReceiveConnector -Server Hub1