Set-NetFirewallHyperVProfile

Configures Hyper-V firewall profile settings on the target computer.

Syntax

Set-NetFirewallHyperVProfile
   [-PolicyStore <string>]
   [-GPOSession <string>]
   [-Name <string>]
   [-Profile {Any | Domain | Private | Public | NotApplicable}]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <int>]
   [-AsJob]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-NetFirewallHyperVProfile cmdlet configures the Hyper-V firewall profile settings on the system. These settings are applicable to all Hyper-V firewall ports created by a specific Hyper-V firewall VM creator. These settings apply to the VM only when the profile is active.

This cmdlet should be used when a Hyper-V VM creator has registered its VM creator ID with the system, when another Hyper-V setting is already configured for the specified VM creator ID, or when a Hyper-V firewall port is created with the specified VM creator ID. If none of the above are true, then the New-NetFirewallHyperVProfile cmdlet should be used.

Examples

EXAMPLE 1

PS C:\> Set-NetFirewallHyperVProfile -Name '{9E288F02-CE00-4D9E-BE2B-14CE463B0298}' -Profile Public -Enabled True

This example configures the Enabled setting on the Public profile for all Hyper-V firewall ports created by the Hyper-V firewall VM creator specified.

Parameters

-AllowLocalFirewallRules

Specifies that the local firewall rules should be merged into the effective policy. The acceptable values for this parameter are: False, True, or NotConfigured.

  • True: The firewall rules defined by the local administrator are merged with firewall rules from MDM and are applied to the computer.
  • False: The firewall rules defined by the local administrator are ignored, and only firewall rules from MDM are applied to the computer.
  • NotConfigured: This resets the value back to the default.

The default setting is True.

Type:GpoBoolean
Accepted values:False, True, NotConfigured
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

-DefaultInboundAction

Specifies how to filter inbound traffic that does not match any Hyper-V firewall rules. The acceptable values for this parameter are: NotConfigured, Allow, or Block.

  • Block: Blocks inbound network traffic that does not match an inbound rule.
  • Allow: Allows all inbound network traffic, whether or not it matches an inbound rule.
  • NotConfigured: Resets this value back to its default.

The default setting is Block.

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

-DefaultOutboundAction

Specifies how to filter outbound traffic that does not match any Hyper-V firewall rules. The acceptable values for this parameter are: NotConfigured, Allow, or Block.

  • Block: Blocks outbound network traffic that does not match an outbound rule.
  • Allow: Allows all outbound network traffic, whether or not it matches an outbound rule.
  • NotConfigured: Resets this value back to its default.

The default setting is Block.

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

-Enabled

Determines whether or not the Hyper-V firewall is active and enforced. The acceptable values for this parameter are: False, True, or NotConfigured.

  • True: Enables Windows Hyper-V firewall.
  • False: Disables Windows Hyper-V firewall.
  • NotConfigured: Resets this value back to its default.

The default setting is True.

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

-Name

Specifies that the settings are applicable only to the Hyper-V firewall VM creator with the matching ID. The format for this value is a GUID enclosed in brackets: '{9E288F02-CE00-4D9E-BE2B-14CE463B0298}'.

Type:String
Aliases:VMCreatorId
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

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.