Applies to: Exchange Server 2010 SP3, Exchange Server 2010 SP2
Topic Last Modified: 2011-05-05
Use the New-EdgeSubscription cmdlet to export an Edge Subscription file from a computer that has the Edge Transport server role installed and to import the Edge Subscription file to a computer that has the Hub Transport server role installed.
Syntax
New-EdgeSubscription [-AccountExpiryDuration
<TimeSpan>] [-Confirm [<SwitchParameter>]]
[-CreateInboundSendConnector <$true | $false>]
[-CreateInternetSendConnector <$true | $false>]
[-DomainController <Fqdn>] [-FileData <Byte[]>]
[-FileName <LongPath>] [-Force <SwitchParameter>]
[-Site <AdSiteIdParameter>] [-WhatIf
[<SwitchParameter>]]
|
Detailed Description
The Edge Transport server role doesn't have access to Active Directory. All configuration and recipient information is stored in the Active Directory Lightweight Directory Services (AD LDS) instance. The New-EdgeSubscription cmdlet creates the Edge Subscription file that will be imported on a Hub Transport server in the Active Directory site to which you want to subscribe this Edge Transport server. For more information about this process, see Understanding Edge Subscriptions.
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 "EdgeSync" entry in the Transport Permissions topic.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
AccountExpiryDuration |
Optional |
System.TimeSpan |
The AccountExpiryDuration parameter specifies how soon the bootstrap account created by this command will expire. The value for this parameter must be a minimum of 2 minutes. |
|
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. |
|
CreateInboundSendConnector |
Optional |
System.Boolean |
The CreateInboundSendConnector parameter specifies
whether to create the Send connector to connect the Edge Transport
server and the Hub Transport servers. The default value is
|
|
CreateInternetSendConnector |
Optional |
System.Boolean |
The CreateInternetSendConnector parameter specifies
whether to create the Send connector to connect to the Internet.
The default value is |
|
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. The DomainController parameter isn't supported on the Edge Transport server role. The Edge Transport server role writes only to the Active Directory Lightweight Directory Services (AD LDS) instance. |
|
FileData |
Optional |
System.Byte[] |
The FileData parameter specifies the byte-encoded data object that contains the Edge Subscription file information. The Remote PowerShell in Exchange 2010 doesn't support file paths for cmdlets. Therefore, you need to read the contents of the Edge Subscription file to a byte-encoded object using the Get-Content cmdlet and then pass this object to the New-EdgeSubscription cmdlet to import the Edge Subscription on a Hub Transport server. For more information about the syntax required to use this parameter, see Understanding Importing and Exporting Files in the Exchange Management Shell. You can only use this parameter when you're running this command on a Hub Transport server. |
|
FileName |
Optional |
Microsoft.Exchange.Data.LongPath |
The FileName parameter specifies the full path of the Edge Subscription file. You can only use this parameter when you're running this command on an Edge Transport server. |
|
Force |
Optional |
System.Management.Automation.SwitchParameter |
The Force parameter specifies whether to bypass the confirmation prompt when you run the command on an Edge Transport server. This parameter also causes the command to overwrite an existing Edge Subscription file with the same name as the file you're creating. This parameter is useful when you use a script with the Edge Subscription command because it bypasses confirmation. Another scenario in which this parameter is useful is when you have to subscribe an Edge Transport server again, and you want to overwrite the existing configuration information. |
|
Site |
Optional |
Microsoft.Exchange.Configuration.Tasks.AdSiteIdParameter |
The Site parameter specifies the name of the Active Directory site that contains the Hub Transport servers with which the Edge Transport servers are associated. This parameter is used only when you run the command on a Hub Transport server and it's a required parameter when the command is run on a Hub Transport server. |
|
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.
Examples
EXAMPLE 1
This example creates the Edge Subscription file. It should be run on your Edge Transport server.
 Copy Code |
|
|---|---|
New-EdgeSubscription -FileName "c:\EdgeServerSubscription.xml" |
|
EXAMPLE 2
This example imports the Edge Subscription file
generated in EXAMPLE 1 to the Active Directory site
Default-First-Site-Name. Importing the Edge
Subscription file completes the Edge Subscription process. You must
run this command on the Hub Transport server.
The first command reads the data from the Edge Subscription file and stores it in a temporary variable as a byte-encoded data object. The second command completes the Edge subscription process.
| Copy Code |
|
|---|---|
[byte[]]$Temp = Get-Content -Path "C:\EdgeServerSubscription.xml" -Encoding Byte -ReadCount 0 New-EdgeSubscription -FileData $Temp -Site "Default-First-Site" |
|
EXAMPLE 3
This example also imports the Edge Subscription file
generated in EXAMPLE 1 to the Active Directory site
Default-First-Site-Name; however, the end result is
accomplished in a single line of code. You must run this command on
the Hub Transport server.
| Copy Code |
|
|---|---|
New-EdgeSubscription -FileData ([byte[]]$(Get-Content -Path "C:\EdgeServerSubscription.xml" -Encoding Byte -ReadCount 0)) -Site "Default-First-Site" |
|