< Back
Set-ADReplicationSite
Post
NAME Set-ADReplicationSite
SYNOPSIS
Sets the replication properties for an Active Directory site.
SYNTAX
Set-ADReplicationSite [-Identity] <ADReplicationSite> [-Add <Hashtable>] [-AuthType {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>]
Set-ADReplicationSite [-AuthType {Negotiate | Basic}] [-Credential <PSCredential>] [-PassThru] [-Server <String>]
-Instance <ADReplicationSite> [-Confirm] [-WhatIf] [<CommonParameters>]
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, ...}
For example, if you want to remove the value "555-222-2222" and add the values "555-222-1111" and
"555-222-3333" to Phone-Office-Other attribute (LDAP display name 'otherTelephone'), and add the value
"555-222-9999" to Phone-Mobile-Other (LDAP display name 'otherMobile'), set the Add and Remove parameters as
follows.
-Add @{otherTelephone='555-222-1111', '555-222-3333'; otherMobile='555-222-9999' } -Remove
@{otherTelephone='555-222-2222'}
When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the
following order:
..Remove
..Add
..Replace
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-AuthType <ADAuthType>
Specifies the authentication method to use. Possible values for this parameter include:
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.
The following example shows how to set this parameter to Basic.
-AuthType Basic
Required? false
Position? named
Default value Microsoft.ActiveDirectory.Management.AuthType.Negotiate
Accept pipeline input? false
Accept wildcard characters? false
-AutomaticInterSiteTopologyGenerationEnabled <Boolean>
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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-AutomaticTopologyGenerationEnabled <Boolean>
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.
Required? false
Position? named
Default value
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
For example, if you want to clear the value for the Phone-Office-Other attribute (LDAP display name
'otherTelephone') set the Clear parameter as follows.
-Clear otherTelephone
When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the
following order:
..Remove
..Add
..Replace
..Clear
Required? false
Position? named
Default value
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.
Required? false
Position? named
Default value
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".
Required? false
Position? named
Default value
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.
Distinguished Name
Example: CN=NorthAmerica,CN=Sites,CN=Configuration,DC=corp,DC=contoso,DC=com
GUID (objectGUID)
Example: 599c3d2e-f72d-4d20-8a88-030d99495f20
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.
This example shows how to set this parameter to an ADObject object instance named "ADObjectInstance".
-Identity $ADObjectInstance
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. The following examples show how to use these
two methods to create a new site object.
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.
$objectInstance = Get-ADReplicationSite -Identity NorthAmerica
New-ADReplicationSite -Name "SouthAmerica" -Instance $ObjectInstance
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.
$objectInstance = new-object Microsoft.ActiveDirectory.Management.ADReplicationSite
$objectInstance.Description = North America"
New-ADReplicationSite -Name "NorthAmerica" -Instance $ObjectInstance
Note: Specified attributes are not validated, so attempting to set attributes that do not exist or cannot be
set will raise an error.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-InterSiteTopologyGenerator <ADDirectoryServer>
The server acting as the inter-site topology generator for this site.
Required? false
Position? named
Default value
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. Note:
The identifier in parentheses is the LDAP display name for the property.
Distinguished Name
Example: CN=SaraDavis,OU=Europe,CN=Users,DC=corp,DC=contoso,DC=com
GUID (objectGUID)
Example: 599c3d2e-f72d-4d20-8a88-030d99495f20
Security Identifier (objectSid)
Example: S-1-5-21-3165297888-301567370-576410423-1103
SAM Account Name (sAMAccountName)
Example: saradavis
This parameter sets the Active Directory attribute with an LDAP Display Name of "managedBy".
The following example shows how to specify this parameter.
-ManagedBy ContosoAdmins
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
Returns the new or modified object. By default (i.e. if -PassThru is not specified), this cmdlet does not
generate any output.
Required? false
Position? named
Default value
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. Possible values for this parameter
include:
$false or 0
$true or 1
The following example shows how to set this parameter to true.
-ProtectedFromAccidentalDeletion $true
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-RedundantServerTopologyEnabled <Boolean>
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).
Required? false
Position? named
Default value
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[]}
For example, if you want to add the values blue and green and remove the value pink from a property with a
LDAP display name of FavColors, set the Add and Remove parameters as follows.
-Add @{FavColors=Blue,Green} -Remove {FavColors=Pink}
When you use the Add, Remove, Replace and Clear parameters together, the parameters will be applied in the
following sequence:
..Remove
..Add
..Replace
..Clear
Required? false
Position? named
Default value
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[]}
For example, if you want to replace the value "555-222-2222" with the values "555-222-1111" for
Phone-Office-Other attribute (LDAP display name 'otherTelephone') set the Replace parameter as follows.
-Replace @{otherTelephone='555-222-2222', '555-222-1111'}
When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the
following order:
..Remove
..Add
..Replace
..Clear
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ReplicationSchedule <ActiveDirectorySchedule>
Default replication schedule for connections within this site (intra-site replication).
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ScheduleHashingEnabled <Boolean>
Spreads replication start times randomly across the entire schedule interval rather than just the first
quarter of the interval.
Required? false
Position? named
Default value
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.
Domain name values:
Fully qualified domain name
Examples: corp.contoso.com
NetBIOS name
Example: CORP
Directory server values:
Fully qualified directory server name
Example: corp-DC12.corp.contoso.com
NetBIOS name
Example: corp-DC12
Fully qualified directory server name and port
Example: corp-DC12.corp.contoso.com:3268
The default value for the Server parameter is determined by one of the following methods in the order that
they are listed:
-By using Server value from objects passed through the pipeline.
-By using the server information associated with the Active Directory PowerShell provider drive, when running
under that drive.
-By using the domain of the computer running Powershell.
The following example shows how to specify a full qualified domain name as the parameter value.
-Server "corp.contoso.com"
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-TopologyCleanupEnabled <Boolean>
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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-TopologyDetectStaleEnabled <Boolean>
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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-TopologyMinimumHopsEnabled <Boolean>
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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-UniversalGroupCachingEnabled <Boolean>
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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-UniversalGroupCachingRefreshSite <ADReplicationSite>
If universal group caching is enabled, this parameter sets the name of the site from which the cache is pulled.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-WindowsServer2000BridgeheadSelectionMethodEnabled <Boolean>
Implements the Windows2000Server method of selecting a single bridgehead server per directory partition and
transport.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-WindowsServer2000KCCISTGSelectionBehaviorEnabled <Boolean>
When enabled, this parameter implements the Windows2000Server method of Intersite Topology Generator (ISTG)
selection. By default, it is disabled.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-WindowsServer2003KCCBehaviorEnabled <Boolean>
Implements Kerberos consistency checker (KCC) operation that is consistent with WindowsServer2003 forest
functional level. This option can be set if all domain controllers in the site are running WindowsServer2003.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-WindowsServer2003KCCIgnoreScheduleEnabled <Boolean>
When the forest functional level WindowsServer2003 or WindowsServer2003 interim is in effect, provides KCC
control of the ability to ignore schedules (replication occurs at the designated intervals and is always
available).
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-WindowsServer2003KCCSiteLinkBridgingEnabled <Boolean>
When the forest functional level WindowsServer2003 or WindowsServer2003 interim is in effect, provides
Kerberos consistency checker (KCC) control of the ability to enable or disable site link bridging.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value false
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
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, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
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
None or Microsoft.ActiveDirectory.Management.ADReplicationSite
-------------------------- EXAMPLE 1 --------------------------
C:\\PS>Set-ADReplicationSite NorthAmerica -InterSiteTopologyGenerator corp-DC02
-AutomaticInterSiteTopologyGenerationEnabled $false
Description
-----------
Set the properties of the site with name 'NorthAmerica' to prevent its intersite topology generator (ISTG) at
???????corp-DC02???????? from generating connections for intersite replication.
-------------------------- EXAMPLE 2 --------------------------
C:\\PS>Get-ADReplicationSite -Filter * | % {Set-ADReplicationSite $_ -ScheduleHashingEnabled $true}
Description
-----------
Returns all the sites in the directory and sets the ScheduleHashingEnabled propertyto spread replication start
times randomly across the entire schedule interval rather than just the first quarter of the interval..
-------------------------- EXAMPLE 3 --------------------------
C:\\PS>$schedule = New-Object -TypeName System.DirectoryServices.ActiveDirectory.ActiveDirectorySchedule;
$schedule.ResetSchedule();
$schedule.SetDailySchedule("Twenty","Zero","TwentyTwo","Thirty");
Set-ADReplicationSite "Asia" -ReplicationSchedule $schedule
Description
-----------
Set the daily replication schedule of the site with name 'Asia'.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/p/?linkid=291125
Get-ADReplicationSiteLink
New-ADReplicationSite
Remove-ADReplicationSite
SYNOPSIS
Sets the replication properties for an Active Directory site.
SYNTAX
Set-ADReplicationSite [-Identity] <ADReplicationSite> [-Add <Hashtable>] [-AuthType {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>]
Set-ADReplicationSite [-AuthType {Negotiate | Basic}] [-Credential <PSCredential>] [-PassThru] [-Server <String>]
-Instance <ADReplicationSite> [-Confirm] [-WhatIf] [<CommonParameters>]
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, ...}
For example, if you want to remove the value "555-222-2222" and add the values "555-222-1111" and
"555-222-3333" to Phone-Office-Other attribute (LDAP display name 'otherTelephone'), and add the value
"555-222-9999" to Phone-Mobile-Other (LDAP display name 'otherMobile'), set the Add and Remove parameters as
follows.
-Add @{otherTelephone='555-222-1111', '555-222-3333'; otherMobile='555-222-9999' } -Remove
@{otherTelephone='555-222-2222'}
When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the
following order:
..Remove
..Add
..Replace
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-AuthType <ADAuthType>
Specifies the authentication method to use. Possible values for this parameter include:
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.
The following example shows how to set this parameter to Basic.
-AuthType Basic
Required? false
Position? named
Default value Microsoft.ActiveDirectory.Management.AuthType.Negotiate
Accept pipeline input? false
Accept wildcard characters? false
-AutomaticInterSiteTopologyGenerationEnabled <Boolean>
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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-AutomaticTopologyGenerationEnabled <Boolean>
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.
Required? false
Position? named
Default value
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
For example, if you want to clear the value for the Phone-Office-Other attribute (LDAP display name
'otherTelephone') set the Clear parameter as follows.
-Clear otherTelephone
When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the
following order:
..Remove
..Add
..Replace
..Clear
Required? false
Position? named
Default value
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.
Required? false
Position? named
Default value
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".
Required? false
Position? named
Default value
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.
Distinguished Name
Example: CN=NorthAmerica,CN=Sites,CN=Configuration,DC=corp,DC=contoso,DC=com
GUID (objectGUID)
Example: 599c3d2e-f72d-4d20-8a88-030d99495f20
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.
This example shows how to set this parameter to an ADObject object instance named "ADObjectInstance".
-Identity $ADObjectInstance
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. The following examples show how to use these
two methods to create a new site object.
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.
$objectInstance = Get-ADReplicationSite -Identity NorthAmerica
New-ADReplicationSite -Name "SouthAmerica" -Instance $ObjectInstance
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.
$objectInstance = new-object Microsoft.ActiveDirectory.Management.ADReplicationSite
$objectInstance.Description = North America"
New-ADReplicationSite -Name "NorthAmerica" -Instance $ObjectInstance
Note: Specified attributes are not validated, so attempting to set attributes that do not exist or cannot be
set will raise an error.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-InterSiteTopologyGenerator <ADDirectoryServer>
The server acting as the inter-site topology generator for this site.
Required? false
Position? named
Default value
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. Note:
The identifier in parentheses is the LDAP display name for the property.
Distinguished Name
Example: CN=SaraDavis,OU=Europe,CN=Users,DC=corp,DC=contoso,DC=com
GUID (objectGUID)
Example: 599c3d2e-f72d-4d20-8a88-030d99495f20
Security Identifier (objectSid)
Example: S-1-5-21-3165297888-301567370-576410423-1103
SAM Account Name (sAMAccountName)
Example: saradavis
This parameter sets the Active Directory attribute with an LDAP Display Name of "managedBy".
The following example shows how to specify this parameter.
-ManagedBy ContosoAdmins
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
Returns the new or modified object. By default (i.e. if -PassThru is not specified), this cmdlet does not
generate any output.
Required? false
Position? named
Default value
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. Possible values for this parameter
include:
$false or 0
$true or 1
The following example shows how to set this parameter to true.
-ProtectedFromAccidentalDeletion $true
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-RedundantServerTopologyEnabled <Boolean>
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).
Required? false
Position? named
Default value
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[]}
For example, if you want to add the values blue and green and remove the value pink from a property with a
LDAP display name of FavColors, set the Add and Remove parameters as follows.
-Add @{FavColors=Blue,Green} -Remove {FavColors=Pink}
When you use the Add, Remove, Replace and Clear parameters together, the parameters will be applied in the
following sequence:
..Remove
..Add
..Replace
..Clear
Required? false
Position? named
Default value
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[]}
For example, if you want to replace the value "555-222-2222" with the values "555-222-1111" for
Phone-Office-Other attribute (LDAP display name 'otherTelephone') set the Replace parameter as follows.
-Replace @{otherTelephone='555-222-2222', '555-222-1111'}
When you use the Add, Remove, Replace and Clear parameters together, the operations will be performed in the
following order:
..Remove
..Add
..Replace
..Clear
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ReplicationSchedule <ActiveDirectorySchedule>
Default replication schedule for connections within this site (intra-site replication).
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ScheduleHashingEnabled <Boolean>
Spreads replication start times randomly across the entire schedule interval rather than just the first
quarter of the interval.
Required? false
Position? named
Default value
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.
Domain name values:
Fully qualified domain name
Examples: corp.contoso.com
NetBIOS name
Example: CORP
Directory server values:
Fully qualified directory server name
Example: corp-DC12.corp.contoso.com
NetBIOS name
Example: corp-DC12
Fully qualified directory server name and port
Example: corp-DC12.corp.contoso.com:3268
The default value for the Server parameter is determined by one of the following methods in the order that
they are listed:
-By using Server value from objects passed through the pipeline.
-By using the server information associated with the Active Directory PowerShell provider drive, when running
under that drive.
-By using the domain of the computer running Powershell.
The following example shows how to specify a full qualified domain name as the parameter value.
-Server "corp.contoso.com"
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-TopologyCleanupEnabled <Boolean>
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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-TopologyDetectStaleEnabled <Boolean>
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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-TopologyMinimumHopsEnabled <Boolean>
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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-UniversalGroupCachingEnabled <Boolean>
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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-UniversalGroupCachingRefreshSite <ADReplicationSite>
If universal group caching is enabled, this parameter sets the name of the site from which the cache is pulled.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-WindowsServer2000BridgeheadSelectionMethodEnabled <Boolean>
Implements the Windows2000Server method of selecting a single bridgehead server per directory partition and
transport.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-WindowsServer2000KCCISTGSelectionBehaviorEnabled <Boolean>
When enabled, this parameter implements the Windows2000Server method of Intersite Topology Generator (ISTG)
selection. By default, it is disabled.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-WindowsServer2003KCCBehaviorEnabled <Boolean>
Implements Kerberos consistency checker (KCC) operation that is consistent with WindowsServer2003 forest
functional level. This option can be set if all domain controllers in the site are running WindowsServer2003.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-WindowsServer2003KCCIgnoreScheduleEnabled <Boolean>
When the forest functional level WindowsServer2003 or WindowsServer2003 interim is in effect, provides KCC
control of the ability to ignore schedules (replication occurs at the designated intervals and is always
available).
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-WindowsServer2003KCCSiteLinkBridgingEnabled <Boolean>
When the forest functional level WindowsServer2003 or WindowsServer2003 interim is in effect, provides
Kerberos consistency checker (KCC) control of the ability to enable or disable site link bridging.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value false
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
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, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
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
None or Microsoft.ActiveDirectory.Management.ADReplicationSite
-------------------------- EXAMPLE 1 --------------------------
C:\\PS>Set-ADReplicationSite NorthAmerica -InterSiteTopologyGenerator corp-DC02
-AutomaticInterSiteTopologyGenerationEnabled $false
Description
-----------
Set the properties of the site with name 'NorthAmerica' to prevent its intersite topology generator (ISTG) at
???????corp-DC02???????? from generating connections for intersite replication.
-------------------------- EXAMPLE 2 --------------------------
C:\\PS>Get-ADReplicationSite -Filter * | % {Set-ADReplicationSite $_ -ScheduleHashingEnabled $true}
Description
-----------
Returns all the sites in the directory and sets the ScheduleHashingEnabled propertyto spread replication start
times randomly across the entire schedule interval rather than just the first quarter of the interval..
-------------------------- EXAMPLE 3 --------------------------
C:\\PS>$schedule = New-Object -TypeName System.DirectoryServices.ActiveDirectory.ActiveDirectorySchedule;
$schedule.ResetSchedule();
$schedule.SetDailySchedule("Twenty","Zero","TwentyTwo","Thirty");
Set-ADReplicationSite "Asia" -ReplicationSchedule $schedule
Description
-----------
Set the daily replication schedule of the site with name 'Asia'.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/p/?linkid=291125
Get-ADReplicationSiteLink
New-ADReplicationSite
Remove-ADReplicationSite