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
 

Add-RemoteAccessIpFilter

Add-RemoteAccessIpFilter

ps_ipfilter_v1.0.cdxml

Synopsis

Adds filters for traffic that passes through an interface.

Syntax

Add-RemoteAccessIpFilter [-InterfaceAlias] [-AddressFamily] [-Direction] [-Action] [-List] [-AsJob] [-CimSession] [-PassThru] [-ThrottleLimit] [-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 <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

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

-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


Return Type

Microsoft.Management.Infrastructure.CimInstance#InterfaceIpFilter[]

Notes

None

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


InterfaceAlias   : Interface1
Direction        : outbound
Ipv4FilterAction : Allow
Ipv4Filters      : {10.0.0.0/16:10.2.0.0/16:tcp:1234:4321}
Ipv6FilterAction :
Ipv6Filters      :


Online Version
Get-RemoteAccessIpFilter
Remove-RemoteAccessIpFilter
Set-RemoteAccessIpFilter