Share via

Set-ForeignConnector (RTM)

  • Article

Microsoft Exchange Server 2007 will reach end of support on April 11, 2017. To stay supported, you will need to upgrade. For more information, see Resources to help you upgrade your Office 2007 servers and clients.

 

Applies to: Exchange Server 2007

Use the Set-ForeignConnector cmdlet to modify an existing Foreign connector on a computer that is running Microsoft Exchange Server 2007 and that has the Hub Transport server role installed. A Foreign connector uses a Drop directory on a Hub Transport server to send messages to a local messaging server that doesn't use the Simple Mail Transfer Protocol (SMTP) as its primary transport mechanism. These messaging servers are known as foreign gateway servers. Third-party fax gateway servers are examples of foreign gateway servers. The address spaces that are assigned to a Foreign connector can be SMTP or non-SMTP.

Syntax

Set-ForeignConnector -Identity <ForeignConnectorIdParameter> [-AddressSpaces <MultiValuedProperty>] [-Comment <String>] [-DomainController <Fqdn>] [-DropDirectory <String>] [-DropDirectoryQuota <Unlimited>] [-Enabled <$true | $false>] [-MaxMessageSize <Unlimited>] [-Name <String>] [-RelayDsnRequired <$true | $false>] [-SourceTransportServers <MultiValuedProperty>]

Set-ForeignConnector [-AddressSpaces <MultiValuedProperty>] [-Comment <String>] [-DomainController <Fqdn>] [-DropDirectory <String>] [-DropDirectoryQuota <Unlimited>] [-Enabled <$true | $false>] [-Instance <ForeignConnector>] [-MaxMessageSize <Unlimited>] [-Name <String>] [-RelayDsnRequired <$true | $false>] [-SourceTransportServers <MultiValuedProperty>]

Detailed Description

The Set-ForeignConnector cmdlet modifies an existing Foreign connector. The property changes that you specify when you use the Set-ForeignConnector cmdlet overwrite the existing property values.

To run the Set-ForeignConnector cmdlet, the account you use must be delegated the Exchange Server Administrator role and local Administrators group for the target server.

For more information about permissions, delegating roles, and the rights that are required to administer Exchange 2007, see Permission Considerations.

Parameters

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.ForeignConnectorIdParameter

This parameter specifies the Foreign connector that you want to modify. The Identity parameter can take any of the following values for the Foreign connector object:

  • GUID

  • Connector name

  • ServerName\ConnectorName

AddressSpaces

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter specifies the domain names to which the Foreign connector sends messages. You may specify multiple address spaces by separating the address spaces with commas. The complete syntax for entering each address space is as follows:

<ConnectorScope>:<AddressSpaceType>:<AddressSpace>;<AddressSpaceCost>

  • ConnectorScope   If you specify a value of Local, the connector can only be used by other Hub Transport servers that exist in the same Active Directory site as the source Hub Transport server on which you are running the New-SendConnector cmdlet. If you omit the ConnectorScope qualifier, the connector can be used by all Hub Transport servers that exist in the whole Exchange 2007 organization.

  • AddressSpaceType   For SMTP address spaces, this value must be SMTP. For non-SMTP address spaces, this value may be any descriptive text string, such as "Lotus Notes".

  • AddressSpace   For SMTP address spaces, the domain name system (DNS) wildcard character (*) as defined in RFC 1035 can be used, such as "*", "*.com.", or *.contoso.com", for example. For non-SMTP address spaces, wildcard characters (*) and other characters can be used, such as "*contoso.com" or "@contoso", for example.

  • AddressSpaceCost   The valid input range for the cost is 1 to 100. A lower cost indicates a better route. This parameter is optional. If you omit the AddressSpaceCost qualifier when you enter an address space by using the complete syntax, a cost of 1 is assumed.

You must use the complete syntax for the AddressSpaces parameter only for the following conditions:

  • Scoped connectors that have the Local qualifier

  • Non-SMTP address spaces

  • SMTP address spaces with a cost that is not 1

If you enter a domain name or a comma-separated list of domain names for the value of the AddressSpaces parameter, the address space type of SMTP and a cost of 1 are assumed for each domain name.

Comment

Optional

System.String

This parameter specifies an optional comment for the Foreign connector. You must enclose the Comment parameter in double quotation marks as follows, for example: "this is an admin note".

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

To specify the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to the Active Directory directory service, include the DomainController parameter.

DropDirectory

Optional

System.String

