Export (0) Print
Expand All
Expand Minimize
This topic has not yet been rated - Rate this topic

Add-DhcpServerv6OptionDefinition

Windows Server 2012 R2 and Windows 8.1

Updated: December 20, 2013

Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2

Add-DhcpServerv6OptionDefinition

Adds a DHCPv6 option definition to a Dynamic Host Configuration Protocol (DHCP) server service running on the local or a remote computer.

Syntax

Parameter Set: Add0
Add-DhcpServerv6OptionDefinition [-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-DhcpServerv6OptionDefinition cmdlet adds a DHCPv6 option definition to a Dynamic Host Configuration Protocol (DHCP) server service running on the local or a remote computer.

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 running 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.
If the type of the option is Byte, Word, DWord, or DWordDword, then the default value must be specified as one or more decimal or hexadecimal strings.
If the type of the option is IPAddress or IPv6Address, then the default value must be specified as an IP address string.
If the type of the option is String, then the default value must be specified as a string.
If the type of the option is BinaryData or EncapsulatedData, then the default value must be specified as a hexadecimal string.


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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-MultiValued

Specifies that the option allows multiple values to be specified.


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


Aliases

none

Required?

true

Position?

2

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-OptionId<UInt32>

Specifies the integer identifier (ID) for the option.


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 option. The acceptable values for this parameter are:  Byte, Word, DWord, DWordDword, IPAddress, String, BinaryData, EncapsulatedData, or 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 only 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: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. 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

This example adds the Broadcast and Multi-cast Service Controller IPv6 Address option definition to the DHCPv6 server service.


PS C:\> Add-DhcpServerv6OptionDefinition -Name "Broadcast and Multicast Service Controller IPv6 Address" -OptionId 36 -Type IPv6Address

Related topics

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.