Edit

Get-DhcpServerv6FreeIPAddress

  • Reference
Module:
DhcpServer

Gets one or more free, or unassigned, IPv6 addresses from the specified scope.

Syntax

Get-DhcpServerv6FreeIPAddress
   [-Prefix] <IPAddress>
   [[-NumAddress] <UInt32>]
   [-AsJob]
   [-CimSession <CimSession[]>]
   [-ComputerName <String>]
   [-EndAddress <IPAddress>]
   [-StartAddress <IPAddress>]
   [-ThrottleLimit <Int32>]

Description

The Get-DhcpServerv6FreeIPAddress cmdlet gets one or more free IPv6 addresses from the specified scope.

If the NumAddress parameter is specified, then the requested number of free IPv6 addresses is returned. If the NumAddress parameter is not specified, then a single free IPv6 address will be returned. The maximum number of free IPv6 addresses returned is capped at 1024.

If the StartAddress parameter is specified and the EndAddress parameter is not specified, then the free IPv6 addresses starting from the specified StartAddress parameter value through the ending of the IPv6 address range of the scope are returned.

If the EndAddress parameter is specified and the StartAddress parameter is not specified, then the free IPv6 addresses starting from the beginning of the IPv6 address range of the scope through the specified EndAddress parameter value are returned.

If both of the StartAddress and EndAddress parameters are specified, then the free IPv6 addresses between the specified StartAddress and EndAddress parameter values are returned.

The exclusion address ranges, reservations, active, offered and bad, or declined, leases are excluded while returning free IPv6 addresses.

The IPv6 address ranges associated with a policy will be included while returning free IPv6 addresses.

The IPv6 addresses which are in expired, or doomed, state will be included while returning free IPv6 addresses.

If the requested number of free IPv6 addresses could not be found, then a warning is displayed.

Examples

Example 1: Get a free address

PS C:\>Get-DhcpServerv6FreeIPAddress -ComputerName dhcpserver.contoso.com -Prefix 2001:4898:7020:1020::

This example gets a free IPv6 address from the specified scope.

Example 2: Get ten free addresses

PS C:\>Get-DhcpServerv6FreeIPAddress -ComputerName dhcpserver.contoso.com -Prefix 2001:4898:7020:1020:: -NumAddress 10

This example gets a list of 10 free IPv6 addresses from the specified scope.

Example 3: Get a free address from a range

PS C:\>Get-DhcpServerv6FreeIPAddress -ComputerName dhcpserver.contoso.com -Prefix 2001:4898:7020:1020:: -StartAddress 2001:4898:7020:1020::10 -EndAddress 2001:4898:7020:1020::50

This example gets a free IPv6 address from the specified scope within the IP address range from 2001:4898:7020:1020::10 through 2001:4898:7020:1020::50.

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.

Type:CimSession[]
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 running the Dynamic Host Configuration Protocol (DHCP) server service.

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

-EndAddress

Specifies the ending IPv6 address of the range from which the free IPv6 addresses are to be returned.

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

-NumAddress

Specifies the number of free IPv6 addresses requested.

Type:UInt32
Position:2
Default value:1
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Prefix

Specifies the IPv6 subnet prefix of the scope from which one or more free IPv6 addresses are requested.

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

-StartAddress

Specifies the starting IPv6 address of the range from which the free IPv6 addresses are to be returned.

Type:IPAddress
Position:Named
Default value:None
Required:False
Accept pipeline input:False
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

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

String[]