Remove-NetFirewallHyperVRule

Module:

NetSecurity

Deletes one or more Hyper-V firewall rules that match the specified criteria.

Syntax

Remove-NetFirewallHyperVRule
      [-All]
      [-PolicyStore <string>]
      [-CimSession <CimSession[]>]
      [-ThrottleLimit <int>]
      [-AsJob]
      [-PassThru]
      [-WhatIf]
      [-Confirm] 
      [<CommonParameters>]

Remove-NetFirewallHyperVRule
      [-Name] <string[]>
      [-PolicyStore <string>]
      [-CimSession <CimSession[]>]
      [-ThrottleLimit <int>]
      [-AsJob]
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-NetFirewallHyperVRule
      -DisplayName <string[]>
      [-PolicyStore <string>]
      [-CimSession <CimSession[]>]
      [-ThrottleLimit <int>]
      [-AsJob]
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-NetFirewallHyperVRule
      [-Direction {Inbound | Outbound}]
      [-VMCreatorId <string[]>]
      [-Protocol <string[]>]
      [-Action {NotConfigured | Allow | Block}]
      [-Enabled {True | False}]
      [-EnforcementStatus {Unknown | OK | PartiallyEnforced | NoApplicablePorts | ParsingError | Error}]
      [-PolicyStoreSourceType {None | Local | MDM}]
      [-PolicyStore <string>]
      [-CimSession <CimSession[]>]
      [-ThrottleLimit <int>]
      [-AsJob]
      [-PassThru]
      [-WhatIf]
      [-Confirm] 
      [<CommonParameters>]

Remove-NetFirewallHyperVRule
      -InputObject <CimInstance#MSFT_NetFirewallHyperVRule[]>
      [-CimSession <CimSession[]>]
      [-ThrottleLimit <int>]
      [-AsJob]
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Important: Running this cmdlet without parameters removes all Windows Hyper-V firewall rules on the target computer. Always run this cmdlet with the WhatIf parameter if you are not targeting a specific Windows Hyper-V Firewall rule.

The Remove-NetFirewallHyperVRule cmdlet permanently deletes a Hyper-V firewall rule to be inactive. This is different from the Disable-NetFirewallHyperVRule cmdlet, which will only disable the rule. A Disabled rule will not actively modify system behavior, but the rule still exists on the computer so it can be re-enabled later.

This cmdlet removes one or more Hyper-V firewall rules with the Name parameter, DisplayName parameter, or rule properties.

Examples

EXAMPLE 1

PS C:\> Remove-NetFirewallHyperVRule

This example retrieves all the Hyper-V firewall rules in the local store and removes them.

EXAMPLE 2

PS C:\> Remove-NetFirewallHyperVRule -DisplayName 'MyServerIPBlock'

This example retrieves all the Hyper-V firewall rules with DisplayName 'MyServerIPBlock' and removes them.

Parameters

-Action

Specifies that matching Hyper-V firewall rules of the indicated action are removed. The acceptable values for this parameter are: Allow or Block.

• Allow: Network packets that match all criteria specified in this rule are permitted through the firewall. This is the default value.
• Block: Network packets that match all criteria specified in this rule are dropped by the firewall.

Type:	Action
Accepted values:	NotConfigured, Allow, Block
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
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
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Direction

Specifies that matching Hyper-V firewall rules of the indicated direction are removed. This parameter specifies which direction of traffic to match with this rule. The acceptable values for this parameter are: Inbound or Outbound.

Type:	Direction
Accepted values:	Inbound, Outbound
Position:	Named
Default value:	Inbound
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DisplayName

Specifies that only matching Hyper-V firewall rules of the indicated display name are removed. Wildcard characters are accepted.

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

-Enabled

Specifies that matching Hyper-V firewall rules of the indicated state are removed. This parameter specifies that the rule object is administratively enabled or administratively disabled. The acceptable values for this parameter are:

• True: Specifies the rule is currently enabled.
• False: Specifies the rule is currently disabled.

Note that the type of this parameter is not Boolean, therefore $true and $false variables are not acceptable values here. Use "True" and "False" text strings instead.

A disabled rule will not actively modify computer behavior, but the management construct still exists on the computer so it can be re-enabled.

Type:	Enabled
Accepted values:	True, False
Position:	Named
Default value:	True
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-EnforcementStatus

Specifies that firewall rules that match the indicated enforcement status are removed. This parameter specifies the overall status of the rule.

• OK: Specifies that the rule will work as specified.
• PartiallyEnforced: Specifies that one or more parts of the rule will not be enforced.
• NoApplicablePorts: Specifies that the rule is functioning as expected, but there are no ports applicable for this rule and therefore is not active.
• ParsingError: Specifies that the rule is corrupted and the computer is unable to use the rule at all.
• Error: Specifies that the computer is unable to use the rule at all.

Type:	PrimaryStatus[]
Accepted values:	Unknown, OK, Inactive, Error
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

Specifies that only matching Hyper-V firewall rules of the indicated name are removed. This name serves as the unique identifier for this rule. This parameter acts just like a file name, in that only one rule with a given name may exist in a policy store at a time.

Type:	String
Aliases:	ID
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PolicyStore

Targets the policy store from which to remove the rules. A policy store is a container for firewall policy. The acceptable values for this parameter are:

• PersistentStore: Sometimes called static rules, this store contains the persistent policy for the local computer. This policy is not from GPOs, and has been created manually or programmatically (during application installation) on the computer. Rules created in this store are attached to the ActiveStore and activated on the computer immediately.
• ActiveStore: This store contains the currently active policy, which is the sum of all policy stores that apply to the computer.
• SystemDefaults: This read-only store contains the default state of firewall rules.
• MDM: This store contains the rules configured via MDM.

By default, the PersistentStore is queried.

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

-PolicyStoreSourceType

Specifies that Hyper-V firewall rules that match the indicated policy store source type are removed. This parameter value is automatically generated and should not be modified. The acceptable values for this parameter are:

• Local: The object originates from the local store.
• MDM: The object originates from the MDM store.

By default, the local store is queried.

Type:	PolicyStoreType[]
Accepted values:	None, Local, MDM
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Protocol

Specifies that only matching Hyper-V firewall rules with the indicated protocol are removed.

The acceptable values for this parameter are:

• Protocols by number: 0-255.
• Protocols by name: TCP, UDP, ICMPv4, or ICMPv6.

Type:	String
Position:	Named
Default value:	None
Required:	False
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, 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
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-VMCreatorId

Specifies that only matching Hyper-V firewall rules with the specified VMCreatorId are removed. The format for this value is a GUID enclosed in brackets, such as '{9E288F02-CE00-4D9E-BE2B-14CE463B0298}'.

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

Inputs

None

Outputs

CimInstance

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.

Related Links

• New-NetFirewallHyperVRule
• Get-NetFirewallHyperVRule
• Enable-NetFirewallHyperVRule
• Disable-NetFirewallHyperVRule
• Rename-NetFirewallHyperVRule
• Set-NetFirewallHyperVRule
• Get-NetfirewallHyperVVMCreator