Edit

Share via

New-NetIPsecRule

  • Reference
Module:
NetSecurity

Creates an IPsec rule that defines security requirements for network connections that match the specified criteria.

Syntax

New-NetIPsecRule
   [-PolicyStore <String>]
   [-GPOSession <String>]
   [-IPsecRuleName <String>]
   -DisplayName <String>
   [-Description <String>]
   [-Group <String>]
   [-Enabled <Enabled>]
   [-Profile <Profile>]
   [-Platform <String[]>]
   [-Mode <IPsecMode>]
   [-InboundSecurity <SecurityPolicy>]
   [-OutboundSecurity <SecurityPolicy>]
   [-QuickModeCryptoSet <String>]
   [-Phase1AuthSet <String>]
   [-Phase2AuthSet <String>]
   [-KeyModule <KeyModule>]
   [-AllowWatchKey <Boolean>]
   [-AllowSetKey <Boolean>]
   [-LocalTunnelEndpoint <String[]>]
   [-RemoteTunnelEndpoint <String[]>]
   [-RemoteTunnelHostname <String>]
   [-ForwardPathLifetime <UInt32>]
   [-EncryptedTunnelBypass <Boolean>]
   [-RequireAuthorization <Boolean>]
   [-User <String>]
   [-Machine <String>]
   [-LocalAddress <String[]>]
   [-RemoteAddress <String[]>]
   [-Protocol <String>]
   [-LocalPort <String[]>]
   [-RemotePort <String[]>]
   [-InterfaceAlias <WildcardPattern[]>]
   [-InterfaceType <InterfaceType>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The New-NetIPsecRule cmdlet creates a transport-mode or tunnel-mode IPsec rule and adds it to the target computer. Some parameters are used to specify the conditions that must be matched for the rule to apply, such as the LocalAddress and the RemoteAddress parameters. Other parameters specify the way that the connection should be secured, such as the InboundSecurity and the OutboundSecurity parameters. Rules that already exist can be managed with the Get-NetIPsecRule and Set-NetIPsecRule cmdlets.

In order for custom main mode and quick mode security negotiations to occur, appropriate authorization and cryptographic sets must be associated with the rule. See the New-NetIPsecPhase1AuthSet, New-NetIPsecPhase2AuthSet, and New-NetIPsecQuickModeCryptoSet cmdlets for more information.

Note: Each authentication or cryptographic set must be created in the policy store for the associated IPsec rule. If a particular set applies to multiple IPsec rules in different policy stores (GPOs), then the set must be duplicated for each of those stores (so that policies can be updated without linking issues). See the Copy-NetFirewallRule, Copy-NetIPsecMainModeCryptoSet, Copy-NetIPsecMainModeRule, Copy-NetIPsecPhase1AuthSet, Copy-NetIPsecPhase2AuthSet, and Copy-NetIPsecQuickModeCryptoSet cmdlets and this cmdlet for more information.

Examples

EXAMPLE 1

PS C:\>New-NetIPsecRule -DisplayName "Multi DTE" -Name "Multi DTE" -Mode Tunnel -InboundSecurity Require -OutboundSecurity Require -RemoteTunnelEndpoint 2002:9d3b::2, 2002:9d3b::3, 2002:9d3b::4 -RemoteAddress 2002:9d3b::/32 -LocalTunnelEndpoint Any

This example creates a multi dynamic tunnel end point rule.

EXAMPLE 2

PS C:\>New-NetIPsecRule -DisplayName "Domain Isolation Rule" -InboundSecurity Require -OutboundSecurity Request -PolicyStore contoso.com\Domain_Isolation

This example creates a rule that could be used in a domain isolation scenario, where incoming traffic is only permitted from other domain member computers. The default main mode negotiation uses Kerberos v5 for computer and user authentication.

EXAMPLE 3

PS C:\>$qMProposal = New-NetIPsecQuickModeCryptoProposal -Encapsulation ESP -ESPHash SHA1 -Encryption DES3



PS C:\>$qMCryptoSet = New-NetIPsecQuickModeCryptoSet -DisplayName "esp:sha1-des3" -Proposal $qMProposal



PS C:\>New-NetIPSecRule -DisplayName "Tunnel from HQ to Dallas Branch" -Mode Tunnel -LocalAddress 192.168.0.0/16 -RemoteAddress 192.157.0.0/16 -LocalTunnelEndpoint 1.1.1.1 -RemoteTunnelEndpoint 2.2.2.2 -InboundSecurity Require -OutboundSecurity Require -QuickModeCryptoSet $qMCryptoSet.Name

This example creates an IPsec tunnel that routes traffic from a private network at 192.168.0.0/16 through an interface on the local computer at 1.1.1.1 attached to a public network to a second computer through a public interface at 2.2.2.2 to another private network at 192.157.0.0/16. All traffic through the tunnel is integrity checked using ESP/SHA1, and encrypted using ESP/DES3.

EXAMPLE 4

This cmdlet illustrates how to include both AH and ESP protocols in a single suite.
PS C:\>$aHandESPQM = New-NetIPsecQuickModeCryptoProposal -Encapsulation AH,ESP -AHHash SHA1 -ESPHash SHA1 -Encryption DES3


This cmdlet illustrates how to specify the use of the AH protocol only.
PS C:\>$aHQM = New-NetipsecQuickModeCryptoProposal -Encapsulation AH -AHHash SHA1 -ESPHash None -Encryption None


This cmdlet illustrates how to specify the use of the ESP protocol only, and uses the None keyword to specify not to include an encryption option.
PS C:\>$eSPQM = New-NetIPsecQuickModeCryptoProposal -Encapsulation ESP -ESPHash SHA1 -Encryption None


This cmdlet illustrates how to use the None keyword to specify that ESP is used with an encryption protocol, but with no integrity protocol. This cmdlet also illustrates how to set a custom SA timeout using both time and data amount values.
PS C:\>$eSPnoAHQM = New-NetIPsecQuickModeCryptoProposal -Encapsulation ESP -ESPHash None -Encryption AES256 -MaxKiloBytes 50000 -MaxMinutes 30



PS C:\>$qMCryptoSet = New-NetIPsecQuickModeCryptoSet -DisplayName "Custom Quick Mode" -Proposal $aHandESPQM,$aHQM,$eSPQM,$eSPnoAHQM



PS C:\>New-NetIPsecRule -DisplayName "Domain Isolation Rule" -InboundSecurity Require Request -OutboundSecurity Request -QuickModeCryptoSet $qMCryptoSet.Name

This example creates a domain isolation rule, but uses a custom quick mode proposal that includes multiple quick mode suites, separated by commas.

Parameters

-AllowSetKey

Specifies that the IPsec rule allows trusted intermediaries to override keying material. When this parameter is set to True, then the trusted intermediaries are allowed to dictate the cryptographic keying material used with an IPsec security association (SA).

It is possible that when this parameter is set to True at both ends, the computers will perform arbitration through SA negotiation so that one end sets the key while the other end watches the key.

The default value is False.

This parameter is only supported on Windows Server® 2012.

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

-AllowWatchKey

Specifies that the IPsec rule allows trusted intermediaries to notify of changes in keying material. When this parameter is set to True, then the trusted intermediaries are allowed to retrieve the cryptographic keying material associated with an IPsec SA, and to subscribe for notification of changes.

The default value is False.

This parameter is only supported on Windows Server 2012.

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

-AsJob

ps_cimcommon_asjob

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-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

-Description

Specifies that matching firewall rules of the indicated description are created. Wildcard characters are accepted.

This parameter provides information about the firewall rule. This parameter specifies the localized, user-facing description of the IPsec rule.

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

-DisplayName

Specifies that only matching firewall rules of the indicated display name are created. Wildcard characters are accepted.

Specifies the localized, user-facing name of the firewall rule being created. When creating a rule this parameter is required. This parameter value is locale-dependent. If the object is not modified, this parameter value may change in certain circumstances. When writing scripts in multi-lingual environments, the IPsecRuleName parameter should be used instead, where the default value is a randomly assigned value. Note: This parameter cannot be set to All.

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

-Enabled

Specifies that matching main mode rules of the indicated state are created.

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. A disabled rule will not actively modify computer behavior, but the rule still exists on the computer so it can be re-enabled.

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

-EncryptedTunnelBypass

Indicates that matching IPsec rules of the specified value are created.

This parameter specifies the encapsulation state for network traffic sent to a tunnel end point that is already IPsec protected. If this parameter is set to True, then the network traffic sent to a tunnel end point that is already IPsec protected does not have to be encapsulated again. This option can improve network performance in the case where network traffic that is already end-to-end protected by other IPsec rules.

The default value is False.

This parameter is only supported on firstref_server_7 and Windows Server 2012.

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

-ForwardPathLifetime

Specifies that matching IPsec rules of the specified path lifetime value are created.

This parameter specifies the session key lifetime for an IPsec rule, in minutes. The acceptable values for this parameter are: 78 through 172799.

The default value is 0 minutes.

This parameter is only supported on Windows Server 2012.

When managing a GPO, the default setting is NotConfigured. This parameter is case sensitive and NotConfigured can only be specified using dot-notation.

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

-GPOSession

Specifies the network GPO from which to retrieve the rules to be created.

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

-Group

Specifies that only matching IPsec rules of the indicated group association are created. Wildcard characters are accepted.

This parameter specifies the source string for the DisplayGroup parameter. If the DisplayGroup parameter value is a localizable string, then this parameter contains an indirect string. Rule groups can be used to organize rules by influence and allows batch rule modifications. Using the Set-NetIPsecRule cmdlets, if the group name is specified for a set of rules or sets, then all of the rules or sets in that group receive the same set of modifications. It is good practice to specify this parameter value with a universal and world-ready indirect @FirewallAPI name. Note: The DisplayGroup parameter cannot be specified upon object creation using this cmdlet, but can be modified using dot-notation and the Set-NetIPsecRule cmdlet.

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

-InboundSecurity

Specifies that only matching IPsec rules of the indicated group association are created. Wildcard characters are accepted.

This parameter specifies the source string for the DisplayGroup parameter. If the DisplayGroup parameter value is a localizable string, then this parameter contains an indirect string. Rule groups can be used to organize rules by influence and allows batch rule modifications. Using the Set-NetIPsecRule cmdlets, if the group name is specified for a set of rules or sets, then all of the rules or sets in that group receive the same set of modifications. It is good practice to specify this parameter value with a universal and world-ready indirect @FirewallAPI name. Note: The DisplayGroup parameter cannot be specified upon object creation using this cmdlet, but can be modified using dot-notation and the Set-NetIPsecRule cmdlet.

Type:SecurityPolicy
Aliases:SecIn
Accepted values:None, Request, Require
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InterfaceAlias

Specifies the alias of the interface that applies to the traffic. Note: Querying for rules with this parameter can only be performed using filter objects. See the Get-NetFirewallInterfaceFilter cmdlet for more information.

Type:WildcardPattern[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InterfaceType

Specifies that only network connections made through the indicated interface types are subject to the requirements of this rule. This parameter specifies different authentication requirements for each of the three main network types. The acceptable values for this parameter are: Any, Wired, Wireless, or RemoteAccess.

The default value is Any. Note: Querying for rules with this parameter can only be performed using filter objects. See the Get-NetFirewallInterfaceTypeFilter cmdlet for more information.

Type:InterfaceType
Accepted values:Any, Wired, Wireless, RemoteAccess
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-IPsecRuleName

Specifies Indicates that only matching main mode cryptographic sets of the indicated name are created. Wildcard characters are accepted.

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. During group policy processing and policy merge, rules that have the same name but come from multiple stores being merged, will overwrite one another so that only one exists. This overwriting behavior is desirable if the rules serve the same purpose. For instance, all of the firewall rules have specific names, so if an administrator can copy these rules to a GPO, and the rules will override the local versions on a local computer. GPOs can have precedence. So, if an administrator has a different or more specific rule the same name in a higher-precedence GPO, then it overrides other rules that exist.

The default value is a randomly assigned value.

To override the defaults for main mode encryption, specify the customized parameters and set this parameter value, making this parameter the new default setting for encryption.

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

-KeyModule

Specifies that matching IPsec rules of the indicated key module are created.

This parameter specifies which keying modules to negotiate. The acceptable values for this parameter are: Default, AuthIP, IKEv1, or IKEv2.

-- Default: Equivalent to both IKEv1 and AuthIP. Required in order for the rule to be applied to computers running Windows versions prior to Windows Server 2008 R2.

---- Note: There are authorization and cryptographic methods that are only compatible with certain keying modules. This is a very advanced setting intended only for specific interoperability scenarios. Overriding this parameter value may result in traffic being sent in plain-text if the authentication and cryptographic settings are not supported by the keying modules there.

-- AuthIP: Supported with phase 2 authentication.

-- IKEv1: Supported with pre-shared key (PSK), Certificates, and Kerberos.

-- IKEv2: Not supported with Kerberos, PSK, or NT LAN Manager (NTLM). Note: Windows versions prior to Windows Server 2012 only support the Default configuration.

Type:KeyModule
Accepted values:Default, IKEv1, AuthIP, IKEv2
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-LocalAddress

Specifies that network packets with matching IP addresses match this rule.

This parameter value is the first end point of an IPsec rule and specifies the computers that are subject to the requirements of this rule.

This parameter value is an IPv4 or IPv6 address, host name, subnet, range, or the following keyword: Any.

The acceptable formats for this parameter are:

-- Single IPv4 Address: 1.2.3.4

-- Single IPv6 Address: fe80::1

-- IPv4 Subnet (by network bit count): 1.2.3.4/24

-- IPv6 Subnet (by network bit count): fe80::1/48

-- IPv4 Subnet (by network mask): 1.2.3.4/255.255.255.0

-- IPv4 Range: 1.2.3.4 through 1.2.3.7

-- IPv6 Range: fe80::1 through fe80::9 Note: Querying for rules with this parameter can only be performed using filter objects. See the Get-NetFirewallAddressFilter cmdlet for more information.

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

-LocalPort

Specifies that network packets with matching IP port numbers match this rule. This parameter value is the first end point of an IPsec rule.

The acceptable value is a port, range, or keyword and depends on the protocol.

If the Protocol parameter value is TCP or UDP, then the acceptable values for this parameter are:

-- Port range: 0 through 65535.

-- Port number: 80.

-- Keyword: Any.

If the Protocol parameter value is ICMPv4 or ICMPv6, then the acceptable values for this parameter are:

-- An ICMP type, code pair: 0, 8.

-- Type and code: 0 through 255.

-- Keyword: Any.

If the Protocol parameter is not specified, then the acceptable values for this parameter are: Any, RPC, RPC-EPMap, or IPHTTPS. Note: Port ranges are only allowed in IPsec rules when the rule type is Do Not Secure. Do Not Secure rules are the InboundSecurity parameter set to None and the OutboundSecurity parameter set to None. Note: IPHTTPS is only supported on Windows Server 2012. Note: Querying for rules with this parameter can only be performed using filter objects. See the Get-NetFirewallPortFilter cmdlet for more information.

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

-LocalTunnelEndpoint

Specifies the IP address of the computer or gateway device that sends traffic from computers that match the LocalAddress parameter value to computers that match the RemoteAddress parameter value. The traffic is being secured from this IP address to the device identified in the RemoteTunnelEndpoint parameter. This parameter value must use the same type of IP address as the RemoteTunnelEndpoint parameter, which is either IPv4 or IPv6.

This parameter is required and valid only for tunnel mode rules.

Address keywords are not supported.

In firstref_client_7, Windows Server 2008 R2, and Windows Server 2012, this value can also be Any. When applied to a client computer, this option supports connection via a tunnel to a remote gateway or host regardless of the IP address or address type of the local computer.

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

-Machine

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.

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

-Mode

Specifies the type of IPsec mode connection that the IPsec rule defines. The acceptable values for this parameter are: None, Transport, or Tunnel.

The default value is Transport.

Type:IPsecMode
Accepted values:None, Tunnel, Transport
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-OutboundSecurity

Specifies that matching IPsec rules of the indicated security policy are created.

This parameter determines the degree of enforcement for security on outbound traffic. The acceptable values for this parameter are:

-- None: No authentication is requested or required for connections that match the rule. It specifies that the local computer does not attempt authentication for any network connections that match this rule. This option is typically used to grant IPsec exemptions for network connections that do not need to be protected by IPsec, but would otherwise match other rules that could cause the connection to be dropped.

-- Request: Authentication is requested for connections that match the rule. The local computer attempts to authenticate any outbound network connections that match this rule, but allows the connection if the authentication attempt fails.

-- Require: Authentication is required for connections that match the rule. If the authentication is not successful, then the outbound network traffic is discarded.

The default value is None.

When the InboundSecurity parameter is also specified, the following configurations are valid: InboundSecurity/OutboundSecurity = None\None, Request\None, Request\Request, Require\Request, or Require\Require.

Type:SecurityPolicy
Aliases:SecOut
Accepted values:None, Request, Require
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Phase1AuthSet

Gets the main mode rules that are associated with the given phase 1 authentication set to be created.

This parameter specifies, by name, the Phase 1 authentication set to be associated with the main mode rule.

A NetIPsecPhase1AuthSet object represents the phase 1 authentication conditions associated with an IPsec or main mode rule. This parameter sets the methods for main mode negotiation by describing the proposals for computer authentication. See the New-NetIPsecAuthProposal cmdlet of more information.

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

-Phase2AuthSet

Gets the IPsec rules that are associated with the given phase 2 authentication set to be created.

A NetIPsecPhase2AuthSet object represents the phase 2 authorization set conditions associated with an IPsec or main mode rule. This parameter sets the methods for main mode negotiation by describing the proposals for computer authentication. See the Get-NetIPsecPhase2AuthSet cmdlet for more information.

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

-Platform

Specifies which version of Windows the associated rule applies.

The acceptable format for this parameter is a number in the Major.Minor format.

The version number of 6.0 corresponds to Vista (firstref_vista), 6.1 corresponds to Win7 (Windows® 7 or Windows Server 2008 R2), and 6.2 corresponds to Win8 (Windows® 8 or Windows Server 2012).

If + is not specified, then only that version is associated.

If + is specified, then that version and later are associated. Note: Querying for rules with this parameter with the Get-NetIPsecRule cmdlet cannot be performed.

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

-PolicyStore

Specifies the policy store from which to retrieve the rules to be created.

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-NetIPsecRule 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-NetIPsecRule cmdlet or with this cmdlet.

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

-Profile

Specifies one or more profiles to which the rule is assigned. The rule is active on the local computer only when the specified profile is currently active. This relationship is many-to-many and can be indirectly modified by the user, by changing the Profiles field on instances of firewall rules. Only one profile is applied at a time. The acceptable values for this parameter are: Any, Domain, Private, Public, or NotApplicable.

The default is Any.

Separate multiple entries with a comma and do not include any spaces. Note: Use the keyword Any to configure the profile as Private, Public, Domain in the ConfigurableServiceStore.

Type:Profile
Accepted values:Any, Domain, Private, Public, NotApplicable
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Protocol

Specifies that network packets with matching IP addresses match this rule. This parameter specifies the protocol for an IPsec rule. The acceptable values for this parameter are:

-- Protocols by number: 0 through 255.

-- Protocols by name: TCP, UDP, ICMPv4, or ICMPv6.

If a port number is identified by using port1 or port2, then this parameter must be set to TCP or UDP.

The values ICMPv4 and ICMPv6 create a rule that exempts ICMP network traffic from the IPsec requirements of another rule.

The default value is Any. Note: Querying for rules with this parameter can only be performed using filter objects. See the Get-NetFirewallPortFilter cmdlet for more information.

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

-QuickModeCryptoSet

Specifies that matching IPsec rules of the specified quick mode cryptographic set are retrieved.

This parameter specifies the quick mode cryptographic set to be associated with the IPsec rule.

A NetIPsecMainModeCryptoSet object represents quick mode cryptographic conditions associated with an IPsec rule. This parameter sets the methods for quick mode negotiation by describing the proposals for encryption. See the New-NetIPsecQuickModeCryptoSet cmdlet for more information.

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

-RemoteAddress

Specifies that network packets with matching IP addresses match this rule.

This parameter value is the second end point of an IPsec rule and specifies the computers that are subject to the requirements of this rule.

This parameter value is an IPv4 or IPv6 address, host name, subnet, range, or the following keyword: Any.

The acceptable formats for this parameter are:

-- Single IPv4 Address: 1.2.3.4

-- Single IPv6 Address: fe80::1

-- IPv4 Subnet (by network bit count): 1.2.3.4/24

-- IPv6 Subnet (by network bit count): fe80::1/48

-- IPv4 Subnet (by network mask): 1.2.3.4/255.255.255.0

-- IPv4 Range: 1.2.3.4 through 1.2.3.7

-- IPv6 Range: fe80::1 through fe80::9 Note: Querying for rules with this parameter can only be performed using filter objects. See the Get-NetFirewallAddressFilter cmdlet for more information.

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

-RemotePort

Specifies that network packets with matching IP port numbers match this rule. This parameter value is the second end point of an IPsec rule. The acceptable value is a port, range, or keyword and depends on the protocol.

If the protocol is TCP or UDP, then the acceptable values for this parameter are:

-- Port range: 0 through 65535

-- Port number: 80

-- Keyword: Any

If the protocol is ICMPv4 or ICMPv6, then the acceptable values for this parameter are:

-- An ICMP type, code pair: 0, 8

-- Type and code: 0 through 255

-- Keyword: Any.

If a protocol is not specified, then the acceptable values for this parameter are: Any, RPC, RPC-EPMap, or IPHTTPS. Note: IPHTTPS is only supported on Windows Server 2012. Note: Querying for rules with this parameter can only be performed using filter objects. See the Get-NetFirewallPortFilter cmdlet for more information.

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

-RemoteTunnelEndpoint

Specifies the IP address of the computer or gateway device that secures traffic from computers that match the LocalAddress parameter value to computers that match the RemoteAddress parameter value. The traffic is being secured to this IP address to the device identified in the LocalTunnelEndpoint parameter. This parameter value must use the same type of IP address as the LocalTunnelEndpoint parameter, which is either IPv4 or IPv6.

Address keywords are not supported.

On Windows® 7, Windows Server 2008 R2, and Windows Server 2012, this value can also be Any. When applied to a client computer, this option supports connection via a tunnel to a remote gateway or host regardless of the IP address or address type of the local computer.

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

-RemoteTunnelHostname

Specifies that matching IPsec rules of the specified second end point tunnel host name are created.

Specifies a fully qualified DNS name that resolves to a list of remote tunnel end points.

This parameter is only supported on Windows Server 2012. Note: This parameter can only be used with multiple remote tunnel end points. Specifying this parameter prevents a non-asymmetric tunnel mode IPsec rule from being created. Rule creation will fail when a single remote tunnel end point and this parameter are specified, or when RemoteTunnelEndpoint parameter is set to Any and this parameter is specified.

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

-RequireAuthorization

Indicates that matching IPsec rules of the specified value are created.

Specifies the given value for an IPsec rule.

If this parameter is set to True, then enforcement of authorization is allowed for end points.

This parameter is only supported on Windows Server 2008 R2 and Windows Server 2012.

Type:Boolean
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

-User

Specifies that matching IPsec rules of the indicated user accounts are created.

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 match this rule. This parameter value is specified as an SDDL string.

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

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.