Remove-DhcpServerv4OptionValue
Remove-DhcpServerv4OptionValue
Deletes one or more IPv4 option values at the server, scope or reservation level, either for the standard IPv4 options or for the specified vendor or user class.
Syntax
Parameter Set: Remove1
Remove-DhcpServerv4OptionValue [-OptionId] <UInt32[]> [[-ScopeId] <IPAddress> ] [-AsJob] [-CimSession <CimSession[]> ] [-ComputerName <String> ] [-PassThru] [-PolicyName <String> ] [-ReservedIP <IPAddress> ] [-ThrottleLimit <Int32> ] [-UserClass <String> ] [-VendorClass <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Remove-DhcpServerv4OptionValue cmdlet deletes one or more IPv4 option values at the server, scope or reservation level, either for the standard IPv4 options or for the specified vendor or user class.
If only the ReservedIP parameter is specified, then the option values set at the reservation level are deleted. If only the ScopeId parameter is specified, then the option values set at the scope level are deleted. If neither the ScopeId nor the ReservedIP parameter is specified, then the option values set at the server level are deleted. The ScopeId and the ReservedIP parameters cannot both be specified.
The UserClass and PolicyName parameters cannot both be specified.
Parameters
-AsJob
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 |
none |
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 Dynamic Host Configuration Protocol (DHCP) server service.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-OptionId<UInt32[]>
Specifies one or more numeric identifiers (IDs) for the options which are to be deleted.
Aliases |
none |
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-PolicyName<String>
Specifies the name of the policy from which the option values are deleted.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ReservedIP<IPAddress>
Specifies the IPv4 address of the reservation from which the option values are deleted.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ScopeId<IPAddress>
Specifies the scope ID, in IPv4 address format, from which the option values are deleted.
Aliases |
none |
Required? |
false |
Position? |
2 |
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 that the option values for the specified user class are deleted.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-VendorClass<String>
Specifies that the option values for the specified vendor class are deleted.
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: -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/DhcpServerv4OptionValue
The
Microsoft.Management.Infrastructure.CimInstanceobject 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/DhcpServerv4OptionValue[]
The
Microsoft.Management.Infrastructure.CimInstanceobject 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 DHCPv4 option value configured on the specified scope for the specified option ID.
PS C:\> Remove-DhcpServerv4OptionValue -ComputerName dhcpserver.contoso.com -ScopeId 10.10.10.0 -OptionId 23
EXAMPLE 2
This example deletes DHCPv4 option value configured on the specified scope for the specified vendor class named MSUCClient with the specific option 5.
PS C:\> Remove-DhcpServerv4OptionValue -ComputerName dhcpserver.contoso.com -ScopeId 10.10.10.0 -VendorClass MSUCClient -OptionId 5
EXAMPLE 3
This example deletes DHCPv4 option value with the option ID 252 configured for the specified policy in the scope 10.10.10.0.
PS C:\> Remove-DhcpServerv4OptionValue -ComputerName dhcpserver.contoso.com -ScopeId 10.10.10.0 -PolicyName SmartPhonePolicy -OptionId 252
EXAMPLE 4
This example deletes DHCPv4 option value with the option ID 252 configured for the specified user class in the scope 10.10.10.0.
PS C:\> Remove-DhcpServerv4OptionValue -ComputerName dhcpserver.contoso.com -ScopeId 10.10.10.0 -UserClass LabComputer -OptionId 252
EXAMPLE 5
This example deletes DHCPv4 option value configured at the server level, or server-wide, for the specified option ID.
PS C:\> Remove-DhcpServerv4OptionValue -ComputerName dhcpserver.contoso.com -OptionId 23
EXAMPLE 6
This example deletes DHCPv4 option value configured at the server level, or server-wide, for the specified vendor class named MSUCClient with the specific option 5.
PS C:\> Remove-DhcpServerv4OptionValue -ComputerName dhcpserver.contoso.com -VendorClass MSUCClient -OptionId 5
EXAMPLE 7
This example deletes DHCPv4 option value with the option ID 252 configured for the specified policy at the server level, or server-wide.
PS C:\> Remove-DhcpServerv4OptionValue -ComputerName dhcpserver.contoso.com -PolicyName SmartPhonePolicy -OptionId 252
EXAMPLE 8
This example deletes DHCPv4 option value with the option ID 252 configured for the specified user class at the server level, or server-wide.
PS C:\> Remove-DhcpServerv4OptionValue -ComputerName dhcpserver.contoso.com -UserClass LabComputer -OptionId 252
EXAMPLE 9
This example deletes DHCPv4 option value configured on the specified reservation for the specified option ID.
PS C:\> Remove-DhcpServerv4OptionValue -ComputerName dhcpserver.contoso.com -ReservedIP 10.10.10.5 -OptionId 23