< Back

Set-ADReplicationSiteLink

Tue Jan 29, 2019 9:23 pm

NAME Set-ADReplicationSiteLink



SYNOPSIS

Sets the properties for an Active Directory site link.





SYNTAX

Set-ADReplicationSiteLink [-Identity] <ADReplicationSiteLink> [-Add <Hashtable>] [-AuthType {Negotiate | Basic}]

[-Clear <String[]>] [-Cost <Int32>] [-Credential <PSCredential>] [-Description <String>] [-PassThru] [-Remove

<Hashtable>] [-Replace <Hashtable>] [-ReplicationFrequencyInMinutes <Int32>] [-ReplicationSchedule

<ActiveDirectorySchedule>] [-Server <String>] [-SitesIncluded <Hashtable>] [-Confirm] [-WhatIf]

[<CommonParameters>]



Set-ADReplicationSiteLink [-AuthType {Negotiate | Basic}] [-Credential <PSCredential>] [-Instance

<ADReplicationSiteLink>] [-PassThru] [-Server <String>] [-Confirm] [-WhatIf] [<CommonParameters>]





DESCRIPTION

The Set-ADReplicationSiteLink cmdlet can be used to set properties on an Active Directory site link. A site link

connects two or more sites. Site links reflect the administrative policy for how sites are to be interconnected

and the methods used to transfer replication traffic. You must connect sites with site links so that domain

controllers at each site can replicate Active Directory changes.





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



-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



-Cost <Int32>

Specifies the cost to be placed on the site link. For more information on determining the cost, see the

following topic called "Determining the Cost" in the TechNet Library:

http://go.microsoft.com/fwlink/?LinkId=221871



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Credential <PSCredential>

Specifies the user account credentials to use to perform this task. The default credentials are the

credentials of the currently logged on user unless the cmdlet is run from an Active Directory PowerShell

provider drive. If the cmdlet is run from such a provider drive, the account associated with the drive is the

default.



To specify this parameter, you can type a user name, such as "User1" or "Domain01\\User01" or you can specify a

PSCredential object. If you specify a user name for this parameter, the cmdlet prompts for a password.



You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. You can

then set the Credential parameter to the PSCredential object The following example shows how to create

credentials.



$AdminCredentials = Get-Credential "Domain01\\User01"



The following shows how to set the Credential parameter to these credentials.



-Credential $AdminCredentials



If the acting credentials do not have directory-level permission to perform the task, Active Directory

PowerShell returns a terminating error.



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

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-SouthAmerica,CN=IP,CN=Inter-Site

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

Accept pipeline input? True (ByValue)

Accept wildcard characters? false



-Instance <ADReplicationSiteLink>

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



You can use an instance of an existing site link object as a template or you can construct a new site link

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 link object.



Method 1: Use an existing site link object as a template for a new object. To retrieve an instance of an

existing site link object, use a cmdlet such as Get-ADReplicationSiteLink. Then provide this object to the

Instance parameter of the New-ADReplicationSiteLink cmdlet to create a new site link object. You can override

property values of the new object by setting the appropriate parameters.



$objectInstance = Get-ADReplicationSiteLink -Identity "NorthAmerica-SouthAmerica"



New-ADReplicationSiteLink -Name "Europe-Asia" -Instance $ObjectInstance



Method 2: Create a new ADReplicationSiteLink and set the property values by using the Windows PowerShell

command line interface. Then pass this object to the Instance parameter of the New-ADReplicationSiteLink

cmdlet to create the new Active Directory object.



$objectInstance = new-object Microsoft.ActiveDirectory.Management.ADReplicationSiteLink



$objectInstance.Description = "Between North America and South America."



New-ADReplicationSiteLink -Name "NorthAmerica-SouthAmerica"-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? 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



-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



-ReplicationFrequencyInMinutes <Int32>

Species the frequency (in minutes) for which replication will occur where this site link is in use between

sites. Active Directory preserves bandwidth between sites by minimizing the frequency of replication and by

allowing you to schedule the availability of site links for replication. By default, intersite replication

across each site link occurs every 180 minutes (3 hours). You can adjust this frequency to match your specific

needs. Be aware that increasing this frequency increases the amount of bandwidth used by replication.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ReplicationSchedule <ActiveDirectorySchedule>

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

This allows you to schedule the availability of site links for use by replication. By default, a site link is

available to carry replication traffic 24 hours a day, 7 days a week. You can limit this schedule to specific

days of the week and times of day. You can, for example, schedule intersite replication so that it only occurs

after normal business hours.



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



-SitesIncluded <Hashtable>

Specifies the list of sites included in the site link. For Set-ADReplicationSiteLink operations, you can add

or include new sites within an existing site link by specifying them using this parameter. You do not have to

specify all previously listed sites already within this link.



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



A site link object is received by the Identity parameter.



A site link object that was retrieved by using the Get-ADReplicationSitLink cmdlet and then modified is

received by the Instance parameter.





OUTPUTS

None or Microsoft.ActiveDirectory.Management.ADReplicationSiteLink







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



C:\\PS>Set-ADReplicationSiteLink "Europe-Asia" -SitesIncluded @{Add="Asia2";Remove="Asia"}



Description



-----------



Add site 'Asia2' to the site link 'Europe-Asia', and remove site 'Asia'.

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



C:\\PS>Get-ADReplicationSiteLink -Filter {ReplicationFrequencyInMinutes -ge 60} -Properties Cost | %

{Set-ADReplicationSiteLink $_ -Cost 200}



Description



-----------



Get all the site links in the directory with replication frequency greater than or equal to 60 minutes. Set the

Cost property on these site link objects to 200.

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



C:\\PS>$schedule = New-Object -TypeName System.DirectoryServices.ActiveDirectory.ActiveDirectorySchedule;

$schedule.ResetSchedule();

$schedule.SetDailySchedule("Twenty","Zero","TwentyTwo","Thirty");

Set-ADReplicationSiteLink "NorthAmerica-SouthAmerica" -ReplicationSchedule $schedule



Description



-----------



Set the daily replication schedule of the site link with name 'NorthAmerica-SouthAmerica'.

-------------------------- EXAMPLE 4 --------------------------



C:\\PS>Set-ADReplicationSiteLink "Europe-Asia" -Replace @{'options'=1}



Description



-----------



Enable change notification on the site link with name 'Europe-Asia'.



RELATED LINKS

Online Version: http://go.microsoft.com/fwlink/p/?linkid=291126

Get-ADReplicationSiteLink

New-ADReplicationSiteLink

Remove-ADReplicationSiteLink