Get-DhcpServerv4Lease
Get-DhcpServerv4Lease is accessible with the help of DHCPServer module. To configure DHCPServer, go through this link.
Synopsis
Gets one or more lease records from the Dynamic Host Configuration Protocol (DHCP) server service.
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
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 |
| 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 |
| 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 |
| 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 |
| 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 |
| Accept pipeline input: | True (ByPropertyName) |
| 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 |
| 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 |
| Accept pipeline input: | True (ByPropertyName) |
| 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 |
| Accept pipeline input: | True (ByPropertyName) |
| 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 |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
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>]
—————EXAMPLE 1—————
PS C:> Get-DhcpServerv4Lease -ComputerName dhcpsrv.TOSSolution.com -ScopeId 192.168.1.0
This example gets all the active IPv4 address leases from the DHCPv4 scopes 192.168.1.0.
—————EXAMPLE 2—————
PS C:> Get-DhcpServerv4Lease -ComputerName dhcpsrv.TOSSolution.com -IPAddress 192.168.1.10,192.168.1.20
This example gets the IP address lease information for the IPv4 addresses 192.168.1.10 and 192.168.1.20.
—————EXAMPLE 3—————
PS C:> Get-DhcpServerv4Lease -ComputerName dhcpsrv.TOSSolution.com -ScopeId 192.168.1.0 -BadLeases
This example gets all the bad, or declined, IPv4 address leases from the DHCPv4 scope 192.168.1.0.
—————EXAMPLE 4—————
PS C:> Get-DhcpServerv4Lease -ComputerName dhcpsrv.TOSSolution.com -ScopeId 192.168.1.0 -CliendId 00-0C-29-00-E0-6B, 00-0C-29-00-E0-6C
This example gets the IPv4 address leases from the DHCPv4 scope 10.10.10.0 for the clients identified by the client IDs 00-0C-29-00-E0-6B and 00-0C-29-00-E0-6C.
—————EXAMPLE 5—————
PS C:> Get-DhcpServerv4Lease -ComputerName dhcpsrv.TOSSolution.com -ScopeId 192.168.1.0 -AllLeases
This example gets all of the types of IPv4 address leases including Active, Declined, and Expired from the DHCPv4 scope 192.168.1.0.
—————EXAMPLE 5—————
PS C:>Get-DhcpServerv4Scope -ComputerName dhcpsrv.TOSSolution.com | Get-DhcpServerv4Lease -ComputerName dhcpsrv.TOSSolution.com
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 dhcpsrv.TOSSolution.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.
You can check the Version, CommandType and Source of this cmdlet by giving below command.
Get-Command Get-DhcpServerv4Lease
You can also read about
- Add-DhcpServerv4Lease
- Get-DhcpServerv4Scope
- Remove-DhcpServerv4Lease
To know more PowerShell cmdlets(Commands) on DHCPServer click here
