Add-DhcpServerv4OptionDefinition

Add-DhcpServerv4OptionDefinition

Adds a DHCPv4 option definition on the 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

The Add-DhcpServerv4OptionDefinition cmdlet adds a new DHCPv4 option definition on the Dynamic Host Configuration Protocol (DHCP) server service. An option definition must 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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

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


Aliases

Session

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ComputerName<String>

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


Aliases

Cn

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Description<String>

Specifies the description of the option definition being added.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-MultiValued

Allows for multiple values.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Name<String>

Specifies the name of the DHCPv4 option.


Aliases

none

Required?

true

Position?

2

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-OptionId<UInt32>

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


Aliases

none

Required?

true

Position?

3

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

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


Aliases

none

Required?

true

Position?

4

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-VendorClass<String>

Adds the Option Definition for the specified vendor class.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

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


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see    about_CommonParameters.

Inputs

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

Outputs

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

Examples

Example 1: Add the IPv4 option definition for web proxy auto detection

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: Add the option definition for the UC identifier for a vendor class

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

Community Additions

ADD
Show: