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
 

Set-DhcpServerv6OptionValue

Set-DhcpServerv6OptionValue

ps_dhcpserverv6optionvalue_v1.0.0.cdxml

Synopsis

Sets an IPv6 option value at the server, scope, or reservation level.

Syntax

Set-DhcpServerv6OptionValue [-OptionId] [-Value] [-Prefix] [-AsJob] [-CimSession] [-ComputerName] [-Force] [-PassThru] [-ReservedIP] [-ThrottleLimit] [-UserClass] [-VendorClass] [-Confirm] [-WhatIf] [<CommonParameters>]

Set-DhcpServerv6OptionValue [-Prefix] [-AsJob] [-CimSession] [-ComputerName] [-DnsServer] [-DomainSearchList] [-Force] [-InfoRefreshTime] [-PassThru] [-ReservedIP] [-ThrottleLimit] [-UserClass] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

The Set-DhcpServerv6OptionValue cmdlet sets an IPv6 option value at the server, scope, or reservation level. The definition for the option must already exist on the Dynamic Host Configuration Protocol (DHCP) server service. If the ReservedIP parameter is specified, then the option values are set at the reservation level. If only the Prefix parameter is specified, then the option values are set at the scope level. If neither the Prefix nor ReservedIP parameter is specified, then the option values are set at the server level. The Prefix and ReservedIP parameters cannot both be specified.

If the VendorClass parameter is specified, then this cmdlet sets the option value for the specified vendor class. If the UserClass parameter is specified, then this cmdlet sets the option value for the specified user class.

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

-DnsServer <IPAddress[]>

Specifies one or more values for the DNS server option.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-DomainSearchList <String[]>

Specifies one or more values for the domain search list option.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-Force <SwitchParameter>

Specifies that the DNS server validation should not be performed. This parameter is applicable only if the DNSServer parameter or option ID 23 is specified.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-InfoRefreshTime <UInt32>

Specifies the value for the information refresh option. This parameter value specifies an upper bound for how long a client should wait before refreshing information retrieved from DHCPv6 server. This parameter is used with stateless DHCPv6 as there are no addresses or other entities with lifetimes that can tell the client when to contact the DHCPv6 server to refresh its configuration.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-OptionId <UInt32>

Specifies the numeric identifier (ID) of the option for which a value is being set.

Aliases

None

Required?

true

Position

2

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

-Prefix <IPAddress>

Specifies the IPv6 subnet prefix of the scope on which the option value is being set.

Aliases

None

Required?

false

Position

4

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-ReservedIP <IPAddress>

Specifies the IPv6 address of the reservation for which the option value is being set.

Aliases

IPAddress

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

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

-UserClass <String>

Specifies the option value for the specified user class.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-Value <String[]>

Specifies the value being set for the option.

Aliases

None

Required?

true

Position

3

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-VendorClass <String>

Specifies the option value 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
Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6Reservation
Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv6Scope

Return Type

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

Notes

None

Examples

EXAMPLE 1

This example sets the DHCPv6 server level option values for DNS server and domain search list options.

PS C:\>Set-DhcpServerv6OptionValue -ComputerName dhcpserver.contoso.com -DnsServer 2001:4898:7020:1020::2 -DomainSearchList contoso.com

EXAMPLE 2

This example sets the DHCPv6 option values for DNS server and domain search list options on the scope 2001:4898:7020:1020::.

PS C:\>Set-DhcpServerv6OptionValue -ComputerName dhcpserver.contoso.com -Prefix 2001:4898:7020:1020:: -DnsServer 2001:4898:7020:1020::2 -DomainSearchList contoso.com

EXAMPLE 3

This example sets server-wide DHCPv6 option value for option ID 23, or the DNS server.

PS C:\>Set-DhcpServerv6OptionValue -ComputerName dhcpserver.contoso.com -OptionId 23 -Value 2001:4898:7020:1020::2

EXAMPLE 4

This example sets the DHCPv6 option value for option ID 23, or the DNS server, for the specified DHCPv6 scope.

PS C:\>Set-DhcpServerv6OptionValue -ComputerName dhcpserver.contoso.com -Prefix 2001:4898:7020:1020:: -OptionId 23 -Value 2001:4898:7020:1020::2

EXAMPLE 5

This example sets the DHCPv6 option value for option ID 23, or the DNS server, for the specified reservation.

PS C:\>Set-DhcpServerv6OptionValue -ComputerName dhcpserver.contoso.com -ReservedIP 2001:4898:7020:1020::5 -OptionId 23 -Value 2001:4898:7020:1020::2

EXAMPLE 6

This example sets the vendor-class-specific DHCPv6 option value configured on the specified scope for the specified vendor class named MSUCClient.

PS C:\>Set-DhcpServerv6OptionValue -ComputerName dhcpserver.contoso.com -Prefix 2001:4898:7020:1020:: -VendorClass MSUCClient -OptionId 5 -Value 6874747073

EXAMPLE 7

This example sets the user-class-specific DHCPv6 option value for option ID 23, or the DNS server, on the specified scope for the specified user class.

PS C:\>Set-DhcpServerv6OptionValue -ComputerName dhcpserver.contoso.com -Prefix 2001:4898:7020:1020:: -UserClass LabComputer -OptionId 23 -Value 2001:4898:7020:1020::20

Online Version
Get-DhcpServerv6OptionValue
Remove-DhcpServerv6OptionValue