Remove-DhcpServerv4OptionDefinition

Remove-DhcpServerv4OptionDefinition

Deletes one or more IPv4 option definitions from a Dynamic Host Configuration Protocol (DHCP) server service.

Syntax

Parameter Set: Remove2
Remove-DhcpServerv4OptionDefinition [-OptionId] <UInt32[]> [[-VendorClass] <String> ] [-AsJob] [-CimSession <CimSession[]> ] [-ComputerName <String> ] [-Passthru] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Get-DhcpServerv4OptionDefinition cmdlet deletes one or more IPv4 option definitions from a Dynamic Host Configuration Protocol (DHCP) server service. If the VendorClass parameter is specified, then only option definitions for that vendor class are removed.

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 DHCP server service.

-OptionId<UInt32[]>

Specifies one or more numeric identifiers (IDs) for the options which are to be deleted.

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

Deletes the option definitions only 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 deletes the DHCPv4 option definition for the specified option.

PS C:\> Remove-DhcpServerv4OptionDefinition -ComputerName dhcpserver.contoso.com -OptionId 23

EXAMPLE 2

This example deletes the DHCPv4 option definitions for the specified vendor-specific option.

PS C:\> Remove-DhcpServerv4OptionDefinition -ComputerName dhcpserver.contoso.com -VendorClass "MSUCClient" -OptionId 5

Related topics

Add-DhcpServerv4OptionDefinition

Get-DhcpServerv4OptionDefinition

Set-DhcpServerv4OptionDefinition