Table of contents
TLS
TOC
Collapse the table of content
Expand the table of content

Find-NetIPsecRule

Brian Lich|Last Updated: 3/31/2017

SYNOPSIS

Gets IPsec rules that match specified criteria.

SYNTAX

Find-NetIPsecRule [-LocalAddress <String>] -RemoteAddress <String> [-Protocol <String>] [-LocalPort <UInt16>]
 [-RemotePort <UInt16>] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [<CommonParameters>]

DESCRIPTION

The Find-NetIPsecRule cmdlet gets IPsec rules that match the criteria that you specify.

EXAMPLES

Example 1: Get an IPSec rule

PS C:\>Find-NetIPsecRule -RemoteAddress "131.107.33.200" -Protocol "TCP" -RemotePort 80
IPsecRuleName         : {c1988b9c-9546-4eea-bf64-fbe85ddbef8c}
DisplayName           : External Traffic - Attempt IPsec
Description           : 
DisplayGroup          : Protection for Internet Traffic
Group                 : Protection for Internet Traffic
Enabled               : True
Profile               : Domain
Platform              : {6.2+}
Mode                  : Transport
InboundSecurity       : Require
OutboundSecurity      : Request
QuickModeCryptoSet    : Msit-Qm-EspAes128Sha1-Or-AhSha1
Phase1AuthSet         : Msit-Mm-Kerb-Or-CorpCertMap
Phase2AuthSet         : Msit-Em-Kerb
KeyModule             : Default
AllowWatchKey         : False
AllowSetKey           : False
LocalTunnelEndpoint   : 
RemoteTunnelEndpoint  : 
RemoteTunnelHostname  : 
ForwardPathLifetime   : 0
EncryptedTunnelBypass : False
RequireAuthorization  : False
User                  : 
PrimaryStatus         : OK
Status                : The rule was parsed successfully from the store. (65536) 
EnforcementStatus     : NotApplicable
PolicyStoreSource     : 
PolicyStoreSourceType : GroupPolicy

This command finds the IPsec rule that the system uses for conventional web traffic to the specified IP address. The command gets the IPSec rule that matches the TCP connection that has the remote address 131.107.33.200 and that uses the remote port 80. The command returns a WMIv2 IPsec rule object.

PARAMETERS

-AsJob

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

Type: SwitchParameter
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
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[]
Parameter Sets: (All)
Aliases: Session

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

-LocalAddress

Specifies the local IP address of a connection. The cmdlet gets the IPSec rules that are matched to the IP address that you specify. This parameter value is the first end point of an IPsec rule and specifies the computers that are subject to the requirements of the rule. The acceptable values 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
Type: String
Parameter Sets: (All)
Aliases: 

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

-LocalPort

Specifies the local port of the connection. The cmdlet gets the IPSec rules that are matched to the IP port number that you specify. This parameter value is the first end point of an IPsec rule. The acceptable values for this parameter are:a port, range, and keyword. The value depends on the protocol.

Protocol is TCP or UDP. The acceptable values for this parameter are:

  • Port range: 0 through 65535
  • Port number: 80
  • Keyword: Any

Protocol is ICMPv4 or ICMPv6. The acceptable values for this parameter are:

  • An ICMP type, code pair: 0, 8
  • Type and code: 0 through 255
  • Keyword: Any

No protocol is set. The acceptable values for this parameter are:

  • Any
  • RPC
  • RPC-EPMap
  • IPHTTPS

IPHTTPS is supported only on Windows Server 2012.

Type: UInt16
Parameter Sets: (All)
Aliases: 

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

-Protocol

Specifies the protocol for an IPSec rule. The cmdlet gets the IPSec rules that use the protocol that you specify for the connection. 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, you must specify TCP or UDP for this parameter. The values ICMPv4 and ICMPv6 create a rule that exempts ICMP network traffic from the IPsec requirements of another rule.

Type: String
Parameter Sets: (All)
Aliases: 

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

-RemoteAddress

Specifies the remote address of the TCP connection. The cmdlet gets the IPSec rules that are matched the IP address that you specify. This parameter value is the second end point of an IPsec rule and specifies the computer that is subject to the requirements of the rules.

The acceptable values for this parameter are: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
Type: String
Parameter Sets: (All)
Aliases: 

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

-RemotePort

Specifies the remote port of the TCP connection. The cmdlet gets the IPSec rules that are matched to the remote port number that you specify. This parameter value is the second end point of an IPsec rule. The acceptable values for this parameter are:a port, range, and keyword. The value depends on the protocol.

Protocol is TCP or UDP. The acceptable values for this parameter are:

  • Port range: 0 through 65535
  • Port number: 80
  • Keyword: Any

Protocol is ICMPv4 or ICMPv6. The acceptable values for this parameter are:

  • An ICMP type, code pair: 0, 8
  • Type and code: 0 through 255
  • Keyword: Any.

No protocol is set. The acceptable values for this parameter are:

  • Any
  • RPC
  • RPC-EPMap
  • IPHTTPS.

IPHTTPS is supported only on Windows Server 2012.

Type: UInt16
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
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
Parameter Sets: (All)
Aliases: 

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

IPsecRule

NOTES

Get-NetIPsecRule

Set-NetIPsecRule

New-NetIPsecRule

Show-NetIPsecRule

Enable-NetIPsecRule

Disable-NetIPsecRule

Sync-NetIPsecRule

Rename-NetIPsecRule

Remove-NetIPsecRule

Copy-NetIPsecRule

Update-NetIPsecRule

© 2017 Microsoft