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
 

Set-NetFirewallInterfaceFilter

Set-NetFirewallInterfaceFilter

netfirewallinterfacefilter.cmdletdefinition.cdxml

Synopsis

Modifies interface filter objects, thereby modifying the InterfaceAlias parameter values of the firewall or IPsec rules.

Syntax

Set-NetFirewallInterfaceFilter [-AsJob] [-CimSession] [-GPOSession] [-InterfaceAlias] [-PassThru] [-PolicyStore] [-ThrottleLimit] [-Confirm] [-WhatIf] [<CommonParameters>]

Set-NetFirewallInterfaceFilter [-AsJob] [-CimSession] [-InterfaceAlias] [-PassThru] [-ThrottleLimit] [-InputObject] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

The Set-NetFirewallInterfaceFilter cmdlet modifies the interfaces associated with the input firewall rules.

See the Get-NetFirewallInterfaceFilter cmdlet for more information about the interface filters.

To modify the interface conditions, two methods can be used starting with the Get-NetFirewallInterfaceFilter cmdlet that returns the interface filter objects and optional additional querying. -- The network firewall interface filter objects are piped into the Get-NetFirewallRule or Get-NetIPsecRule cmdlet. The Get-NetFirewallRule or Get-NetIPsecRule cmdlet returns the rules objects associated with the filters rules and pipes the rules objects into the Set-NetFirewallRule or Set-NetIPsecrule cmdlet, which configures the interface properties. -- Alternatively, the network firewall interface filter objects are piped directly to this cmdlet, which modifies the Program and Package parameter values of the rules.

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

-GPOSession <String>

Targets the network GPO from which to retrieve the rules to be modified. This parameter is used in the same way as the PolicyStore parameter. When modifying GPOs in Windows PowerShell®, each change to a GPO requires the entire GPO to be loaded, modified, and saved back. On a busy Domain Controller (DC), this can be a slow and resource-heavy operation. A GPO Session loads a domain GPO onto the local computer and makes all changes in a batch, before saving it back. This reduces the load on the DC and speeds up the Windows PowerShell cmdlets. To load a GPO Session, use the Open-NetGPO cmdlet. To save a GPO Session, use the Save-NetGPO cmdlet.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-InputObject <CimInstance[]>

Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

True (ByValue)

Accept wildcard characters?

false

-InterfaceAlias <String[]>

Specifies the alias of the interface that applies to the traffic.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

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

-PolicyStore <String>

Targets the policy store from which to retrieve the rules to be modified. A policy store is a container for firewall and IPsec 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. This is the resultant set of policy (RSOP) for the local computer (the sum of all GPOs that apply to the computer), and the local stores (the PersistentStore, the static Windows service hardening (WSH), and the configurable WSH). ---- GPOs are also policy stores. Computer GPOs can be specified as follows. ------ –PolicyStore hostname. ---- Active Directory GPOs can be specified as follows. ------ –PolicyStore domain.fqdn.com\GPO_Friendly_Name. ------ Such as the following. -------- -PolicyStore localhost -------- -PolicyStore corp.contoso.com\FirewallPolicy ---- Active Directory GPOs can be created using the New-GPO cmdlet or the Group Policy Management Console. -- RSOP: This read-only store contains the sum of all GPOs applied to the local computer. -- SystemDefaults: This read-only store contains the default state of firewall rules that ship with Windows Server® 2012. -- StaticServiceStore: This read-only store contains all the service restrictions that ship with Windows Server 2012. Optional and product-dependent features are considered part of Windows Server 2012 for the purposes of WFAS. -- ConfigurableServiceStore: This read-write store contains all the service restrictions that are added for third-party services. In addition, network isolation rules that are created for Windows Store application containers will appear in this policy store. The default value is PersistentStore. Note: The Set-NetFirewallRule cmdlet cannot be used to add an object to a policy store. An object can only be added to a policy store at creation time with the Copy-NetFirewallRulecmdlet or with the New-NetFirewallRule cmdlet.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

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\StandardCimv2\MSFT_NetInterfaceFilter[]

Return Type

Microsoft.Management.Infrastructure.CimInstance#root\StandardCimv2\MSFT_NetInterfaceFilter[]

Notes

None

Examples

EXAMPLE 1

This example modifies the InterfaceAlias parameter value of a particular firewall rule.

PS C:\>$nfwInterfaceFilter = ( Get-FirewallRule –DisplayName "Contoso Messenger" | Get-NetFirewallInterfaceFilter )



PS C:\>Set-NetFirewallInterfaceFilter –InterfaceAlias Any –InputObject $nfwInterfaceFilter


This cmdlet can be run using only the pipeline.
PS C:\>Get-FirewallRule –DisplayName "Contoso Messenger" | Get-NetFirewallInterfaceFilter | Set-NetFirewallInterfaceFilter –InterfaceAlias Any


This cmdlet can be run without using the pipeline.
PS C:\>Set-NetFirewallRule –DisplayName "Contoso Messenger" –InterfaceAlias Any

EXAMPLE 2

This example modifies a particular interface alias associated with all of the firewall rules in a specified group.

PS C:\>$nfwInterfaceFilter = ( Get-NetIPsecRule –Group "Wired Rules" | Get-NetFirewallInterfaceFilter )



PS C:\>$nfwInterfaceFilterWired2 = ( Where-Object -Property { $_.InterfaceAlias –Eq "Wired2" } –InputObject $nfwInterfaceFilter )



PS C:\>Set-NetFirewallInterfaceFilter –InterfaceAlias Wired3 –InputObject $nfwInterfaceFilterWired2


This cmdlet can be run using only the pipeline.
PS C:\>Get-NetIPsecRule –Group "Wired Rules" | Get-NetFirewallInterfaceFilter | Where-Object -Property { $_.InterfaceAlias –Eq "Wired2" } | Set-NetFirewallInterfaceFilter –InterfaceAlias Wired3

Online Version
Where-Object
Copy-NetIPsecRule
Get-NetFirewallApplicationFilter
Get-NetFirewallInterfaceFilter
Get-NetFirewallRule
Get-NetIPSecRule
New-NetFirewallRule
New-NetIPSecRule
Open-NetGPO
Save-NetGPO
Set-NetFirewallRule
Set-NetIPSecRule
New-GPO