Site icon TOSS

Set-ADReplicationSite

Karthik S
powershell

Set-ADReplicationSite is accessible with the help of addsadministration module. To install addsadministration on your system please refer to this link.

Synopsis

Sets the replication properties for an Active Directory site.

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 
         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

    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:

    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

    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.

    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.

    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.

    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.

    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:

    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

    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

    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.

    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 Windows&nbsp;2000&nbsp;Server 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 Windows&nbsp;2000&nbsp;Server 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 Windows&nbsp;Server&nbsp;2003 forest functional level. This option can be set if all domain controllers in the site are running Windows&nbsp;Server&nbsp;2003.

    Required?                    false
    Position?                    named
    Default value                
    Accept pipeline input?       false
    Accept wildcard characters?  false

-WindowsServer2003KCCIgnoreScheduleEnabled <Boolean>
    When the forest functional level Windows&nbsp;Server&nbsp;2003 or Windows&nbsp;Server&nbsp;2003 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 Windows&nbsp;Server&nbsp;2003 or Windows&nbsp;Server&nbsp;2003 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

Syntax

Set-ADReplicationSite [-WhatIf] [-Confirm] [-Add <Hashtable>] [-AuthType <ADAuthType>] [-AutomaticInterSiteTopologyGenerationEnabled <Boolean>] [-AutomaticTopologyGenerationEnabled <Boolean>] [-Clear <String[]>] [-Credential <PSCredential>] [-Description <String>] [-Identity] <ADReplicationSite> [-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>] [<CommonParameters>]

Set-ADReplicationSite [-WhatIf] [-Confirm] [-AuthType <ADAuthType>] [-Credential <PSCredential>] -Instance <ADReplicationSite> [-PassThru] [-Server <String>] [<CommonParameters>]

————————– EXAMPLE 1 ————————–
C:\PS>Set-ADReplicationSite NA -InterSiteTopologyGenerator Delhi-DC02 -AutomaticInterSiteTopologyGenerationEnabled $false
Set the properties of the site with name ‘NA’ to prevent its intersite topology generator (ISTG) at ‘Delhi-DC02’ from generating connections for intersite replication.

————————– EXAMPLE 2 ————————–
C:\PS>Get-ADReplicationSite -Filter * | % {Set-ADReplicationSite $_ -ScheduleHashingEnabled $true}
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
Set the daily replication schedule of the site with name ‘Asia’.

You can check the Version, CommandType and Source of this cmdlet by giving below command.

Get-Command Set-ADReplicationSite

You can also read about
. Get-ADReplicationSite
. New-ADReplicationSite
. Remove-ADReplicationSite

To know more PowerShell cmdlets(Commands) on addsadministration (Active Directory) click here

Click on this Link for an Single place where you get all the PowerShell cmdlet sorted based on the modules.

You can also refer other blogs on PowerShell at link

You can also refer other blogs on Microsoft at link

And also if you required any technology you want to learn, let us know below we will publish them in our site http://tossolution.com/

Like our page in Facebook and follow us for New technical information.

References are taken from Microsoft

Exit mobile version