Export (0) Print
Expand All
Expand Minimize

Get-DhcpServerv4Lease

Updated: January 9, 2013

Applies To: Windows Server 2012

Get-DhcpServerv4Lease

Gets one or more lease records from the Dynamic Host Configuration Protocol (DHCP) server service.

Syntax

Parameter Set: ScopeId
Get-DhcpServerv4Lease [-ScopeId] <IPAddress> [-AllLeases] [-AsJob] [-CimSession <CimSession[]> ] [-ComputerName <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: BadLeases
Get-DhcpServerv4Lease [[-ScopeId] <IPAddress> ] -BadLeases [-AsJob] [-CimSession <CimSession[]> ] [-ComputerName <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: ClientId
Get-DhcpServerv4Lease [-ScopeId] <IPAddress> [-ClientId] <String[]> [-AsJob] [-CimSession <CimSession[]> ] [-ComputerName <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: IPAddress
Get-DhcpServerv4Lease -IPAddress <IPAddress[]> [-AsJob] [-CimSession <CimSession[]> ] [-ComputerName <String> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]




Detailed Description

The Get-DhcpServerv4Lease cmdlet gets one or more lease records from the Dynamic Host Configuration Protocol (DHCP) server service.

If the ScopeId parameter is specified, then the active leases from the specified scope are returned. To get all types of leases including Active, Offered, Declined, and Expired, then the AllLeases parameter must be specified.

If the IPAddress parameter is specified, then the lease records for the specified IP address are returned.

If the ClientId and ScopeId parameters are specified, then the leases for the specified ClientId parameter values in the specified scope are returned.

If the BadLeases and ScopeId parameters are specified, then all of the bad lease records for the specified scope are returned.

If the BadLeases parameter is specified without the ScopeId parameter, then all of the bad lease records from the DHCP server service are returned.

Parameters

-AllLeases

Specifies that all of the IPv4 address leases regardless of address state are returned.
If not specified, then only active leases are returned.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-BadLeases

Specifies that only bad leases are returned. If an IP address lease is declined by the client because of a conflict with another client, then the lease record is marked as bad, or declined, by the DHCP server service.
An IP address lease in this state is not offered to any client until expiry of a timer, which is 10 minutes.


Aliases

none

Required?

true

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

-ClientId<String[]>

Specifies the client identifier (ID) for which the IP address lease record is to be retrieved.


Aliases

none

Required?

true

Position?

2

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

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

-IPAddress<IPAddress[]>

Specifies the IP address for which the lease record is to be retrieved.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-ScopeId<IPAddress>

Specifies the scope ID, in IPv4 address format from which the IPv4 address leases are being retrieved.


Aliases

none

Required?

true

Position?

1

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

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters.

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.

  • Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Lease[]

    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.


Examples

EXAMPLE 1

This example gets all the active IPv4 address leases from the DHCPv4 scopes 10.10.10.0.


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

EXAMPLE 2

This example gets the IP address lease information for the IPv4 addresses 10.10.10.10 and 20.20.20.20.


PS C:\> Get-DhcpServerv4Lease -ComputerName dhcpserver.contoso.com -IPAddress 10.10.10.10,20.20.20.20

EXAMPLE 3

This example gets all the bad, or declined, IPv4 address leases from the DHCPv4 scope 10.10.10.0.


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

EXAMPLE 4

This example gets the IPv4 address leases from the DHCPv4 scope 10.10.10.0 for the clients identified by the client IDs F0-DE-F1-7A-00-5E and 00-24-D7-C5-25-B0.


PS C:\> Get-DhcpServerv4Lease -ComputerName dhcpserver.contoso.com -ScopeId 10.10.10.0 -CliendId F0-DE-F1-7A-00-5E, 00-24-D7-C5-25-B0

EXAMPLE 5

This example gets all of the types of IPv4 address leases including Active, Declined, and Expired from the DHCPv4 scope 10.10.10.0.


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

EXAMPLE 6

This example gets all of the active IP address leases from all of the scopes on the DHCP server service running on the computer named dhcpserver.contoso.com. The Get-DhcpServerv4Scope cmdlet returns the scope objects and pipes the objects into this cmdlet which returns the active address lease objects from all the scopes.


PS C:\> Get-DhcpServerv4Scope -ComputerName dhcpserver.contoso.com | Get-DhcpServerv4Lease -ComputerName dhcpserver.contoso.com

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft