Add-DhcpServerv6Scope
Add-DhcpServerv6Scope
Adds an IPv6 scope to the Dynamic Host Configuration Protocol (DHCP) server service with the specified parameters.
Syntax
Parameter Set: Add0
Add-DhcpServerv6Scope [-Prefix] <IPAddress> [-Name] <String> [-AsJob] [-CimSession <CimSession[]> ] [-ComputerName <String> ] [-Description <String> ] [-PassThru] [-Preference <UInt16> ] [-PreferredLifetime <TimeSpan> ] [-State <String> ] [-T1 <TimeSpan> ] [-T2 <TimeSpan> ] [-ThrottleLimit <Int32> ] [-ValidLifeTime <TimeSpan> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Add-DhcpServerv6Scope cmdlet adds an IPv6 scope to the Dynamic Host Configuration Protocol (DHCP) server service with the specified parameters.
Parameters
-AsJob
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-CimSession<CimSession[]>
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ComputerName<String>
Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Description<String>
Specifies the description associated with the scope.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Name<String>
Specifies the name associated with the scope.
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-PassThru
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Preference<UInt16>
Specifies the value for the preference field to be used by the DHCP server service while responding to clients in this subnet. The acceptable values for this parameter are: 0 through 255.
The default value is 0.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
0 |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-PreferredLifetime<TimeSpan>
Specifies the preferred life time of the IPv6 address leased by the DHCP server service. The default value is 8 days.
This parameter value should be same or less than the ValidLifeTime parameter value.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Prefix<IPAddress>
Specifies the IPv6 prefix of the scope being added.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-State<String>
Specifies the state of the scope. The acceptable values for this parameter are: Enabled or Disabled.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-T1<TimeSpan>
Specifies the lease renewal time. The default value is 4 days. The DHCP client is expected to use a unicast message to renew the lease at the time specified by this parameter value from the same DHCP server service from which DHCP client had initially obtained the lease.
This parameter value should be less than the T2 and PreferredLifetime parameter values.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-T2<TimeSpan>
Specifies the lease rebind time. The default value is 6.4 days. The DHCP client is expected to use a multi-cast message to renew the lease at the time equal to this parameter value from any DHCP server service if the renewal attempt at time specified by the T1 parameter fails.
This parameter value should be greater than the T1 parameter value and less than the PreferredLifetime parameter value.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ThrottleLimit<Int32>
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ValidLifeTime<TimeSpan>
Specifies the valid life time of the IPv6 address leased by the DHCP server service. The default value is 12 days.
This parameter value should be same or greater than the PreferredLifetime parameter value.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
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, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6Scope
The
Microsoft.Management.Infrastructure.CimInstanceobject is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.
Outputs
The output type is the type of the objects that the cmdlet emits.
Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6Scope
The
Microsoft.Management.Infrastructure.CimInstanceobject is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.
Examples
EXAMPLE 1
The above command adds a DHCPv6 scope with subnet prefix 2001:4898:7020:1020:: and specified scope name to the DHCP server running on local computer.
PS C:\> Add-DhcpServerv6Scope -Prefix 2001:4898:7020:1020:: -Name "IPv6 Lab-4 Network"
EXAMPLE 2
This example adds an inactive DHCPv6 scope with the subnet prefix 2001:4898:7020:1020::, specifies the scope name, sets the preferred lifetime to 4 days, and sets the valid lifetime to 6 days to the DHCP server service running on the computer named dhcpserver.contoso.com.
PS C:\> Add-DhcpServerv6Scope -ComputerName dhcpserver.contoso.com -Prefix 2001:4898:7020:1020:: -Name "IPv6 Lab-4 Network" -PreferredLifeTime 4.00:00:00 -ValidLifeTime 6.00:00:00 -State Inactive