Applies to: Exchange Server 2007 SP1, Exchange Server
2007
Topic Last Modified: 2007-08-27
Use the New-SendConnector cmdlet to create a new Send connector on a computer that has the Hub Transport server role or the Edge Transport server role installed.
Syntax
New-SendConnector -Name <String> -AddressSpaces
<MultiValuedProperty> [-AuthenticationCredential
<PSCredential>] [-Comment <String>]
[-ConnectionInactivityTimeOut <EnhancedTimeSpan>]
[-DNSRoutingEnabled <$true | $false>] [-DomainController
<Fqdn>] [-DomainSecureEnabled <$true | $false>]
[-Enabled <$true | $false>] [-Force <SwitchParameter>]
[-ForceHELO <$true | $false>] [-Fqdn <Fqdn>]
[-IgnoreSTARTTLS <$true | $false>] [-MaxMessageSize
<Unlimited>] [-Port <Int32>] [-ProtocolLoggingLevel
<None | Verbose>] [-RequireTLS <$true | $false>]
[-SmartHostAuthMechanism <None | BasicAuth | BasicAuthRequireTLS
| ExchangeServer | ExternalAuthoritative>] [-SmartHosts
<MultiValuedProperty>] [-SourceIPAddress <IPAddress>]
[-SourceTransportServers <MultiValuedProperty>]
[-TemplateInstance <PSObject>] [-Usage <Custom | Internal
| Internet | Partner>] [-UseExternalDNSServersEnabled <$true
| $false>]
|
New-SendConnector -Name <String>
[-AuthenticationCredential <PSCredential>] [-Comment
<String>] [-ConnectionInactivityTimeOut
<EnhancedTimeSpan>] [-DNSRoutingEnabled <$true |
$false>] [-DomainController <Fqdn>] [-DomainSecureEnabled
<$true | $false>] [-Enabled <$true | $false>] [-Force
<SwitchParameter>] [-ForceHELO <$true | $false>] [-Fqdn
<Fqdn>] [-IgnoreSTARTTLS <$true | $false>]
[-LinkedReceiveConnector <ReceiveConnectorIdParameter>]
[-MaxMessageSize <Unlimited>] [-Port <Int32>]
[-ProtocolLoggingLevel <None | Verbose>] [-RequireTLS
<$true | $false>] [-SmartHostAuthMechanism <None |
BasicAuth | BasicAuthRequireTLS | ExchangeServer |
ExternalAuthoritative>] [-SmartHosts
<MultiValuedProperty>] [-SourceIPAddress <IPAddress>]
[-SourceTransportServers <MultiValuedProperty>]
[-TemplateInstance <PSObject>] [-Usage <Custom | Internal
| Internet | Partner>] [-UseExternalDNSServersEnabled <$true
| $false>]
|
Parameters
Parameter | Required | Type | Description | ||
---|---|---|---|---|---|
AddressSpaces |
Required |
Microsoft.Exchange.Data.MultiValuedProperty |
This parameter is required unless this connector will be linked to a Receive connector by using the LinkedReceiveConnector parameter. The AddressSpaces parameter specifies the domain names to which the Send 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>
You must use the complete syntax for the AddressSpaces parameter only for the following conditions:
You may specify multiple address spaces by separating the
address spaces with commas, as follows, for example:
If you specify a non-SMTP address space type on a Send connector that is configured on a Hub Transport server, the following settings are required on the Send connector:
|
||
Name |
Required |
System.String |
This parameter is the administrator-supplied name of the
connector. You must enclose the Name parameter in double
quotation marks if the name contains spaces as follows, for
example: |
||
AuthenticationCredential |
Optional |
System.Management.Automation.PSCredential |
This parameter requires the creation and passing of a credential
object. This credential object is created by using the
Get-Credential cmdlet. For more information about the
Get-Credential cmdlet, type |
||
Comment |
Optional |
System.String |
You must enclose the Comment parameter in double
quotation marks as follows, for example: |
||
ConnectionInactivityTimeOut |
Optional |
Microsoft.Exchange.Data.EnhancedTimeSpan |
This parameter specifies the maximum time that an idle
connection can remain open. The default value is 10 minutes.
To specify a value, enter the value as a time span:
dd.hh:mm:ss, where d = days, h = hours,
m = minutes, and s = seconds. The valid input range
for this parameter is |
||
DNSRoutingEnabled |
Optional |
System.Boolean |
Valid values for the DnsRoutingEnabled parameter are
|
||
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 on the command. The DomainController parameter is not supported on computers that run the Edge Transport server role. The Edge Transport server role reads and writes only to the local ADAM instance. |
||
DomainSecureEnabled |
Optional |
System.Boolean |
This parameter is part of the process to enable mutual Transport Layer Security (TLS) authentication for the domains that are serviced by this Send connector. Mutual TLS authentication will function correctly only if the following conditions are true:
The wildcard character (*) is not supported in domains that are configured for mutual TLS authentication. The same domain must also be defined on the corresponding Receive connector, and in the value of the TLSReceiveDomainSecureList parameter in the Get-TransportConfig cmdlet. The default value for DomainSecureEnabled is
The default value for DomainSecureEnabled is
|
||
Enabled |
Optional |
System.Boolean |
Valid values for this parameter are |
||
Force |
Optional |
System.Management.Automation.SwitchParameter |
This parameter suppresses the warning or confirmation messages that appear during specific configuration changes. |
||
ForceHELO |
Optional |
System.Boolean |
Valid values for this parameter are |
||
Fqdn |
Optional |
Microsoft.Exchange.Data.Fqdn |
This parameter specifies the FQDN that is used as the source server for connected messaging servers that use the Send connector to receive outgoing messages. The value of this parameter is displayed to connected messaging servers whenever a source server name is required, as in the following examples:
The default value of the Fqdn parameter is
|
||
IgnoreSTARTTLS |
Optional |
System.Boolean |
This parameter specifies whether to ignore the StartTLS option
that is offered by a remote sending server. This parameter is used
with remote domains. This parameter must be set to
|
||
LinkedReceiveConnector |
Optional |
Microsoft.Exchange.Configuration.Tasks.ReceiveConnectorIdParameter |
This parameter forces all messages that are received by the specified Receive connector out through this Send connector. The value of LinkedReceivedConnector can use any of the following identifiers to specify the Receive connector:
When you use the LinkReceiveConnector parameter with the New-SendConnector cmdlet, you must also use the following parameters with the specified values:
When you use the LinkedReceiveConnector parameter, you must not use the AddressSpace parameter. |
||
MaxMessageSize |
Optional |
Microsoft.Exchange.Data.Unlimited |
The MaxMessageSize value specifies the maximum size of a
message that passes through a connector. You can also overload this
parameter by entering
Unqualified values are treated as bytes. Values that are entered
in bytes are rounded up to nearest kilobyte. For example,
|
||
Port |
Optional |
System.Int32 |
The valid input range for this parameter is an integer between
|
||
ProtocolLoggingLevel |
Optional |
Microsoft.Exchange.Data.ProtocolLoggingLevel |
This parameter enables or disables protocol logging for the
specified Send connector. A value of |
||
RequireTLS |
Optional |
System.Boolean |
This parameter specifies whether all messages that are sent
through this connector must be transmitted by using TLS. The
default value is |
||
SmartHostAuthMechanism |
Optional |
Microsoft.Exchange.Data.Directory.SystemConfiguration.SmtpSendConnectorConfig+AuthMechanisms |
This parameter is used during authentication with a remote
server. This parameter is used only when a smart host is configured
and the DNSRoutingEnabled parameter is set to
|
||
SmartHosts |
Optional |
Microsoft.Exchange.Data.MultiValuedProperty |
This parameter is required if you set the
DnsRoutingEnabled parameter to |
||
SourceIPAddress |
Optional |
System.Net.IPAddress |
This parameter specifies the local IP address to use as the
endpoint for an SMTP connection to a remote messaging server. The
default IP address is |
||
SourceTransportServers |
Optional |
Microsoft.Exchange.Data.MultiValuedProperty |
This parameter specifies the names of the Hub Transport servers that can use this Send connector. You can specify the names of more than one Hub Transport server by separating the names with commas. This parameter is not valid for Send connectors that are configured on Edge Transport servers. |
||
TemplateInstance |
Optional |
System.Management.Automation.PSObject |
When an existing object is supplied to this parameter, the command uses the configuration of that object to create an identical copy of the object on a local or target server. |
||
Usage |
Optional |
Microsoft.Exchange.Management.SystemConfigurationTasks.NewSendConnector+UsageType |
This parameter helps you configure the connector defaults
depending on how the connector will be used. The valid values for
this parameter are as follows: |
||
UseExternalDNSServersEnabled |
Optional |
System.Boolean |
This parameter specifies whether this Send connector should use
the external Domain Name System (DNS) list that is specified by
using the ExternalDNSServers parameter of the
Set-TransportServer cmdlet. The default value is
|
Detailed Description
This cmdlet creates a new Send connector. To be prompted for the required parameters of a new Send connector, enter New-SendConnector. After this task is completed, a Send connector is created.
To run the New-SendConnector cmdlet, the account you use must be delegated the Exchange Server Administrator role and local Administrators group for the target server.
To run the New-SendConnector 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.
Input Types
Return Types
Errors
Error | Description |
---|---|
|
|
Example
The first example shows the command that creates a new Send connector that sends e-mail messages over the Internet. The example shows the minimum parameters that are required to create a Send connector. The address space is restricted to send messages only to the Contoso.com domain and the Microsoft.com domain.
The second example shows the commands that create a new Send connector that sends e-mail messages to Contoso.com. The Contoso.com e-mail server requires that the local Exchange 2007 server authenticate with it to submit e-mail messages. To configure the Send connector to use authentication, you must first run the Get-Credential command and assign it to a variable. When you run the Get-Credential command, the command asks for the username and password of the account that is used during authentication with the Contoso.com e-mail server.
In the second example, the Get-Credential cmdlet
is assigned to the $CredentialObject variable. After the
authentication credentials are assigned to the
$CredentialObject variable, the new Send connector can be
created by using the New-SendConnector cmdlet. The
$CredentialObject variable is passed to the
AuthenticationCredential parameter. In addition to setting
the credentials, the SmartHostAuthMechanism parameter must
be set to BasicAuth
to instruct the Send connector to
authenticate with the Contoso.com e-mail server by using the
supplied credentials.
Copy Code | |
---|---|
New-SendConnector -Name Test -AddressSpaces contoso.com,microsoft.com $CredentialObject = Get-Credential New-SendConnector -Name "Secure E-Mail to Contoso.com" -AddressSpaces contoso.com -AuthenticationCredential $CredentialObject -SmartHostAuthMechanism BasicAuth |