Get-DhcpServerv4Lease
Gets one or more lease records from the DHCP server service.
Syntax
Get-DhcpServerv4Lease
[-ComputerName <String>]
[-ScopeId] <IPAddress>
[-AllLeases]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>] Get-DhcpServerv4Lease
[-ComputerName <String>]
-IPAddress <IPAddress[]>
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>] Get-DhcpServerv4Lease
[-ComputerName <String>]
[-ScopeId] <IPAddress>
[-ClientId] <String[]>
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>] Get-DhcpServerv4Lease
[-ComputerName <String>]
[-BadLeases]
[[-ScopeId] <IPAddress>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>] Description
The Get-DhcpServerv4Lease cmdlet gets one or more lease records from the Dynamic Host Configuration Protocol (DHCP) server service.
If you specify the ScopeId parameter, the active leases from the specified scope are returned. To get all kinds of leases including Active, Offered, Declined, and Expired, the AllLeases parameter must be specified.
If you specify the IPAddress parameter, the lease records for the specified IP address are returned.
If you specify the ClientId and ScopeId parameters, the leases for the specified ClientId parameter values in the specified scope are returned.
If you specify the BadLeases and ScopeId parameters, all of the bad lease records for the specified scope are returned.
If you specify the BadLeases parameter without the ScopeId parameter, all of the bad lease records from the DHCP server service are returned.
Examples
Example 1: Get all active leases in a scope
PS C:\> Get-DhcpServerv4Lease -ComputerName "dhcpserver.contoso.com" -ScopeId 10.10.10.0This example gets all the active IPv4 address leases from the DHCPv4 scope 10.10.10.0.
Example 2: Get leases for specified addresses
PS C:\> Get-DhcpServerv4Lease -ComputerName "dhcpserver.contoso.com" -IPAddress 10.10.10.10,10.20.20.20This example gets the IP address lease information for the IPv4 addresses 10.10.10.10 and 10.20.20.20.
Example 3: Get declined leases
PS C:\> Get-DhcpServerv4Lease -ComputerName "dhcpserver.contoso.com" -ScopeId 10.10.10.0 -BadLeasesThis example gets all the bad, or declined, IPv4 address leases from the DHCPv4 scope 10.10.10.0.
Example 4: Get leases for specified clients
PS C:\> Get-DhcpServerv4Lease -ComputerName "dhcpserver.contoso.com" -ScopeId 10.10.10.0 -ClientId "F0-DE-F1-7A-00-5E", "00-24-D7-C5-25-B0"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.
Example 5: Get all leases in a scope
PS C:\> Get-DhcpServerv4Lease -ComputerName "dhcpserver.contoso.com" -ScopeId 10.10.10.0 -AllLeasesThis example gets all of the types of IPv4 address leases including Active, Declined, and Expired from the DHCPv4 scope 10.10.10.0.
Example 6: Get active leases from all scopes on a computer
PS C:\> Get-DhcpServerv4Scope -ComputerName "dhcpserver.contoso.com" | Get-DhcpServerv4Lease -ComputerName "dhcpserver.contoso.com"This example gets all of the active IP address leases from all of the scopes on the DHCP server service that runs 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.
Parameters
-AllLeases
Indicates that this cmdlet returns all of the IPv4 address leases regardless of address state. By default, this cmdlet returns only active leases.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-BadLeases
Indicates that this cmdlet returns only bad leases. If an IP address lease is declined by the client because of a conflict with another client, 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.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | True |
| 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 |
-ClientId
Specifies the client identifier (ID) for which the IP address lease record is to be retrieved.
| Type: | String[] |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| 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 |
-IPAddress
Specifies the IP address for which the lease record is retrieved.
| Type: | IPAddress[] |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ScopeId
Specifies the scope ID, in IPv4 address format from which the IPv4 address leases are retrieved.
| Type: | IPAddress |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| 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 |
Inputs
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 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.