Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Remove-DhcpServerv4Policy

Remove-DhcpServerv4Policy

ps_dhcpserverv4policy_v1.0.0.cdxml

Synopsis

Deletes one or more specified IPv4 policies either at the server level or the specified scope level.

Syntax

Remove-DhcpServerv4Policy [-Name] [-ScopeId] [-AsJob] [-CimSession] [-ComputerName] [-PassThru] [-ThrottleLimit] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

The Remove-DhcpServerv4Policy cmdlet deletes one or more specified IPv4 policies either at the server level or the specified scope level.

Parameters

-AsJob <SwitchParameter>

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.

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

Session

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-ComputerName <String>

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

Aliases

Cn

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Name <String[]>

Specifies one or more names of the policies to be deleted.

Aliases

None

Required?

true

Position

2

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-PassThru <SwitchParameter>

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

-ScopeId <IPAddress>

Specifies the scope identifier (ID), in IPv4 address format, from which the policies are to be deleted.

Aliases

None

Required?

false

Position

3

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

-Confirm <SwitchParameter>

Prompts you for confirmation before running the cmdlet.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

-WhatIf <SwitchParameter>

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

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Policy
Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Scope

Return Type

Microsoft.Management.Infrastructure.CimInstance#root/Microsoft/Windows/DHCP/DhcpServerv4Policy[]

Notes

None

Examples

EXAMPLE 1

This example deletes the server level, or server-wide, policies named IPPhonePolicy and PrinterPolicy from the DHCP server service running on the computer named dhcpserver.contoso.com.

PS C:\>Remove-DhcpServerv4Policy -ComputerName dhcpserver.contoso.com -Name IPPhonePolicy,PrinterPolicy

EXAMPLE 2

This example deletes the policy named HyperVPolicy inside the scope 10.10.10.0 from the DHCP server service running on the computer named dhcpserver.contoso.com.

PS C:\>Remove-DhcpServerv4Policy -ComputerName dhcpserver.contoso.com -Name HyperVPolicy -ScopeId 10.10.10.0

Online Version
Add-DhcpServerv4Policy
Add-DhcpServerv4PolicyIPRange
Get-DhcpServerv4Policy
Get-DhcpServerv4PolicyIPRange
Remove-DhcpServerv4PolicyIPRange
Set-DhcpServerv4Policy