Export (0) Print
Expand All
Expand Minimize

Set-ADReplicationSite

Windows Server 2012 R2 and Windows 8.1

Updated: July 8, 2014

Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2

Set-ADReplicationSite

Sets the replication properties for an Active Directory site.

Syntax

Parameter Set: Identity
Set-ADReplicationSite [-Identity] <ADReplicationSite> [-Add <Hashtable> ] [-AuthType <ADAuthType> {Negotiate | Basic} ] [-AutomaticInterSiteTopologyGenerationEnabled <Boolean> ] [-AutomaticTopologyGenerationEnabled <Boolean> ] [-Clear <String[]> ] [-Credential <PSCredential> ] [-Description <String> ] [-InterSiteTopologyGenerator <ADDirectoryServer> ] [-ManagedBy <ADPrincipal> ] [-PassThru] [-ProtectedFromAccidentalDeletion <Boolean> ] [-RedundantServerTopologyEnabled <Boolean> ] [-Remove <Hashtable> ] [-Replace <Hashtable> ] [-ReplicationSchedule <ActiveDirectorySchedule> ] [-ScheduleHashingEnabled <Boolean> ] [-Server <String> ] [-TopologyCleanupEnabled <Boolean> ] [-TopologyDetectStaleEnabled <Boolean> ] [-TopologyMinimumHopsEnabled <Boolean> ] [-UniversalGroupCachingEnabled <Boolean> ] [-UniversalGroupCachingRefreshSite <ADReplicationSite> ] [-WindowsServer2000BridgeheadSelectionMethodEnabled <Boolean> ] [-WindowsServer2000KCCISTGSelectionBehaviorEnabled <Boolean> ] [-WindowsServer2003KCCBehaviorEnabled <Boolean> ] [-WindowsServer2003KCCIgnoreScheduleEnabled <Boolean> ] [-WindowsServer2003KCCSiteLinkBridgingEnabled <Boolean> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: Instance
Set-ADReplicationSite -Instance <ADReplicationSite> [-AuthType <ADAuthType> {Negotiate | Basic} ] [-Credential <PSCredential> ] [-PassThru] [-Server <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed Description

The Set-ADReplicationSite cmdlet is used to set the properties for an Active Directory site that is being used for replication. Sites are used in Active Directory to either enable clients to discover network resources (published shares, domain controllers) close to the physical location of a client computer or to reduce network traffic over wide area network (WAN) links. Sites can also be used to optimize replication between domain controllers.

Parameters

-Add<Hashtable>

Specifies values to add to an object property. Use this parameter to add one or more values to a property that cannot be modified using a cmdlet parameter. To modify an object property, you must use the LDAP display name. You can specify multiple values to a property by specifying a comma-separated list of values and more than one property by separating them using a semicolon.. The format for this parameter is:

-Add @{Attribute1LDAPDisplayName=value1, value2, ...; Attribute2LDAPDisplayName=value1, value2, ...; AttributeNLDAPDisplayName=value1, value2, ...}

When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the following order:

-- Remove
-- Add
-- Replace
-- Clear


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-AuthType<ADAuthType>

Specifies the authentication method to use. The acceptable values for this parameter are: 

-- Negotiate or 0
-- Basic or 1

The default authentication method is Negotiate.

A Secure Sockets Layer (SSL) connection is required for the Basic authentication method.


Aliases

none

Required?

false

Position?

named

Default Value

Microsoft.ActiveDirectory.Management.AuthType.Negotiate

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-AutomaticInterSiteTopologyGenerationEnabled<Boolean>

Indicates whether the cmdlet prevents the KCC that functions as the intersite topology generator (ISTG) from generating connections for intersite replication. Use this option when you want to create manual intersite connections (disable the ISTG) but retain the KCC to generate intrasite connections.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-AutomaticTopologyGenerationEnabled<Boolean>

Indicates whether to enable automatic topology generation. When enabled, prevents the KCC from generating intrasite connections on all servers in the site. Disable this option if you use manual connections and do not want the KCC to build connections automatically.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Clear<String[]>

Specifies an array of object properties that will be cleared in the directory. Use this parameter to clear one or more values of a property that cannot be modified using a cmdlet parameter. To modify an object property, you must use the LDAP display name. You can modify more than one property by specifying a comma-separated list. The format for this parameter is:

-Clear Attribute1LDAPDisplayName, Attribute2LDAPDisplayName

When you use the Add, Remove, Replace, and Clear parameters together, the operations will be performed in the following order:

-- Remove
-- Add
-- Replace
-- Clear


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Credential<PSCredential>

Specifies a user account that has permission to perform this action. The default is the current user.

Type a user name, such as User01 or Domain01\User01, or enter a PSCredential object, such as one generated by the Get-Credential cmdlet. If you type a user name, you will be prompted for a password.

This parameter is not supported by any providers installed with Windows PowerShell.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Description<String>

Specifies a description of the object. This parameter sets the value of the Description property for the object. The LDAP Display Name (ldapDisplayName) for this property is description.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Identity<ADReplicationSite>

Specifies an Active Directory object by providing one of the following property values. The identifier in parentheses is the LDAP display name for the attribute. The acceptable values for this parameter are: 

-- A Distinguished Name
-- A GUID (objectGUID)

The cmdlet searches the default naming context or partition to find the object. If two or more objects are found, the cmdlet returns a non-terminating error.

This parameter can also get this object through the pipeline or you can set this parameter to an object instance.


Aliases

none

Required?

true

Position?

1

Default Value

None

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-Instance<ADReplicationSite>

Specifies an instance of a site object to use as a template for a new site object.

You can use an instance of an existing site object as a template or you can construct a new site object by using the Windows PowerShell command line or by using a script.

Method 1: Use an existing site object as a template for a new object. To retrieve an instance of an existing site object, use a cmdlet such as Get-ADReplicationSite. Then provide this object to the Instance parameter of the New-ADReplicationSite cmdlet to create a new site object. You can override property values of the new object by setting the appropriate parameters.

Method 2: Create a new ADReplicationSite and set the property values by using the Windows PowerShell command line interface. Then pass this object to the Instance parameter of the New-ADReplicationSite cmdlet to create the new Active Directory object.

Note: Specified attributes are not validated, so attempting to set attributes that do not exist or cannot be set will raise an error.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-InterSiteTopologyGenerator<ADDirectoryServer>

Specifies the server acting as the inter-site topology generator for this site.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ManagedBy<ADPrincipal>

Specifies the user or group that manages the object by providing one of the following property values:

-- Distinguished Name
-- GUID (objectGUID)
-- Security Identifier (objectSid)
-- SAM Account Name (sAMAccountName)

Note: The identifier in parentheses is the LDAP display name for the property.

This parameter sets the Active Directory attribute with an LDAP Display Name of managedBy.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ProtectedFromAccidentalDeletion<Boolean>

Specifies whether to prevent the object from being deleted. When this property is set to $True, you cannot delete the corresponding object without changing the value of the property. The acceptable values for this parameter are: 

-- $False or 0
-- $True or 1


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-RedundantServerTopologyEnabled<Boolean>

Indicates whether the cmdlet creates redundant connections between sites before a failure takes place. When enabled, disables KCC failover. Requires that automatic detection of failed connections also be disabled (+IS_TOPL_DETECT_STALE_DISABLED).


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Remove<Hashtable>

Specifies that the cmdlet remove values of an object property. Use this parameter to remove one or more values of a property that cannot be modified using a cmdlet parameter. To remove an object property, you must use the LDAP display name. You can remove more than one property by specifying a semicolon-separated list. The format for this parameter is:

-Remove @{Attribute1LDAPDisplayName=value[]; Attribute2LDAPDisplayName=value[]}

When you use the Add, Remove, Replace, and Clear parameters together, the parameters will be applied in the following sequence:

-- Remove
-- Add
-- Replace
-- Clear


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Replace<Hashtable>

Specifies values for an object property that will replace the current values. Use this parameter to replace one or more values of a property that cannot be modified using a cmdlet parameter. To modify an object property, you must use the LDAP display name. You can modify more than one property by specifying a comma-separated list. The format for this parameter is:

-Replace @{Attribute1LDAPDisplayName=value[], Attribute2LDAPDisplayName=value[]}

When you use the Add, Remove, Replace, and Clear parameters together, the parameters will be applied in the following sequence:

-- Remove
-- Add
-- Replace
-- Clear


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ReplicationSchedule<ActiveDirectorySchedule>

Specifies the default replication schedule for connections within this site (intra-site replication).


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ScheduleHashingEnabled<Boolean>

Indicates whether the cmdlet spreads replication start times randomly across the entire schedule interval rather than just the first quarter of the interval.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Server<String>

Specifies the Active Directory Domain Services instance to connect to, by providing one of the following values for a corresponding domain name or directory server. The service may be any of the following: Active Directory Lightweight Domain Services, Active Directory Domain Services or Active Directory Snapshot instance.

Specify the Active Directory Domain Services instance in one of the following ways:

-- Domain name values:

---- Fully qualified domain name
---- NetBIOS name

-- Directory server values:

---- Fully qualified directory server name
---- NetBIOS name
---- Fully qualified directory server name and port

The default value for this parameter is determined by one of the following methods in the order that they are listed:

-- By using the Server value from objects passed through the pipeline
-- By using the server information associated with the Active Directory Domain ServicesWindows PowerShell provider drive, when the cmdlet runs in that drive
-- By using the domain of the computer running Windows PowerShell


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-TopologyCleanupEnabled<Boolean>

Indicates whether the cmdlet enables topology cleanup. When enabled, this optional parameter prevents the Kerberos consistency checker (KCC) from removing connection objects that it does not need. Disable this option if you want to take responsibility for removing old redundant connections. Alternatively, to control or augment the topology, you can use manual connections, which the KCC does not delete.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-TopologyDetectStaleEnabled<Boolean>

Indicates whether the cmdlet enables topology detect stale. This parameter option prevents the Kerberos consistency checker (KCC) from excluding servers that are unreachable from the topology; that is, the KCC does use an alternate server to reroute replication. Use this option only if network communication is very unstable and brief outages are expected.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-TopologyMinimumHopsEnabled<Boolean>

Indicates whether the cmdlet enables topology minimium hops. When enabled, this parameter prevents the Kerberos consistency checker (KCC) from generating optimizing connections in the ring topology of intrasite replication. Optimizing connections reduce the replication latency in the site and disabling them is not recommended.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-UniversalGroupCachingEnabled<Boolean>

Indicates whether the cmdlet enables universal group caching. If this parameter is true, it indicates this site caches universal groups, which are those groups cached on global catalog (GC) servers. It can be useful in sites with no GC servers available locally.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-UniversalGroupCachingRefreshSite<ADReplicationSite>

Specifies the name of a site. If universal group caching is enabled, this parameter sets the name of the site from which the cache is pulled.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WindowsServer2000BridgeheadSelectionMethodEnabled<Boolean>

Indicates whether the cmdlet implements the Windows 2000 Server method of selecting a single bridgehead server per directory partition and transport.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WindowsServer2000KCCISTGSelectionBehaviorEnabled<Boolean>

Indicates whether the cmdlet implements the Windows 2000 Server method of Intersite Topology Generator (ISTG) selection. By default, it is disabled.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WindowsServer2003KCCBehaviorEnabled<Boolean>

Indicates whether the cmdlet implements Kerberos consistency checker (KCC) operation that is consistent with Windows Server 2003 forest functional level. This option can be set if all domain controllers in the site are running Windows Server 2003.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WindowsServer2003KCCIgnoreScheduleEnabled<Boolean>

Indicates whether to ignore schedules. When the forest functional level Windows Server 2003 or Windows Server 2003 interim is in effect, provides KCC control of the ability to ignore schedules (replication occurs at the designated intervals and is always available).


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WindowsServer2003KCCSiteLinkBridgingEnabled<Boolean>

Indicates whether the cmdlet enables site link bridging. When the forest functional level Windows Server 2003 or Windows Server 2003 interim is in effect, provides Kerberos consistency checker (KCC) control of the ability to enable or disable site link bridging.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • None or Microsoft.ActiveDirectory.Management.ADReplicationSite

    A site object is received by the Identity parameter.

    A site object that was retrieved by using the Get-ADReplicationSite cmdlet and then modified is received by the Instance parameter.


Outputs

The output type is the type of the objects that the cmdlet emits.

  • None or Microsoft.ActiveDirectory.Management.ADReplicationSite

Examples

-------------------------- EXAMPLE 1 --------------------------

The command sets the properties of the site with name NorthAmerica to prevent its intersite topology generator (ISTG) at corp-DC02 from generating connections for intersite replication.


PS C:\> Set-ADReplicationSite -Identity NorthAmerica -InterSiteTopologyGenerator corp-DC02 -AutomaticInterSiteTopologyGenerationEnabled $False

-------------------------- EXAMPLE 2 --------------------------

This command returns all the sites in the directory and sets the ScheduleHashingEnabled property to spread replication start times randomly across the entire schedule interval rather than just the first quarter of the interval.


PS C:\> Get-ADReplicationSite -Filter * | % {Set-ADReplicationSite $_ -ScheduleHashingEnabled $True}

-------------------------- EXAMPLE 3 --------------------------

This example sets the daily replication schedule of the site with name Asia.


PS C:\> $schedule = New-Object -TypeName System.DirectoryServices.ActiveDirectory.ActiveDirectorySchedule
PS C:\> $schedule.ResetSchedule()
PS C:\> $schedule.SetDailySchedule("Twenty","Zero","TwentyTwo","Thirty")
PS C:\> Set-ADReplicationSite -Identity "Asia" -ReplicationSchedule $schedule

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft