Applies to: Exchange Server 2013

Topic Last Modified: 2012-06-15

Use the Set-DeliveryAgentConnector cmdlet to configure a specific delivery agent connector in your organization.

Syntax

Set-DeliveryAgentConnector -Identity <DeliveryAgentConnectorIdParameter> [-AddressSpaces <MultiValuedProperty>] [-Comment <String>] [-Confirm [<SwitchParameter>]] [-DeliveryProtocol <String>] [-DomainController <Fqdn>] [-Enabled <$true | $false>] [-Force <SwitchParameter>] [-IsScopedConnector <$true | $false>] [-MaxConcurrentConnections <Int32>] [-MaxMessageSize <Unlimited>] [-MaxMessagesPerConnection <Int32>] [-Name <String>] [-SourceTransportServers <MultiValuedProperty>] [-WhatIf [<SwitchParameter>]]

Examples

EXAMPLE 1

This example configures restrictions on the delivery agent connector Contoso X.400 Connector. It makes the following configuration changes:

  • Sets the maximum message size allowed through the connector to 10 MB.

  • Sets the maximum number of messages allowed per connection to 100.

  • Sets the maximum concurrent connections to 10.

Copy Code
Set-DeliveryAgentConnector "Contoso X.400 Connector" -MaxMessageSize 10MB -MaxMessagesPerConnection 100 -MaxConcurrentConnections 10

EXAMPLE 2

This example uses the temporary variable $ConnectorConfig to add the address space c=US;p=Fabrikam;a=Contoso;o=Sales to the delivery agent connector Contoso X.400 Connector and also adds the server Hub04 to the list of servers that host the connector.

Copy Code
$ConnectorConfig = Get-DeliveryAgentConnector "Contoso X.400 Connector"
$ConnectorConfig.AddressSpaces += "X400:c=US;p=Fabrikam;a=Contoso;o=Sales;1" 
$ConnectorConfig.SourceTransportServers += Hub04
Set-DeliveryAgentConnector "Contoso X.400 Connector" -AddressSpaces $ConnectorConfig.AddressSpaces -SourceTransportServers $ConnectorConfig.SourceTransportServers

Detailed Description

Delivery agent connectors are used to route messages addressed to foreign systems that don't use the SMTP protocol. When a message is routed to a delivery agent connector, the associated delivery agent performs the content conversion and message delivery. Delivery agent connectors allow queue management of foreign connectors, thereby eliminating the need for storing messages on the file system in Drop and Pickup directories. For more information, see Delivery Agents and Delivery Agent Connectors.

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 "Delivery agent connectors" entry in the Mail Flow Permissions topic.

Parameters

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.DeliveryAgentConnectorIdParameter

The Identity parameter specifies the GUID or name of the delivery agent connector.

AddressSpaces

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The AddessSpaces parameter specifies the domain names for which this delivery agent connector is responsible. The syntax for entering an address space is as follows: <AddressSpaceType>:<AddressSpace>;<AddressSpaceCost>. You must enclose each address space in quotation marks (").

Comment

Optional

System.String

The Comment parameter specifies an optional comment. If you specify a value that contains spaces, enclose the value in quotation marks ("), for example: "This is an admin note".

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You don't have to specify a value with the Confirm switch.

DeliveryProtocol

Optional

System.String

The DeliveryProtocol parameter specifies the communication protocol that determines which delivery agents are responsible for servicing the connector.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory.

Enabled

Optional

System.Boolean

The Enabled parameter specifies whether the delivery agent connector is enabled.

The default value is $true.

Force

Optional

System.Management.Automation.SwitchParameter

The Force switch specifies whether to suppress warning or confirmation messages. This switch can be used when the task is run programmatically and prompting for administrative input is inappropriate. If the Force switch isn't provided in the command, you're prompted for administrative input. You don't have to specify a value with this parameter.

IsScopedConnector

Optional

System.Boolean

The IsScopedConnector parameter specifies the availability of the connector to other Mailbox servers. If the value of this parameter is $false, the connector can be used by all Mailbox servers in your organization. If the value of this parameter is $true, the connector can only be used by Mailbox servers in the same Active Directory site.

The default value is $false.

MaxConcurrentConnections

Optional

System.Int32

The MaxConcurrentConnections parameter specifies the maximum number of concurrent connections this connector accepts from a specific IP address.

The default value is 5.

MaxMessageSize

Optional

Microsoft.Exchange.Data.Unlimited

The MaxMessageSize parameter specifies the maximum size of a message that's allowed to pass through this connector. When you enter a value, qualify the value with one of the following units:

  • B (bytes)

  • KB (kilobytes)

  • MB (megabytes)

  • GB (gigabytes)

Unqualified values are treated as bytes. The valid input range for this parameter is from 65536 through 2147483647 bytes.

The default value is unlimited.

MaxMessagesPerConnection

Optional

System.Int32

The MaxMessagesPerConnection parameter specifies the maximum number of messages this connector accepts per connection. The connector terminates the connection after this limit is reached and the sending server has to initiate a new connection to send more messages.

The default value is 20.

Name

Optional

System.String

The Name parameter specifies the name of this delivery agent connector. The value for the Name parameter can't exceed 64 characters.

SourceTransportServers

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The SourceTransportServers parameter specifies the list of Mailbox servers that host this connector. You can specify more than one server by separating their names with commas.

By default, only the local server on which the command is executed is added to this parameter.

WhatIf

Optional

System.Management.Automation.SwitchParameter

The WhatIf switch instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, you can view what changes would occur without having to apply any of those changes. You don't have to specify a value with the WhatIf switch.

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.