Set-AdSiteLink
Applies to: Exchange Server 2007 SP1, Exchange Server 2007 SP2, Exchange Server 2007 SP3
Use the Set-AdSiteLink cmdlet to assign an Exchange-specific cost to an Active Directory IP site link. You can also use this cmdlet to configure the maximum message size that can pass across an Active Directory IP site link.
Syntax
Set-AdSiteLink -Identity <AdSiteLinkIdParameter> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-ExchangeCost <Nullable>] [-MaxMessageSize <Unlimited>] [-Name <String>] [-WhatIf [<SwitchParameter>]]
Set-AdSiteLink [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-ExchangeCost <Nullable>] [-Instance <ADSiteLink>] [-MaxMessageSize <Unlimited>] [-Name <String>] [-WhatIf [<SwitchParameter>]]
Detailed Description
In Microsoft Exchange Server 2007, computers that have the Hub Transport server role installed use Active Directory sites and the costs that are assigned to the Active Directory IP site links to determine the least cost routing path from each Hub Transport server in the organization to every other Hub Transport server in the organization. After the least cost routing path is determined, the source Hub Transport servers relay messages to the target Hub Transport servers. By default, the Hub Transport servers that are located in Active Directory sites along the path between the source server and the target server do not process or relay the messages in any way.
However, you can configure an Active Directory site as a hub site so that messages are routed to the hub site to be processed before the messages are relayed to the target server. For this routing behavior to occur, the hub site must exist along the least cost routing path between two Hub Transport servers. You use the Set-AdSiteLink cmdlet to configure an Active Directory site as a hub site.
The least cost routing path is also used if a message cannot be delivered to the target site. In this case, message delivery queues at the Hub Transport servers in the closest reachable site along the least cost routing path of the target site.
By default, Exchange 2007 determines the least cost routing path by using the cost that is assigned to the Active Directory IP site link. You can use the Set-AdSiteLink cmdlet to assign an Exchange-specific cost to the Active Directory IP site link. The Exchange-specific cost is a separate attribute that is used instead of the Active Directory-assigned cost to determine the least cost routing path.
By default, Exchange 2007 does not impose a maximum message size limit on messages that are relayed between Hub Transport servers in different Active Directory sites. If you use the Set-AdSiteLink cmdlet to configure a maximum message size on an Active Directory IP site link, routing generates a non-delivery report (NDR) for any message that has a size larger than the maximum message size limit that is configured on any Active Directory site link in the least cost routing path. This configuration is useful for restricting the size of messages that are sent to remote Active Directory sites that must communicate over low-bandwidth connections.
To run the Set-AdSiteLink cmdlet, the account you use must be delegated the following:
- Exchange Organization Administrator role
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.AdSiteLinkIdParameter |
Use the Identity parameter to specify the name or GUID of the IP site link for which you want to set an Exchange-specific cost. |
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
The Confirm parameter 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 parameter. |
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
Use the DomainController parameter to specify the host name or the fully qualified domain name (FQDN) of the domain controller that will process this query. |
ExchangeCost |
Optional |
System.Nullable |
Use the ExchangeCost parameter to assign an Exchange-specific cost to the IP site link. This cost is used instead of the Active Directory-assigned cost when the Hub Transport servers calculate the least cost routing paths. To clear the value of the ExchangeCost parameter and revert to using the value of the ADCost parameter, set the ExchangeCost parameter to |
Instance |
Optional |
Microsoft.Exchange.Data.Directory.SystemConfiguration.ADSiteLink |
Use the Instance parameter to pass a complete object to the cmdlet to be processed. This parameter is useful in scripts where an entire object must be passed to the cmdlet. |
MaxMessageSize |
Optional |
Microsoft.Exchange.Data.Unlimited |
Use the MaxMessageSize parameter to specify the maximum size of a message that can pass across the Active Directory IP site link. The default value is
Unqualified values are treated as bytes. The valid input range for this parameter is |
Name |
Optional |
System.String |
Use the Name parameter to assign a name to the IP site link. The name that you assign will overwrite the current identity of the IP site link. You must be an Enterprise Administrator to modify this value. |
WhatIf |
Optional |
System.Management.Automation.SwitchParameter |
The WhatIf parameter instructs the command to simulate the actions that it would take on the object. By using the WhatIf parameter, 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 parameter. |
Input Types
Return Types
Errors
| Error | Description |
|---|---|
|
|
Exceptions
| Exceptions | Description |
|---|---|
|
|
Example
The following example uses the Set-AdSiteLink cmdlet to assign an Exchange-specific cost of 25 and a maximum message size limit of 10 MB to the specified IP site link.
Set-AdSiteLink -Identity DEFAULTIPSITELINK -ExchangeCost 25 -MaxMessageSize 10MB