Get-DhcpServerv4FreeIPAddress

Get-DhcpServerv4FreeIPAddress

Gets one or more free, or unassigned, IPv4 Addresses from the specified scope.

Syntax

Parameter Set: Get0
Get-DhcpServerv4FreeIPAddress [-ScopeId] <IPAddress> [[-NumAddress] <UInt32> ] [-AsJob] [-CimSession <CimSession[]> ] [-ComputerName <String> ] [-EndAddress <IPAddress> ] [-StartAddress <IPAddress> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Detailed Description

This Get-DhcpServerv4FreeIPAddress cmdlet gets one or more free IP Addresses from the specified scope.

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

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

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

If both the StartAddress and EndAddress parameters are specified, then the free IP 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 the free IP addresses.

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

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

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

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 Dynamic Host Configuration Protocol (DHCP) server service.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-EndAddress<IPAddress>

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

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-NumAddress<UInt32>

Specifies the number of free IP addresses requested.

Aliases	none
Required?	false
Position?	2
Default Value	1
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-ScopeId<IPAddress>

Specifies the scope identifier (ID), in IPv4 address format, from which one or more free IP addresses are requested.

Aliases	none
Required?	true
Position?	1
Default Value	none
Accept Pipeline Input?	true (ByPropertyName)
Accept Wildcard Characters?	false

-StartAddress<IPAddress>

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

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
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

<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/DhcpServerv4Scope

  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

The output type is the type of the objects that the cmdlet emits.

• System.String[]

Examples

EXAMPLE 1

This example gets a free IPv4 addresses from the specified scope.

PS C:\> Get-DhcpServerv4FreeIPAddress -ComputerName dhcpserver.contoso.com -ScopeId 10.10.10.0

EXAMPLE 2

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

PS C:\> Get-DhcpServerv4FreeIPAddress -ComputerName dhcpserver.contoso.com -ScopeId 10.10.10.0 -NumAddress 10

EXAMPLE 3

This example gets a free IPv4 address from the specified scope within the IP address range from 10.10.10.10 through 10.10.10.50.

PS C:\> Get-DhcpServerv4FreeIPAddress -ComputerName dhcpserver.contoso.com -ScopeId 10.10.10.0 -StartAddress 10.10.10.10 -EndAddress 10.10.10.50

Related topics

Get-DhcpServerv6FreeIPAddress{{Provide related cmdlet topic}}