Add-DhcpServerv4OptionDefinition

Add-DhcpServerv4OptionDefinition

Adds a new DHCPv4 option definition on the Dynamic Host Configuration Protocol (DHCP) server service.

Syntax

Parameter Set: Add0
Add-DhcpServerv4OptionDefinition [-Name] <String> [-OptionId] <UInt32> [-Type] <String> [-AsJob] [-CimSession <CimSession[]> ] [-ComputerName <String> ] [-DefaultValue <String[]> ] [-Description <String> ] [-MultiValued] [-PassThru] [-ThrottleLimit <Int32> ] [-VendorClass <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed 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

-CimSession<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.

-ComputerName<String>

Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service.

-DefaultValue<String[]>

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.

-Description<String>

Specifies the description of the option definition being added.

-MultiValued

Allows for multiple values. The acceptable values for this parameter are: True or False.

-Name<String>

Specifies the name of the DHCPv4 option.

-OptionId<UInt32>

Specifies the numerical identifier of the option. The acceptable values for this parameter are: 1 through 255.

-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

-ThrottleLimit<Int32>

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<String>

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 or IPv6Address.

-VendorClass<String>

Adds the Option Definition for the specified vendor class.

-Confirm

Prompts you for confirmation before running the cmdlet.

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

• Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4OptionDefinition

  The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.

• Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4OptionValue

  The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.

Outputs

The output type is the type of the objects that the cmdlet emits.

• Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4OptionDefinition

  The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.

Examples

EXAMPLE 1

This example adds the IPv4 option definition for web proxy auto detection (wpad) to the DHCPv4 server service.

PS C:\> Add-DhcpServerv4OptionDefinition -Name WPAD -OptionId 252 -Type String

EXAMPLE 2

This example adds the option definition for the Unified Communications (UC) identifier for the vendor class named MS-UC-Client.

PS C:\> Add-DhcpServerv4OptionDefinition -Name UCIdentifier -OptionId 1 -Type BinaryData -VendorClass MS-UC-Client -Description "UC Identifier"

Related topics

Get-DhcpServerv4OptionDefinition

Remove-DhcpServerv4OptionDefinition

Set-DhcpServerv4OptionDefinition