Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Add-DhcpServerv6OptionDefinition

Add-DhcpServerv6OptionDefinition

ps_dhcpserverv6optiondefinition_v1.0.0.cdxml

Synopsis

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

Syntax

Add-DhcpServerv6OptionDefinition [-Name] [-OptionId] [-Type] [-AsJob] [-CimSession] [-ComputerName] [-DefaultValue] [-Description] [-MultiValued] [-PassThru] [-ThrottleLimit] [-VendorClass] [-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 <SwitchParameter>

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

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

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

Prompts you for confirmation before running the cmdlet.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

-WhatIf <SwitchParameter>

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

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6OptionDefinition
Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6OptionValue

Return Type

Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6OptionDefinition

Notes

None

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

Online Version
Get-DhcpServerv6OptionDefinition
Remove-DhcpServerv6OptionDefinition
Set-DhcpServerv6OptionDefinition