Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Add-DhcpServerv6Scope

Add-DhcpServerv6Scope

ps_dhcpserverv6scope_v1.0.0.cdxml

Synopsis

Adds an IPv6 scope to the Dynamic Host Configuration Protocol (DHCP) server service with the specified parameters.

Syntax

Add-DhcpServerv6Scope [-Prefix] [-Name] [-AsJob] [-CimSession] [-ComputerName] [-Description] [-PassThru] [-Preference] [-PreferredLifetime] [-State] [-T1] [-T2] [-ThrottleLimit] [-ValidLifeTime] [-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 <SwitchParameter>

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.

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

Session

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

Cn

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

3

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-PassThru <SwitchParameter>

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

2

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

Prompts you for confirmation before running the cmdlet.

Aliases

None

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.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6Scope

Return Type

Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6Scope

Notes

None

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

Online Version
Get-DhcpServerv6Scope
Get-DhcpServerv6ScopeStatistics
Remove-DhcpServerv6Scope
Set-DhcpServerv6Scope