< Back
Set-ADReplicationSubnet
Post
NAME Set-ADReplicationSubnet
SYNOPSIS
Sets the properties of an Active Directory replication subnet object.
SYNTAX
Set-ADReplicationSubnet [-Identity] <ADReplicationSubnet> [-Add <Hashtable>] [-AuthType {Negotiate | Basic}]
[-Clear <String[]>] [-Credential <PSCredential>] [-Description <String>] [-Location <String>] [-PassThru] [-Remove
<Hashtable>] [-Replace <Hashtable>] [-Server <String>] [-Site <ADReplicationSite>] [-Confirm] [-WhatIf]
[<CommonParameters>]
Set-ADReplicationSubnet [-AuthType {Negotiate | Basic}] [-Credential <PSCredential>] [-Instance
<ADReplicationSubnet>] [-PassThru] [-Server <String>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Set-ADReplicationSubnet cmdlet sets the properties of an Active Directory replication subnet object. Subnet
objects (class subnet) define network subnets in Active Directory. A network subnet is a segment of a TCP/IP
network to which a set of logical IP addresses is assigned. Subnets group computers in a way that identifies their
physical proximity on the network. Subnet objects in Active Directory are used to map computers to sites.
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
-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 <ADReplicationSubnet>
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=10.0.0.0/25,CN=Subnets,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 <ADReplicationSubnet>
Specifies an instance of a subnet object to use as a template for a new subnet object.
You can use an instance of an existing subnet object as a template or you can construct a new subnet 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 subnet object.
Method 1: Use an existing subnet object as a template for a new object. To retrieve an instance of an existing
subnet object, use a cmdlet such as Get-ADReplicationSubnet. Then provide this object to the Instance
parameter of the New-ADReplicationSubnet cmdlet to create a new subnet object. You can override property
values of the new object by setting the appropriate parameters.
$objectInstance = Get-ADReplicationSubnet -Identity "10.0.0.0/25"
New-ADReplicationSubnet -Name "12.0.0.0/25" -Instance $ObjectInstance
Method 2: Create a new ADReplicationSubnet and set the property values by using the Windows PowerShell command
line interface. Then pass this object to the Instance parameter of the New-ADReplicationSubnet cmdlet to
create the new subnet object.
$objectInstance = new-object Microsoft.ActiveDirectory.Management.ADReplicationSubnet
$objectInstance.Description = Branch office subnet"
New-ADReplicationSubnet -Name "10.0.0.0/25" -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
-Location <String>
Can be used to describe the physical location of this subnet. This value may be displayed or made visible when
the subnet object appears in other Active Directory administrative tools.
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
-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
-Site <ADReplicationSite>
Specifies the site associated with this subnet.
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.ADReplicationSubnet
A subnet object is received by the Identity parameter.
A subnet object that was retrieved by using the Get-ADReplicationSubnet cmdlet and then modified is received
by the Instance parameter.
OUTPUTS
None or Microsoft.ActiveDirectory.Management.ADReplicationSubnet
-------------------------- EXAMPLE 1 --------------------------
C:\\PS>Set-ADReplicationSubnet "10.0.0.12/22" -Site Asia -Location "Tokyo,Japan"
Description
-----------
Set the properties of the subnet named '10.0.0.12/22'.
-------------------------- EXAMPLE 2 --------------------------
C:\\PS>Get-ADReplicationSubnet -Filter {Location -like "*Japan"} -Properties Site | % {Set-ADReplicationSubnet $_
-Site Asia}
Description
-----------
Get all the subnets in the directory that are in Japan, and set 'Asia' as their associated site.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/p/?linkid=291128
Get-ADReplicationSubnet
New-ADReplicationSubnet
Remove-ADReplicationSubnet
SYNOPSIS
Sets the properties of an Active Directory replication subnet object.
SYNTAX
Set-ADReplicationSubnet [-Identity] <ADReplicationSubnet> [-Add <Hashtable>] [-AuthType {Negotiate | Basic}]
[-Clear <String[]>] [-Credential <PSCredential>] [-Description <String>] [-Location <String>] [-PassThru] [-Remove
<Hashtable>] [-Replace <Hashtable>] [-Server <String>] [-Site <ADReplicationSite>] [-Confirm] [-WhatIf]
[<CommonParameters>]
Set-ADReplicationSubnet [-AuthType {Negotiate | Basic}] [-Credential <PSCredential>] [-Instance
<ADReplicationSubnet>] [-PassThru] [-Server <String>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Set-ADReplicationSubnet cmdlet sets the properties of an Active Directory replication subnet object. Subnet
objects (class subnet) define network subnets in Active Directory. A network subnet is a segment of a TCP/IP
network to which a set of logical IP addresses is assigned. Subnets group computers in a way that identifies their
physical proximity on the network. Subnet objects in Active Directory are used to map computers to sites.
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
-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 <ADReplicationSubnet>
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=10.0.0.0/25,CN=Subnets,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 <ADReplicationSubnet>
Specifies an instance of a subnet object to use as a template for a new subnet object.
You can use an instance of an existing subnet object as a template or you can construct a new subnet 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 subnet object.
Method 1: Use an existing subnet object as a template for a new object. To retrieve an instance of an existing
subnet object, use a cmdlet such as Get-ADReplicationSubnet. Then provide this object to the Instance
parameter of the New-ADReplicationSubnet cmdlet to create a new subnet object. You can override property
values of the new object by setting the appropriate parameters.
$objectInstance = Get-ADReplicationSubnet -Identity "10.0.0.0/25"
New-ADReplicationSubnet -Name "12.0.0.0/25" -Instance $ObjectInstance
Method 2: Create a new ADReplicationSubnet and set the property values by using the Windows PowerShell command
line interface. Then pass this object to the Instance parameter of the New-ADReplicationSubnet cmdlet to
create the new subnet object.
$objectInstance = new-object Microsoft.ActiveDirectory.Management.ADReplicationSubnet
$objectInstance.Description = Branch office subnet"
New-ADReplicationSubnet -Name "10.0.0.0/25" -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
-Location <String>
Can be used to describe the physical location of this subnet. This value may be displayed or made visible when
the subnet object appears in other Active Directory administrative tools.
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
-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
-Site <ADReplicationSite>
Specifies the site associated with this subnet.
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.ADReplicationSubnet
A subnet object is received by the Identity parameter.
A subnet object that was retrieved by using the Get-ADReplicationSubnet cmdlet and then modified is received
by the Instance parameter.
OUTPUTS
None or Microsoft.ActiveDirectory.Management.ADReplicationSubnet
-------------------------- EXAMPLE 1 --------------------------
C:\\PS>Set-ADReplicationSubnet "10.0.0.12/22" -Site Asia -Location "Tokyo,Japan"
Description
-----------
Set the properties of the subnet named '10.0.0.12/22'.
-------------------------- EXAMPLE 2 --------------------------
C:\\PS>Get-ADReplicationSubnet -Filter {Location -like "*Japan"} -Properties Site | % {Set-ADReplicationSubnet $_
-Site Asia}
Description
-----------
Get all the subnets in the directory that are in Japan, and set 'Asia' as their associated site.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/p/?linkid=291128
Get-ADReplicationSubnet
New-ADReplicationSubnet
Remove-ADReplicationSubnet