Add-DhcpServerv6Scope

  • Reference
Module:
DhcpServer

Adds an IPv6 scope to the DHCP server service with the specified parameters.

Syntax

Add-DhcpServerv6Scope
   [-ValidLifeTime <TimeSpan>]
   [-ComputerName <String>]
   [-Prefix] <IPAddress>
   [-Name] <String>
   [-Description <String>]
   [-State <String>]
   [-Preference <UInt16>]
   [-PreferredLifetime <TimeSpan>]
   [-T1 <TimeSpan>]
   [-T2 <TimeSpan>]
   [-PassThru]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Add-DhcpServerv6Scope cmdlet adds an IPv6 scope to the Dynamic Host Configuration Protocol (DHCP) server service by using the specified parameters.

Examples

Example 1: Add a server scope on the local computer

PS C:\> Add-DhcpServerv6Scope -Prefix 2001:4898:7020:1020:: -Name "IPv6 Lab-4 Network"

The above command adds a DHCPv6 scope with subnet prefix 2001:4898:7020:1020:: and specified scope name to the DHCP server that runs on the local computer.

Example 2: Add a server scope

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"

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 that runs on the computer named dhcpserver.contoso.com.

Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

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

Type:CimSession[]
Aliases:Session
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ComputerName

Specifies the DNS name, or IPv4 or IPv6 address, of the target computer that runs the DHCP server service.

Type:String
Aliases:Cn
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Description

Specifies the description associated with the scope.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Name

Specifies the name associated with the scope.

Type:String
Position:2
Default value:None
Required:True
Accept pipeline input:True
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.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Preference

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.

Type:UInt16
Position:Named
Default value:0
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-PreferredLifetime

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.

Type:TimeSpan
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Prefix

Specifies the IPv6 prefix of the scope that is added.

Type:IPAddress
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-State

Specifies the state of the scope. The acceptable values for this parameter are: Enabled and Disabled.

Type:String
Accepted values:Active, Inactive
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-T1

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 at first obtained the lease.

This parameter value should be less than the T2 and PreferredLifetime parameter values.

Type:TimeSpan
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-T2

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 larger than the T1 parameter value and less than the PreferredLifetime parameter value.

Type:TimeSpan
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ThrottleLimit

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.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ValidLifeTime

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 larger than the PreferredLifetime parameter value.

Type:TimeSpan
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

CimInstance

The Microsoft.Management.Infrastructure.CimInstance object 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

CimInstance

The Microsoft.Management.Infrastructure.CimInstance object 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.