< Back

Get-ADReplicationSiteLink

Tue Jan 29, 2019 9:20 pm

NAME Get-ADReplicationSiteLink



SYNOPSIS

Returns a specific Active Directory site link or a set of site links based on a specified filter.





SYNTAX

Get-ADReplicationSiteLink [-AuthType {Negotiate | Basic}] [-Credential <PSCredential>] [-Properties <String[]>]

[-Server <String>] -Filter <String> [<CommonParameters>]



Get-ADReplicationSiteLink [-Identity] <ADReplicationSiteLink> [-AuthType {Negotiate | Basic}] [-Credential

<PSCredential>] [-Properties <String[]>] [-Server <String>] [<CommonParameters>]





DESCRIPTION

The Get-ADReplicationSiteLink cmdlet can be used to return a specific Active Directory site link or a set of site

links based on a specified filter. 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

-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



-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



-Filter <String>

Specifies a query string that retrieves Active Directory objects. This string uses the PowerShell Expression

Language syntax. The PowerShell Expression Language syntax provides rich type-conversion support for value

types received by the Filter parameter. The syntax uses an in-order representation, which means that the

operator is placed between the operand and the value. For more information about the Filter parameter, see

about_ActiveDirectory_Filter.



Syntax:



The following syntax uses Backus-Naur form to show how to use the PowerShell Expression Language for this

parameter.



<filter> ::= "{" <FilterComponentList> "}"



<FilterComponentList> ::= <FilterComponent> | <FilterComponent> <JoinOperator> <FilterComponent> |

<NotOperator> <FilterComponent>



<FilterComponent> ::= <attr> <FilterOperator> <value> | "(" <FilterComponent> ")"



<FilterOperator> ::= "-eq" | "-le" | "-ge" | "-ne" | "-lt" | "-gt"| "-approx" | "-bor" | "-band" |

"-recursivematch" | "-like" | "-notlike"



<JoinOperator> ::= "-and" | "-or"



<NotOperator> ::= "-not"



<attr> ::= <PropertyName> | <LDAPDisplayName of the attribute>



<value>::= <compare this value with an <attr> by using the specified <FilterOperator>>



For a list of supported types for <value>, see about_ActiveDirectory_ObjectModel.



Note: To query using LDAP query strings, use the LDAPFilter parameter.



Required? true

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



-Properties <String[]>

Specifies the properties of the output object to retrieve from the server. Use this parameter to retrieve

properties that are not included in the default set.



Specify properties for this parameter as a comma-separated list of names. To display all of the attributes

that are set on the object, specify * (asterisk).



To specify an individual extended property, use the name of the property. For properties that are not default

or extended properties, you must specify the LDAP display name of the attribute.



To retrieve properties and display them for an object, you can use the Get-* cmdlet associated with the object

and pass the output to the Get-Member cmdlet. The following examples show how to retrieve properties for a

group where the Administrator's group is used as the sample group object.



Get-ADGroup -Identity Administrators | Get-Member



To retrieve and display the list of all the properties for an ADGroup object, use the following command:



Get-ADGroup -Identity Administrators -Properties *| Get-Member



The following examples show how to use the Properties parameter to retrieve individual properties as well as

the default, extended or complete set of properties.



To retrieve the extended properties "OfficePhone" and "Organization" and the default properties of an ADUser

object named "SaraDavis", use the following command:



GetADUser -Identity SaraDavis -Properties OfficePhone,Organization



To retrieve the properties with LDAP display names of "otherTelephone" and "otherMobile", in addition to the

default properties for the same user, use the following command:



GetADUser -Identity SaraDavis -Properties otherTelephone, otherMobile |Get-Member



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



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





OUTPUTS

Microsoft.ActiveDirectory.Management.ADReplicationSiteLink







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



C:\\PS>Get-ADReplicationSiteLink -Filter *



Description



-----------



Get all the site links.

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



C:\\PS>Get-ADReplicationSiteLink -Filter {SitesIncluded -eq "NorthAmerica"} | FT Name,SitesIncluded -A



Description



-----------



Get all site links that include 'NorthAmerica'.

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



C:\\PS>Get-ADReplicationSiteLink -Filter {Cost -gt 100 -and ReplicationFrequencyInMinutes -lt 15}



Description



-----------



Get all site links that have a cost greater than 100 and a replication frequency less than 15 minutes.

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



C:\\PS>Get-ADReplicationSiteLink "Europe-Asia"



Description



-----------



Get the site link with name 'Europe-Asia'.

-------------------------- EXAMPLE 5 --------------------------



C:\\PS>Get-ADReplicationSiteLink "Europe-Asia" -Properties ReplicationSchedule



Description



-----------



Get the ReplicationSchedule property of the site link with name 'Europe-Asia'.



RELATED LINKS

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

New-ADReplicationSiteLink

Remove-ADReplicationSiteLink

Set-ADReplicationSiteLink