Set-DhcpServerv4Reservation
Set-DhcpServerv4Reservation is accessible with the help of DHCPServer module. To configure DHCPServer, go through this link.
Synopsis
Modifies the properties of an IPv4 reservation.
Description
The Set-DhcpServerv4Reservation cmdlet modifies the properties of an IPv4 reservation.
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 the value of the client identifier (ID) to set on the reservation. For Windows clients, the MAC address is used as the client ID.
Type: | String |
Position: | Named |
Default value: | None |
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 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 |
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Description
Specifies the description to set for the reservation.
Type: | String |
Aliases: | ReservationDescription |
Position: | Named |
Default value: | None |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-IPAddress
Specifies the IPv4 address of the reservation for which the properties are modified.
Type: | IPAddress |
Aliases: | ReservedIP |
Position: | 1 |
Default value: | None |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Name
Specifies the name for the reservation.
Type: | String |
Aliases: | HostName, ReservationName |
Position: | Named |
Default value: | None |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-PassThru
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Accept pipeline input: | False |
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 |
-Type
Specifies the type of client that can be leased the reserved IPv4 address. The acceptable values for this parameter are: Dhcp, BootP, and Both.
Type: | String |
Aliases: | ReservationType |
Accepted values: | Dhcp, Bootp, Both |
Position: | Named |
Default value: | None |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Syntax
Set-DhcpServerv4Reservation [-ComputerName <String>] [-IPAddress] <IPAddress> [-ClientId <String>] [-Name <String>] [-Description <String>] [-Type <String>] [-PassThru] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [-WhatIf] [-Confirm] [<CommonParameters>]
—————EXAMPLE 1—————
PS C:>Set-DhcpServerv4Reservation -ComputerName dhcpsrv.TOSSolution.com -IPAddress 10.10.10.5 -Description “Fourth Floor Printer” -Name print.TOSSolution.com
This example sets the name and description for an existing DHCPv4 reservation for IP address 10.10.10.5.
You can check the Version, CommandType and Source of this cmdlet by giving below command.
Get-Command Set-DhcpServerv4Reservation
You can also read about
- Add-DhcpServerv4Reservation
- Get-DhcpServerv4Reservation
- Remove-DhcpServerv4Reservation
To know more PowerShell cmdlets(Commands) on DHCPServer click here