Add-RemoteAccessIpFilter
Add-RemoteAccessIpFilter
Adds filters for traffic that passes through an interface.
Syntax
Parameter Set: Add0
Add-RemoteAccessIpFilter [-InterfaceAlias] <String> [-AddressFamily] <AddressFamily> [-Direction] <Direction> [-Action] <Action> [-List] <String[]> [-AsJob] [-CimSession <CimSession[]> ] [-PassThru] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Add-RemoteAccessIpFilter cmdlet adds IP filters for traffic that passes through an interface. A filter specifies the types of traffic to allow into or out of a Routing and Remote Access Service (RRAS) server.
You can set packet filters for an interface and configure the filters to do one of the following actions:
-- Allow. Allow all traffic except for packets that are prohibited by filters.
-- Deny. Discard all traffic except for packets that are allowed by filters.
Parameters
-Action<Action>
Specifies an action for a filter.
Aliases |
FilterAction |
Required? |
true |
Position? |
5 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue, ByPropertyName) |
Accept Wildcard Characters? |
false |
-AddressFamily<AddressFamily>
Specifies an IP address family on which to filter.
Aliases |
none |
Required? |
true |
Position? |
3 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue, ByPropertyName) |
Accept Wildcard Characters? |
false |
-AsJob
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 |
-Direction<Direction>
Specifies the direction of traffic flow, such as inbound, outbound, or both.
Aliases |
none |
Required? |
true |
Position? |
4 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue, ByPropertyName) |
Accept Wildcard Characters? |
false |
-InterfaceAlias<String>
Specifies an alias for the interface on which to add filters.
Aliases |
Name |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue, ByPropertyName) |
Accept Wildcard Characters? |
false |
-List<String[]>
Specifies an array of filters to apply. Use the format SourceIP/Subnet:DestinationIP/Subnet:Protocol:ProtocolData1:ProtocolData2, such as 10.0.0.0/16:10.1.2.3/16:TCP:1234:2345. If the protocol is TCP or UDP, ProtocolData1 and ProtocolData2 are source and destination port numbers, respectively. If the protocol is ICMP, ProtocolData1 is Code.
Aliases |
none |
Required? |
true |
Position? |
6 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue, ByPropertyName) |
Accept Wildcard Characters? |
true |
-PassThru
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 |
-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
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
- Microsoft.Management.Infrastructure.CimInstance#InterfaceIpFilter[]
Examples
Example 1: Add a new IP address filter
This command adds a new IP address filter for traffic passing through an interface named Interface01.
PS C:\> Add-RemoteAccessIpFilter -InterfaceAlias Interface01 -Action Allow -List @("10.0.0.0/16:10.2.0.0/16:TCP:1234:4321") -Direction Outbound -AddressFamily IPv4 -Passthru