Remove-DhcpServerv4OptionDefinition
Remove-DhcpServerv4OptionDefinition is accessible with the help of DHCPServer module. To configure DHCPServer, go through this link.
Synopsis
Deletes one or more IPv4 option definitions from a Dynamic Host Configuration Protocol (DHCP) server service.
Description
The Remove-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
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.
| Type: | SwitchParameter |
| 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-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.
| Type: | CimSession[] |
| Aliases: | Session |
| 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 that runs the DHCP server service.
| Type: | String |
| Aliases: | Cn |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | False |
| 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[] |
| 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 |
| 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 |
| 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 |
| Position: | 2 |
| Default value: | None |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Syntax
Remove-DhcpServerv4OptionDefinition [-ComputerName <String>] [-OptionId] <UInt32[]> [[-VendorClass] <String>] [-Passthru] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [-WhatIf] [-Confirm] [<CommonParameters>]
———————–EXAMPLE 1———————–
PS C:>Remove-DhcpServerv4OptionDefinition -ComputerName dhcpsrv.TOSSolution.com -OptionId 16
This example deletes the DHCPv4 option definition for the specified option.
———————–EXAMPLE 2———————–
PS C:>Remove-DhcpServerv4OptionDefinition -ComputerName dhcpsrv.TOSSolution.com -VendorClass “MSUCClient” -OptionId 13
This example deletes the DHCPv4 option definitions for the specified vendor-specific option.
You can check the Version, CommandType and Source of this cmdlet by giving below command.
Get-Command Remove-DhcpServerv4OptionDefinition
You can also read about
- Add-DhcpServerv4OptionDefinition
- Get-DhcpServerv4OptionDefinition
- Set-DhcpServerv4OptionDefinition
To know more PowerShell cmdlets(Commands) on DHCPServer click here
