< Back
New-ADReplicationSiteLinkBridge
Post
NAME New-ADReplicationSiteLinkBridge
SYNOPSIS
Creates a new site link bridge in Active Directory for replication.
SYNTAX
New-ADReplicationSiteLinkBridge [-Name] <String> [[-SiteLinksIncluded] <ADReplicationSiteLink[]>] [-AuthType
{Negotiate | Basic}] [-Credential <PSCredential>] [-Description <String>] [-Instance
<ADReplicationSiteLinkBridge>] [-InterSiteTransportProtocol {IP | SMTP}] [-OtherAttributes <Hashtable>]
[-PassThru] [-Server <String>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The New-ADReplicationSiteLinkBridge cmdlet creates a new site link bridge in Active Directory for use in
replication. A site link bridge connects two or more site links and enables transitivity between site links. Each
site link in a bridge must have a site in common with another site link in the bridge.
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
-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? True (ByPropertyName)
Accept wildcard characters? false
-Instance <ADReplicationSiteLinkBridge>
Specifies an instance of a site link bridge object to use as a template for a new site link bridge object.
You can use an instance of an existing site link bridge object as a template or you can construct a new site
link bridge 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 bridge object.
Method 1: Use an existing site link bridge object as a template for a new object. To retrieve an instance of
an existing Active Directory object, use the Get-ADReplicationSiteLinkBridge cmdlet. Then provide this object
to the Instance parameter of the New-ADReplicationSiteLinkBridge cmdlet to create a new site link bridge
object. You can override property values of the new object by setting the appropriate parameters.
$objectInstance = Get-ADReplicationSiteLinkBridge -Identity "NorthAmerica-Asia"
New-ADReplicationSiteLinkBridge -Name "SouthAmerica-Asia" -Instance $ObjectInstance
Method 2: Create a new ADReplicationSiteLinkBridge and set the property values by using the Windows PowerShell
command line interface. Then pass this object to the Instance parameter of the New-ADReplicationSiteLinkBridge
cmdlet to create the new site link bridge object.
$objectInstance = new-object Microsoft.ActiveDirectory.Management.ADReplicationSiteLinkBridge
$objectInstance.Description = "Between North America and Asia."
New-ADReplicationSiteLinkBridge -Name "NorthAmerica-Asia" -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
-InterSiteTransportProtocol <ADInterSiteTransportProtocolType>
Specifies the valid InterSite Transport Protocol for use with this site link bridge. Acceptable options for
this parameter include the following:
- IP
- SMTP
Required? false
Position? named
Default value
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Name <String>
Specifies the name of the replication site link bridge object.
Required? true
Position? 1
Default value
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-OtherAttributes <Hashtable>
Specifies object attribute values for attributes that are not represented by cmdlet parameters. You can set
one or more parameters at the same time with this parameter. If an attribute takes more than one value, you
can assign multiple values. To identify an attribute, specify the LDAPDisplayName (ldapDisplayName) defined
for it in the Active Directory schema.
Syntax:
To specify a single value for an attribute:
-OtherAttributes @{'AttributeLDAPDisplayName'=value}
To specify multiple values for an attribute
-OtherAttributes @{'AttributeLDAPDisplayName'=value1,value2,...}
You can specify values for more than one attribute by using semicolons to separate attributes. The following
syntax shows how to set values for multiple attributes:
-OtherAttributes @{'Attribute1LDAPDisplayName'=value; 'Attribute2LDAPDisplayName'=value1,value2;...}
The following examples show how to use this parameter.
To set the value of a custom attribute called favColors that takes a set of Unicode strings, use the following
syntax:
-OtherAttributes @{'favColors'="pink","purple"}
To set values for favColors and dateOfBirth simultaneously, use the following syntax:
-OtherAttributes @{'favColors'="pink","purple"; 'dateOfBirth'=" 01/01/1960"}
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
-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
-SiteLinksIncluded <ADReplicationSiteLink[]>
Contains an array of site links that are included in this site link bridge. Accepted values for this parameter
are the distinguished name (DN), a GUID, or the name of a site link. This parameter must contain two sites
upon creation or else the Instance parameter must be included and used.
Required? false
Position? 2
Default value
Accept pipeline input? True (ByPropertyName)
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.ADReplicationSiteLinkBridge
A site link bridge object that is a template for the new site link bridge object is received by the Instance
parameter.
OUTPUTS
None or Microsoft.ActiveDirectory.Management.ADReplicationSiteLinkBridge
NOTES
By default, all site links are bridged (transitive) and creating a site link design is not required. We
recommend that you keep transitivity enabled by not changing this default. However, you will need to disable
bridging for all site links and complete a site link bridge design if either of the following is true:
- Your IP network is not fully routed.
- You need to control the replication flow of the changes made in Active Directory Domain Services (AD DS).
-------------------------- EXAMPLE 1 --------------------------
C:\\PS>New-ADReplicationSiteLinkBridge "NorthAmerica-Asia" -SiteLinksIncluded "NorthAmerica-Europe","Europe-Asia"
Description
-----------
Create a new site link bridge named 'NorthAmerica-Asia' bridging the two sites links 'NorthAmerica-Europe' and
'Europe-Asia'.
-------------------------- EXAMPLE 2 --------------------------
C:\\PS>New-ADReplicationSiteLinkBridge "NorthAmerica-Asia" -SiteLinksIncluded "NorthAmerica-Europe","Europe-Asia"
-InterSiteTransportProtocol IP
Description
-----------
Create a new site link bridge named 'NorthAmerica-Asia' bridging the two sites links 'NorthAmerica-Europe' and
'Europe-Asia', and set the InterSiteTransportProtocol on the new object.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/p/?linkid=291072
Get-ADReplicationSiteLinkBridge
Remove-ADReplicationSiteLinkBridge
Set-ADReplicationSiteLinkBridge
SYNOPSIS
Creates a new site link bridge in Active Directory for replication.
SYNTAX
New-ADReplicationSiteLinkBridge [-Name] <String> [[-SiteLinksIncluded] <ADReplicationSiteLink[]>] [-AuthType
{Negotiate | Basic}] [-Credential <PSCredential>] [-Description <String>] [-Instance
<ADReplicationSiteLinkBridge>] [-InterSiteTransportProtocol {IP | SMTP}] [-OtherAttributes <Hashtable>]
[-PassThru] [-Server <String>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The New-ADReplicationSiteLinkBridge cmdlet creates a new site link bridge in Active Directory for use in
replication. A site link bridge connects two or more site links and enables transitivity between site links. Each
site link in a bridge must have a site in common with another site link in the bridge.
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
-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? True (ByPropertyName)
Accept wildcard characters? false
-Instance <ADReplicationSiteLinkBridge>
Specifies an instance of a site link bridge object to use as a template for a new site link bridge object.
You can use an instance of an existing site link bridge object as a template or you can construct a new site
link bridge 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 bridge object.
Method 1: Use an existing site link bridge object as a template for a new object. To retrieve an instance of
an existing Active Directory object, use the Get-ADReplicationSiteLinkBridge cmdlet. Then provide this object
to the Instance parameter of the New-ADReplicationSiteLinkBridge cmdlet to create a new site link bridge
object. You can override property values of the new object by setting the appropriate parameters.
$objectInstance = Get-ADReplicationSiteLinkBridge -Identity "NorthAmerica-Asia"
New-ADReplicationSiteLinkBridge -Name "SouthAmerica-Asia" -Instance $ObjectInstance
Method 2: Create a new ADReplicationSiteLinkBridge and set the property values by using the Windows PowerShell
command line interface. Then pass this object to the Instance parameter of the New-ADReplicationSiteLinkBridge
cmdlet to create the new site link bridge object.
$objectInstance = new-object Microsoft.ActiveDirectory.Management.ADReplicationSiteLinkBridge
$objectInstance.Description = "Between North America and Asia."
New-ADReplicationSiteLinkBridge -Name "NorthAmerica-Asia" -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
-InterSiteTransportProtocol <ADInterSiteTransportProtocolType>
Specifies the valid InterSite Transport Protocol for use with this site link bridge. Acceptable options for
this parameter include the following:
- IP
- SMTP
Required? false
Position? named
Default value
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Name <String>
Specifies the name of the replication site link bridge object.
Required? true
Position? 1
Default value
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-OtherAttributes <Hashtable>
Specifies object attribute values for attributes that are not represented by cmdlet parameters. You can set
one or more parameters at the same time with this parameter. If an attribute takes more than one value, you
can assign multiple values. To identify an attribute, specify the LDAPDisplayName (ldapDisplayName) defined
for it in the Active Directory schema.
Syntax:
To specify a single value for an attribute:
-OtherAttributes @{'AttributeLDAPDisplayName'=value}
To specify multiple values for an attribute
-OtherAttributes @{'AttributeLDAPDisplayName'=value1,value2,...}
You can specify values for more than one attribute by using semicolons to separate attributes. The following
syntax shows how to set values for multiple attributes:
-OtherAttributes @{'Attribute1LDAPDisplayName'=value; 'Attribute2LDAPDisplayName'=value1,value2;...}
The following examples show how to use this parameter.
To set the value of a custom attribute called favColors that takes a set of Unicode strings, use the following
syntax:
-OtherAttributes @{'favColors'="pink","purple"}
To set values for favColors and dateOfBirth simultaneously, use the following syntax:
-OtherAttributes @{'favColors'="pink","purple"; 'dateOfBirth'=" 01/01/1960"}
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
-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
-SiteLinksIncluded <ADReplicationSiteLink[]>
Contains an array of site links that are included in this site link bridge. Accepted values for this parameter
are the distinguished name (DN), a GUID, or the name of a site link. This parameter must contain two sites
upon creation or else the Instance parameter must be included and used.
Required? false
Position? 2
Default value
Accept pipeline input? True (ByPropertyName)
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.ADReplicationSiteLinkBridge
A site link bridge object that is a template for the new site link bridge object is received by the Instance
parameter.
OUTPUTS
None or Microsoft.ActiveDirectory.Management.ADReplicationSiteLinkBridge
NOTES
By default, all site links are bridged (transitive) and creating a site link design is not required. We
recommend that you keep transitivity enabled by not changing this default. However, you will need to disable
bridging for all site links and complete a site link bridge design if either of the following is true:
- Your IP network is not fully routed.
- You need to control the replication flow of the changes made in Active Directory Domain Services (AD DS).
-------------------------- EXAMPLE 1 --------------------------
C:\\PS>New-ADReplicationSiteLinkBridge "NorthAmerica-Asia" -SiteLinksIncluded "NorthAmerica-Europe","Europe-Asia"
Description
-----------
Create a new site link bridge named 'NorthAmerica-Asia' bridging the two sites links 'NorthAmerica-Europe' and
'Europe-Asia'.
-------------------------- EXAMPLE 2 --------------------------
C:\\PS>New-ADReplicationSiteLinkBridge "NorthAmerica-Asia" -SiteLinksIncluded "NorthAmerica-Europe","Europe-Asia"
-InterSiteTransportProtocol IP
Description
-----------
Create a new site link bridge named 'NorthAmerica-Asia' bridging the two sites links 'NorthAmerica-Europe' and
'Europe-Asia', and set the InterSiteTransportProtocol on the new object.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/p/?linkid=291072
Get-ADReplicationSiteLinkBridge
Remove-ADReplicationSiteLinkBridge
Set-ADReplicationSiteLinkBridge