Get-DhcpServerv4Reservation
Get-DhcpServerv4Reservation is accessible with the help of DHCPServer module. To configure DHCPServer, go through this link.
Synopsis
Gets one or more IPv4 reservations for the specified IP addresses or client identifiers (IDs).
Description
The Get-DhcpServerv4Reservation cmdlet gets one or more IPv4 reservations for the specified IP addresses or client identifiers (IDs). If only the ScopeId parameter is specified, then all of the IPv4 reservations from the specified scope are returned.
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 |
| 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 one or more client IDs of the reservations which need to be retrieved. For Windows clients, the MAC address is the client ID.
| 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 Dynamic Host Configuration Protocol (DHCP) server service.
| Type: | String |
| Aliases: | Cn, ReservationServer |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-IPAddress
Specifies one or more IPv4 addresses of the reservations which are to be retrieved.
| Type: | IPAddress[] |
| Aliases: | ReservedIP |
| 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 reservations are to be retrieved.
| Type: | IPAddress |
| Aliases: | ReservationScopeID |
| 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-DhcpServerv4Reservation [-ComputerName <String>] [-ScopeId] <IPAddress> [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [<CommonParameters>]
Get-DhcpServerv4Reservation [-ComputerName <String>] -IPAddress <IPAddress[]> [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [<CommonParameters>]
Get-DhcpServerv4Reservation [-ComputerName <String>] [-ClientId] <String[]> [-ScopeId] <IPAddress> [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [<CommonParameters>]
—————–EXAMPLE 1—————–
PS C:>Get-DhcpServerv4Reservation -ComputerName dhcpsrv.TOSSolution.com -ScopeId 192.168.1.0.
This cmdlet gets all of the reservations present in the specified scope on the specified DHCP server service running on the computer named dhcpsrv.TOSSolution.com.
—————–EXAMPLE 2—————–
PS C:>Get-DhcpServerv4Reservation -ComputerName dhcpsrv.TOSSolution.com -ScopeId 192.168.1.0 -ClientId 00-0C-29-00-E0-6B
This cmdlet gets the reservation present in the specified scope for specified client ID.
—————–EXAMPLE 3—————–
PS C:>Get-DhcpServerv4Reservation -ComputerName dhcpsrv.TOSSolution.com -IPAddress 192.168.1.31
This cmdlet gets the reservation information for specified IP address.
—————–EXAMPLE 4—————–
PS C:>Get-DhcpServerv4Scope -ComputerName dhcpsrv.TOSSolution.com | Get-DhcpServerv4Reservation -ComputerName dhcpsrv.TOSSolution.com
This cmdlet gets all the reserved IP addresses from all of the scopes on the server dhcpsrv.TOSSolution.com. The Get-DhcpServerv4Scope cmdlet returns all of the scope objects and pipes the objects into this cmdlet, which returns the reservations from all the scopes.
You can check the Version, CommandType and Source of this cmdlet by giving below command.
Get-Command Get-DhcpServerv4Reservation
You can also read about
- Add-DhcpServerv4Reservation
- Get-DhcpServerv4Scope
- Remove-DhcpServerv4Reservation
- Set-DhcpServerv4Reservation
To know more PowerShell cmdlets(Commands) on DHCPServer click here
