Skip to content

Latest commit

 

History

History
209 lines (160 loc) · 5.61 KB

Remove-DhcpServerv4OptionDefinition.md

File metadata and controls

209 lines (160 loc) · 5.61 KB
external help file Module Name online version schema
DhcpServer_Cmdlets.xml
DhcpServer
2.0.0

Remove-DhcpServerv4OptionDefinition

SYNOPSIS

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

SYNTAX

Remove-DhcpServerv4OptionDefinition [-OptionId] <UInt32[]> [[-VendorClass] <String>] [-AsJob]
 [-CimSession <CimSession[]>] [-ComputerName <String>] [-Passthru] [-ThrottleLimit <Int32>] [-Confirm]
 [-WhatIf]

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.

EXAMPLES

EXAMPLE 1

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

This example deletes the DHCPv4 option definition for the specified option.

EXAMPLE 2

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

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

PARAMETERS

-AsJob

ps_cimcommon_asjob

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-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-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. The default is the current session on the local computer.

Type: CimSession[]
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ComputerName

Specifies the DNS name, or IPv4 or IPv6 address, of the target computer running the DHCP server service.

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-OptionId

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

Type: UInt32[]
Parameter Sets: (All)
Aliases: 

Required: True
Position: 1
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.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ThrottleLimit

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.

Type: Int32
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-VendorClass

Deletes the option definitions only for the specified vendor class.

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

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.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

INPUTS

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

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.

NOTES

RELATED LINKS

Add-DhcpServerv4OptionDefinition

Get-DhcpServerv4OptionDefinition

Set-DhcpServerv4OptionDefinition