Add-DhcpServerv4OptionDefinition is accessible with the help of DHCPServer module. To configure DHCPServer, go through this link.
Synopsis
Adds a new DHCPv4 option definition on the Dynamic Host Configuration Protocol (DHCP) server service.
Description
Adds a new DHCPv4 option definition on the Dynamic Host Configuration Protocol (DHCP) server service. An option definition needs to exist before an option value of that type can be configured.
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 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 for the option for which a definition is created. The syntax to specify the default value for the option as follows:
- Byte, Word, DWord, DWordDword. These values can be specified as decimal or hexadecimal strings.
- IPAddress, IPv6Address. These values can be specified as IP address strings.
- String. This value can be specified as a string.
- BinaryData, EncapsulatedData. These values can be specified as hexadecimal strings.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
-Description
Specifies the description of the option definition being added.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
-MultiValued
Allows for multiple values.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
-Name
Specifies the name of the DHCPv4 option.
| Type: | String |
| Position: | 1 |
| Default value: | None |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
-OptionId
Specifies the numeric identifier of the option. The acceptable values for this parameter are: 1 through 255.
| Type: | UInt32 |
| Position: | 2 |
| Default value: | None |
| Accept pipeline input: | True (ByPropertyName) |
| 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 data type of the values for this option. The acceptable values for this parameter are:
- Byte
- Word
- DWord
- DWordDword
- IPAddress
- String
- BinaryData
- EncapsulatedData
- IPv6Address
| Type: | String |
| Accepted values: | Byte, Word, DWord, DWordDWord, IPv4Address, String, BinaryData, EncapsulatedData |
| Position: | 3 |
| Default value: | None |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
-VendorClass
Adds the Option Definition for the specified vendor class.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | True (ByPropertyName) |
| 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
Add-DhcpServerv4OptionDefinition [-ComputerName <String>] [-Name] <String> [-Description <String>] [-OptionId] <UInt32> [-Type] <String> [-MultiValued] [-VendorClass <String>] [-DefaultValue <String[]>] [-PassThru] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [-WhatIf] [-Confirm] [<CommonParameters>]
———————EXAMPLE 1———————
PS C:>Add-DhcpServerv4OptionDefinition -Name WPAD -OptionId 200 -Type String
This example adds the IPv4 option definition for web proxy auto detection (wpad) to the DHCPv4 server service.
———————EXAMPLE 2———————
PS C:>Add-DhcpServerv4OptionDefinition -Name UComID -OptionId 5 -Type BinaryData -VendorClass MS-UC-Client -Description “Unified Communication Identifier”
This example adds the option definition for the Unified Communications (UC) identifier for the vendor class named MS-UC-Client.
You can check the Version, CommandType and Source of this cmdlet by giving below command.
Get-Command Add-DhcpServerv4OptionDefinition
You can also read about
- Get-DhcpServerv4OptionDefinition
- Remove-DhcpServerv4OptionDefinition
- Set-DhcpServerv4OptionDefinition
To know more PowerShell cmdlets(Commands) on DHCPServer click here