Set-NetFirewallSecurityFilter
Modifies security filter objects, thereby modifying the Authentication, Encryption, OverrideBlockRules, LocalUser, RemoteUser, and RemoteMachine conditions of the firewall rules.
Syntax
Set-NetFirewallSecurityFilter
[-PolicyStore <String>]
[-GPOSession <String>]
[-Authentication <Authentication>]
[-Encryption <Encryption>]
[-OverrideBlockRules <Boolean>]
[-LocalUser <String>]
[-RemoteUser <String>]
[-RemoteMachine <String>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Set-NetFirewallSecurityFilter
-InputObject <CimInstance[]>
[-Authentication <Authentication>]
[-Encryption <Encryption>]
[-OverrideBlockRules <Boolean>]
[-LocalUser <String>]
[-RemoteUser <String>]
[-RemoteMachine <String>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
The Set-NetFirewallSecurityFilter cmdlet modifies the security conditions associated with the input firewall rules.
See the Get-NetFirewallSecurityFilter cmdlet for more information on the security filters.
To modify the security conditions, two methods can be used starting with the security filters returned by the Get-NetFirewallSecurityFilter cmdlet and optional additional querying.
-- The network firewall security filter objects can be piped into the Get-NetFirewallRule cmdlet. The Get-NetFirewallRule cmdlet returns the rules associated with the filters and pipes the rules into the Set-NetFirewallRule cmdlet, which configures the interface properties.
-- Alternatively, piping the network firewall security filter objects directly to this cmdlet modifies the Authentication, Encryption, OverrideBlockRules, LocalUser, RemoteUser, and RemoteMachine parameters of the rules.
Examples
EXAMPLE 1
PS C:\>$users = New-Object -TypeName System.Security.Principal.NTAccount ("corp.contoso.com\Administrators")
PS C:\>$SIDofSecureUserGroup = $users.Translate([System.Security.Principal.SecurityIdentifier]).Value
PS C:\>$SecureMachineGroupSDDL = "D:(A;;CC;;; $SIDofSecureUserGroup)"
PS C:\>$nfSecurityFilter = Get-FirewallRule -DisplayName "Authorize Secure Computer" | Get-NetFirewallSecurityFilter
PS C:\>Set-NetFirewallSecurityFilter -RemoteMachine $SecureMachineGroupSDDL -InputObject $nfSecurityFilter
This cmdlet can be run using only the pipeline.
PS C:\>Get-FirewallRule -DisplayName "Authorize Secure Computer" | Get-NetFirewallSecurityFilter | Set-NetFirewallSecurityFilter -RemoteMachine $SecureMachineGroupSDDL
This cmdlet can be run without the pipeline.
PS C:\>Set-NetFirewallRule -DisplayName "Authorize Secure Computer" -RemoteMachine $SecureMachineGroupSDDLThis example modifies the user field of a particular firewall rule.
EXAMPLE 2
PS C:\>$nfSecurityFilter = Get-NetFirewallRule -DisplayGroup "*Printer*" | Get-NetFirewallSecurityFilter
PS C:\>Set-NetFirewallSecurityFilter -Authentication Request -InputObject $nfSecurityFilter
This cmdlet can be run using only the pipeline.
PS C:\>Get-NetFirewallRule -DisplayGroup "*Printer*" | Get-NetFirewallSecurityFilter | Set-NetFirewallSecurityFilter -Authentication RequestThis example modifies the security condition associated with the Printer firewall rules by requesting authenticated traffic.
Parameters
-AsJob
ps_cimcommon_asjob
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Authentication
Specifies that authentication is required on firewall rules. The acceptable values for this parameter are: NotRequired, Required, or NoEncap.
-- NotRequired: Any network packet matches this rule, that it is protected by IPsec. This option is the equivalent of not selecting the allow only secure connections option in the Windows Firewall with Advanced Security MMC snap-in.
-- Required: Network packets that are authenticated by IPsec match this rule. A separate IPsec rule must be created to authenticate the traffic. This option is the equivalent of the allow only secure connections option in the Windows Firewall with Advanced Security MMC snap-in.
-- NoEncap: Network connections that are authenticated, but not encapsulated by Encapsulating Security Payload (ESP) or Authentication Header (AH) match this rule. This option is useful for connections that must be monitored by network equipment, such as intrusion detection systems (IDS), that are not compatible with ESP NULL-protected network packets. The initial connection is authenticated by IPsec by using AuthIP, but the quick mode SA permits clear-text traffic. To use this option, you must also configure an IPsec rule that specifies authentication with encapsulation none as a quick mode security method. In the Microsoft Management Console (MMC), authentication and encryption are combined into one set of radio buttons. In Windows Management Instrumentation (WMI) or Windows PowerShell®, authentication and encryption are given as two separate options.
The default value is Required. Note: A rule can be queried for this condition, or modified by using the security filter object.
| Type: | Authentication |
| Accepted values: | NotRequired, Required, NoEncap |
| 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-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 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 |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Encryption
Specifies that encryption in authentication is required on firewall rules. The authentication is done through a separate IPsec or main mode rule. The acceptable values for this parameter are: NotRequired, Required, or Dynamic.
-- NotRequired: Encryption is not required for authentication.
-- Required: Encryption is required for authentication through an IPsec rule.
-- Dynamic: This is authdynenc in the netsh command-line.
The default value is NotRequired. Note: A rule can be queried for this condition, or modified by using the security filter object.
| Type: | Encryption |
| Accepted values: | NotRequired, Required, Dynamic |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-GPOSession
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.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.
| Type: | CimInstance[] |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-LocalUser
Specifies the principals to which the network traffic this firewall rule should apply. This is an SDDL string. The principals, represented by SIDs in the SDDL string, can be services, users, application containers, or any other SID that network traffic could be associated with. This parameter specifies that only network packets that are authenticated as coming from or going to a principal identified in the list of accounts (SID) match this rule. Note: Querying for rules with this parameter can only be performed using filter objects.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-OverrideBlockRules
Allows matching network traffic that would otherwise be modified. The network traffic must be authenticated by using a separate IPsec rule.
If the Direction parameter is set to Inbound, then this parameter is valid only for rules that have one or more accounts listed in the RemoteUser parameter and optionally the RemoteMachine parameter. Network packets that match this rule and that are successfully authenticated against a computer account specified in the RemoteUser parameter and against a user account identified in the RemoteMachine parameter are permitted through the firewall.
If this parameter is specified, then the Authentication parameter cannot be set to NotRequired. This parameter is equivalent to the override block rules checkbox in the Windows Firewall with Advanced Security MMC snap-in.
For computers that are running Windows® 7 or Windows Server 2008 R2, this parameter is permitted on an outbound rule. Selecting this parameter on an outbound rule causes matching traffic to be permitted through this rule even if other matching rules would block the traffic. No accounts are required in the RemoteMachine or RemoteUser parameter for an outbound bypass rule, however, if authorized or excepted computers are listed in those groups the rules will be enforced.
This parameter is not valid on outbound rules on computers that are running firstref_vista or earlier. Note: Querying for rules with this parameter can only be performed using filter objects. See the Get-NetFirewallSecurityFilter cmdlet for more information.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| 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 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PolicyStore
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_Namedomain.fqdn.comGPO_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-NetFirewallRule cmdlet or with the New-NetFirewallRule cmdlet.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RemoteMachine
Specifies that matching IPsec rules of the indicated computer accounts are modified. This parameter specifies that only network packets that are authenticated as incoming from or outgoing to a computer identified in the list of computer accounts (SID) match this rule. This parameter value is specified as an SDDL string. Note: Querying for rules with this parameter can only be performed using filter objects.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RemoteUser
Specifies that matching IPsec rules of the indicated user accounts are modified. This parameter specifies that only network packets that are authenticated as incoming from or outgoing to a user identified in the list of user accounts (SID) match this rule. This parameter value is specified as an SDDL string. Note: Querying for rules with this parameter can only be performed using filter objects.
| 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, 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 |
| Required: | False |
| Accept pipeline input: | False |
| 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 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
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.
Outputs
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.