This parameter specifies the name of the Drop directory that is used by this Foreign connector. All outbound messages that are sent to address spaces that are defined by this Foreign connector are put in the specified Drop directory. The location of the Drop directory for each Foreign connector is controlled by the following two items:

  • The RootDropDirectoryPath parameter in the Set-TransportServer cmdlet   This option is used for all Foreign connectors that exist on the Hub Transport server. The value of the RootDropDirectoryPath parameter may be a local path, or a Universal Naming Convention (UNC) path to a remote server.

  • The DropDirectory parameter in the Set-ForeignConnector cmdlet   This value is set for each Foreign Connector that exists on the Hub Transport server.

By default, the RootDropDirectoryPath parameter is blank. This indicates the value of RootDropDirectoryPath is the Exchange 2007 installation folder. The default Exchange 2007 installation folder is C:\Program Files\Microsoft\Exchange Server\. By default, the value of the DropDirectory parameter is the name of the Foreign connector.

If the value of the DropDirectory parameter doesn't contain absolute path information, the location of the Drop directory is defined by the combination of the DropDirectory parameter and the RootDropDirectoryPath parameter. If the value of the DropDirectory parameter contains absolute path information, the value of the RootDropDirectoryPath must be unspecified. The location of the Drop directory is defined only by the value of the DropDirectory parameter.

The Drop directory is not created for you. Therefore, you will have to manually create each Drop directory folder.

The Drop directory must have the following permissions assigned to it:

  • Network Service: Full Control

  • System: Full Control

  • Administrators: Full Control

DropDirectoryQuota

Optional

Microsoft.Exchange.Data.Unlimited

This parameter specifies the maximum size of all messages files in Drop directory. When the specified value is reached, no new message files can be copied into the Drop directory until the existing messages are delivered and deleted. When you enter a value for the DropDirectoryQuota parameter, qualify the value with one of the following units:

  • B (bytes)

  • KB (kilobytes)

  • MB (megabytes)

  • GB (gigabytes)

  • TB (terabytes)

Unqualified values are treated as bytes. The valid input range for this parameter is 1 to 2147483647 bytes. If you enter a value of unlimited, no message size limit is imposed on the Drop directory. The default value is unlimited.

Enabled

Optional

System.Boolean

This parameter enables or disables the Foreign connector. The valid input values are $True or $False. The default value is $True.

Instance

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.ForeignConnector

The Instance parameter enables you to pass an entire object to the command to be processed. It is mainly used in scripts where an entire object must be passed to the command.

MaxMessageSize

Optional

Microsoft.Exchange.Data.Unlimited

This parameter specifies the maximum size of a message that can pass through this Foreign connector. When you enter a value for the MaxMessageSize parameter, qualify the value with one of the following units:

  • B (bytes)

  • KB (kilobytes)

  • MB (megabytes)

  • GB (gigabytes)

  • TB (terabytes)

Unqualified values are treated as kilobytes. If you enter a value of unlimited, no message size limit is imposed on this Foreign connector. The default value is unlimited. The valid input range for this parameter is 0 to 2147483647 kilobytes. If you set the value of the MaxMessageSize parameter to 0, you effectively disable the Foreign connector. However, if you set the value of the MaxMessageSize parameter to 0 when the value of the Enabled attribute is $True, you will generate event log errors. The preferred method to disable the Foreign connector is to use the Enabled parameter.

Name

Optional

System.String

This parameter specifies a descriptive name for the Foreign connector.

RelayDsnRequired

Optional

System.Boolean

This parameter specifies whether a Relay delivery status notification (DSN) is required by the Foreign connector when messages are written to the Drop directory. The valid input values for this parameter are $True or $False. The default value is $False.

SourceTransportServers

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter specifies the names of the Hub Transport servers that use this Foreign connector. You may specify multiple Hub Transport servers by separating the server names with commas. Having a single Foreign connector homed on multiple Hub Transport servers provides fault tolerance and high availability if one of the Hub Transport servers fails. The default value of this parameter is the name of the Hub Transport server on which this Foreign connector was first installed.

Example

The following code sample shows two examples that use the Set-ForeignConnector cmdlet.

The first example shows a Set-ForeignConnector command that modifies an existing Foreign connector named "Contoso Foreign Connector". The command sets the MaxMessageSize parameter to 10 MB.

The second example shows a Set-ForeignConnector command that modifies the address spaces that are serviced by an existing Foreign connector named "Contoso Foreign Connector". The details of the address spaces are as follows:

  • First address space:

    • Address space type: SMTP

    • Address space: "*.contoso.com"

    • Address space cost: 1

  • Second address space:

    • Address space type: Lotus Notes

    • Address space: "*@domino"

    • Address space cost: 55

Set-ForeignConnector "Contoso Foreign Connector" -MaxMessageSize 10MB
Set-ForeignConnector "Contoso Foreign Connector" -AddressSpaces ".contoso.com","Lotus Notes:*@domino;55"