Set-DhcpServerv4OptionDefinition
Set-DhcpServerv4OptionDefinition is accessible with the help of DHCPServer module. To configure DHCPServer, go through this link.
Synopsis
Modifies the properties of an existing IPv4 option definition.
Description
The Set-DhcpServerv4OptionDefinition cmdlet modifies the properties of an existing IPv4 option definition.
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 |
-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 |
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 |
-DefaultValue
Specifies the default value to set for the option definition.
Type: | String[] |
Position: | Named |
Default value: | None |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Description
Specifies the description to set for the option definition.
Type: | String |
Position: | Named |
Default value: | None |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Name
Specifies the new name to set for the option definition.
Type: | String |
Position: | Named |
Default value: | None |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-OptionId
Specifies the numeric identifier (ID) of the option definition being modified.
Type: | UInt32 |
Position: | 1 |
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 |
-VendorClass
Modifies the properties of the option definition for the specified vendor class.
Type: | String |
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-DhcpServerv4OptionDefinition [-ComputerName <String>] [-OptionId] <UInt32> [-Name <String>] [-Description <String>] [-VendorClass <String>] [-DefaultValue <String[]>] [-PassThru] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [-WhatIf] [-Confirm] [<CommonParameters>]
—————EXAMPLE 1—————
PS C:>Set-DhcpServerv4OptionDefinition -OptionId 5 -Name “Default Gateway” -Description “router set for the subnet”
This example sets the name and description for option definition matching the ID 5.
You can check the Version, CommandType and Source of this cmdlet by giving below command.
Get-Command Set-DhcpServerv4OptionDefinition
You can also read about
- Add-DhcpServerv4OptionDefinition
- Get-DhcpServerv4OptionDefinition
- Remove-DhcpServerv4OptionDefinition
To know more PowerShell cmdlets(Commands) on DHCPServer click here