Export (0) Print
Expand All
0 out of 1 rated this helpful - Rate this topic

Set-AdSite

 

Applies to: Exchange Server 2013

Topic Last Modified: 2012-06-12

Use the Set-AdSite cmdlet to configure the Exchange settings of Active Directory sites.

Set-AdSite -Identity <AdSiteIdParameter> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-HubSiteEnabled <$true | $false>] [-InboundMailEnabled <$true | $false>] [-MinorPartnerId <Int32>] [-PartnerId <Int32>] [-ResponsibleForSites <MultiValuedProperty>] [-WhatIf [<SwitchParameter>]]

This example configures the Active Directory site named Default-First-Site-Name as a hub site.

Set-AdSite Default-First-Site-Name -HubSiteEnabled $true

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 "Transport configuration" entry in the Mail Flow Permissions topic.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.AdSiteIdParameter

The Identity parameter specifies the identity of the Active Directory site you want to modify. You can use any value that uniquely identifies the site. For example, you can use the name, GUID or distinguished name (DN) of the Active Directory site.

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.

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.

HubSiteEnabled

Optional

System.Boolean

The HubSiteEnabled parameter specifies whether this site acts as a hub site. The default value is $false.

InboundMailEnabled

Optional

System.Boolean

The InboundMailEnabled parameter enables or disables receiving incoming messages for all the Exchange located in the Active Directory site. Typically, this parameter is used after Active Directory site failover or maintenance.

Valid input for this parameter is $true or $false. The default value is $true. If you set the value to $false, none of the Exchange servers in the Active Directory site will be able to receive incoming messages.

MinorPartnerId

Optional

System.Int32

This parameter is reserved for internal Microsoft use.

PartnerId

Optional

System.Int32

This parameter is reserved for internal Microsoft use.

ResponsibleForSites

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter is reserved for internal Microsoft use.

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.

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.

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.

 
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.