Set-DhcpServerv6OptionValue

Set-DhcpServerv6OptionValue

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

Syntax

Parameter Set: OptionIds
Set-DhcpServerv6OptionValue [-OptionId] <UInt32> [-Value] <String[]> [[-Prefix] <IPAddress> ] [-AsJob] [-CimSession <CimSession[]> ] [-ComputerName <String> ] [-Force] [-PassThru] [-ReservedIP <IPAddress> ] [-ThrottleLimit <Int32> ] [-UserClass <String> ] [-VendorClass <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: CommonOptions
Set-DhcpServerv6OptionValue [[-Prefix] <IPAddress> ] [-AsJob] [-CimSession <CimSession[]> ] [-ComputerName <String> ] [-DnsServer <IPAddress[]> ] [-DomainSearchList <String[]> ] [-Force] [-InfoRefreshTime <UInt32> ] [-PassThru] [-ReservedIP <IPAddress> ] [-ThrottleLimit <Int32> ] [-UserClass <String> ] [-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 you specify the ReservedIP parameter, the option values are set at the reservation level. If you specify only the Prefix parameter, the option values are set at the scope level. If you specify neither the Prefix nor ReservedIP parameter, the option values are set at the server level. The Prefix and ReservedIP parameters cannot both be specified.

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

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

-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

Specifies that the DNS server validation is skipped. 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 waits 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 set.


Aliases

none

Required?

true

Position?

2

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

-Prefix<IPAddress>

Specifies the IPv6 subnet prefix of the scope on which the option value is 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 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 to 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

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: Set server level option values

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: Set option values for a scope

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: Set service-wide option value for DNS server

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: Set option value for DNS server for a scope

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: Set option value for DNS server for a reservation

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: Set a vendor class specific option value

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: Set a user class specific option value for DNS server

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"

Related topics

Community Additions

ADD
Show: