< Back
New-ADReplicationSubnet
Post
NAME New-ADReplicationSubnet
SYNOPSIS
Creates a new Active Directory replication subnet object.
SYNTAX
New-ADReplicationSubnet [-Name] <String> [[-Site] <ADReplicationSite>] [-AuthType {Negotiate | Basic}]
[-Credential <PSCredential>] [-Description <String>] [-Instance <ADReplicationSubnet>] [-Location <String>]
[-OtherAttributes <Hashtable>] [-PassThru] [-Server <String>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The New-ADReplicationSubnet cmdlet creates a new Active Directory 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
-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 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? True (ByPropertyName)
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 subnet object. To retrieve an instance of an
existing subnet object, use the Get-ADReplicationSubnet cmdlet. 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>
A description of the physical location of this subnet.
Required? false
Position? named
Default value
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Name <String>
Specifies the name of the subnet. This parameter sets the Name property of the Active Directory object. The
LDAP Display Name (ldapDisplayName) of this property is "name".
Subnet names in Active Directory take the form "network/bits masked" (for example, the subnet object
172.16.72.0/22 has a subnet of 172.16.72.0 and a 22-bit subnet mask).
The following example shows how to set this parameter to a name string.
-Name "172.16.72.0/22"
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
-Site <ADReplicationSite>
The site associated with this subnet.
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.ADReplicationSubnet
A subnet object that is a template for the new subnet object is received by the Instance parameter.
OUTPUTS
None or Microsoft.ActiveDirectory.Management.ADReplicationSubnet
-------------------------- EXAMPLE 1 --------------------------
C:\\PS>New-ADReplicationSubnet -Name "10.0.0.0/25"
Description
-----------
Create a new subnet named '10.0.0.0/25'.
-------------------------- EXAMPLE 2 --------------------------
C:\\PS>New-ADReplicationSubnet -Name "10.10.0.0/22" -Site Asia -Location "Tokyo,Japan"
Description
-----------
Create a new subnet named '10.10.0.0/22' with 'Asia' as its associated site, and set the Location property to
"Tokyo,Japan".
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/p/?linkid=291073
Get-ADReplicationSubnet
Remove-ADReplicationSubnet
Set-ADReplicationSubnet
SYNOPSIS
Creates a new Active Directory replication subnet object.
SYNTAX
New-ADReplicationSubnet [-Name] <String> [[-Site] <ADReplicationSite>] [-AuthType {Negotiate | Basic}]
[-Credential <PSCredential>] [-Description <String>] [-Instance <ADReplicationSubnet>] [-Location <String>]
[-OtherAttributes <Hashtable>] [-PassThru] [-Server <String>] [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The New-ADReplicationSubnet cmdlet creates a new Active Directory 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
-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 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? True (ByPropertyName)
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 subnet object. To retrieve an instance of an
existing subnet object, use the Get-ADReplicationSubnet cmdlet. 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>
A description of the physical location of this subnet.
Required? false
Position? named
Default value
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Name <String>
Specifies the name of the subnet. This parameter sets the Name property of the Active Directory object. The
LDAP Display Name (ldapDisplayName) of this property is "name".
Subnet names in Active Directory take the form "network/bits masked" (for example, the subnet object
172.16.72.0/22 has a subnet of 172.16.72.0 and a 22-bit subnet mask).
The following example shows how to set this parameter to a name string.
-Name "172.16.72.0/22"
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
-Site <ADReplicationSite>
The site associated with this subnet.
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.ADReplicationSubnet
A subnet object that is a template for the new subnet object is received by the Instance parameter.
OUTPUTS
None or Microsoft.ActiveDirectory.Management.ADReplicationSubnet
-------------------------- EXAMPLE 1 --------------------------
C:\\PS>New-ADReplicationSubnet -Name "10.0.0.0/25"
Description
-----------
Create a new subnet named '10.0.0.0/25'.
-------------------------- EXAMPLE 2 --------------------------
C:\\PS>New-ADReplicationSubnet -Name "10.10.0.0/22" -Site Asia -Location "Tokyo,Japan"
Description
-----------
Create a new subnet named '10.10.0.0/22' with 'Asia' as its associated site, and set the Location property to
"Tokyo,Japan".
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/p/?linkid=291073
Get-ADReplicationSubnet
Remove-ADReplicationSubnet
Set-ADReplicationSubnet