Set-DhcpServerv4OptionDefinition

Set-DhcpServerv4OptionDefinition

Modifies the properties of an existing IPv4 option definition.

Syntax

Parameter Set: Set3
Set-DhcpServerv4OptionDefinition [-OptionId] <UInt32> [-AsJob] [-CimSession <CimSession[]> ] [-ComputerName <String> ] [-DefaultValue <String[]> ] [-Description <String> ] [-Name <String> ] [-PassThru] [-ThrottleLimit <Int32> ] [-VendorClass <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Set-DhcpServerv4OptionDefinition cmdlet modifies the properties of an existing IPv4 option definition.

Parameters

-AsJob

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

-ComputerName<String>

Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the Dynamic Host Configuration Protocol (DHCP) server service.

-DefaultValue<String[]>

Specifies the default value to set for the option definition.

-Description<String>

Specifies the description to set for the option definition.

-Name<String>

Specifies the new name to set for the option definition.

-OptionId<UInt32>

Speciifes the numeric identifier (ID) of the option definition being modified.

-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

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

-VendorClass<String>

Modifies the properties of the option definition for the specified vendor class.

-Confirm

Prompts you for confirmation before running the cmdlet.

-WhatIf

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

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

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

• Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4OptionDefinition

  The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.

• Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4OptionValue

  The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.

Outputs

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

• Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4OptionDefinition

  The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.

Examples

EXAMPLE 1

This example sets the name and description for option definition matching the ID 3.

PS C:\> Set-DhcpServerv4OptionDefinition -OptionId 3 -Name "Default Gateway" -Description "router set for the subnet"

Related topics

Add-DhcpServerv4OptionDefinition

Get-DhcpServerv4OptionDefinition

Remove-DhcpServerv4OptionDefinition