[This topic is in progress.]

Applies to: Exchange Server 2010 SP3, Exchange Server 2010 SP2

Topic Last Modified: 2011-05-03

Use the Add-IPAllowListProvider cmdlet to create a new IP Allow list provider configuration on the computer that has the Edge Transport server role or the Hub Transport server role installed.

Syntax

Add-IPAllowListProvider -Name <String> -LookupDomain <SmtpDomain> [-AnyMatch <$true | $false>] [-BitmaskMatch <IPAddress>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-Enabled <$true | $false>] [-IPAddressesMatch <MultiValuedProperty>] [-Priority <Int32>] [-WhatIf [<SwitchParameter>]]

Detailed Description

The IP Allow list provider configuration is used by the Connection Filter agent.

You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "Anti-spam features" entry in the Transport Permissions topic.

Parameters

Parameter Required Type Description

LookupDomain

Required

Microsoft.Exchange.Data.SmtpDomain

The LookupDomain parameter specifies the domain name that the Connection Filter agent queries for updated IP Allow list data.

Name

Required

System.String

The Name parameter specifies the name of the IP Allow list provider service.

AnyMatch

Optional

System.Boolean

The AnyMatch parameter specifies whether the Connection Filter agent treats any IP address status code returned by the IP Allow list provider service as a match. Valid input for the AnyMatch parameter is $true or $false. The default setting is $false. When the AnyMatch parameter is set to $true, the Connection Filter agent treats any IP address status code returned by the IP Allow list provider service as a match.

BitmaskMatch

Optional

System.Net.IPAddress

The BitmaskMatch parameter specifies the IP address status code bit mask. When you configure the BitmaskMatch parameter to use an IP address, the Connection Filter agent acts only on messages that match the IP address status code returned by the IP Allow list provider service.

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You don't have to specify a value with the Confirm switch.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory. The DomainController parameter isn't supported on the Edge Transport server role. The Edge Transport server role writes only to the Active Directory Lightweight Directory Services (AD LDS) instance.

Enabled

Optional

System.Boolean

The Enabled parameter specifies whether the Connection Filter agent queries this IP Allow list provider service according to the priority set for this IP Allow list provider configuration. Valid input for the Enabled parameter is $true or $false. The default setting is $true. When the Enabled parameter is set to $true, the Connection Filter agent queries the IP Allow list provider service according to the priority set for this IP Allow list provider configuration.

IPAddressesMatch

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The IPAddressesMatch parameter specifies an IP address status code that the Connection Filter agent uses to compare to the IP address status code returned by the IP Allow list provider service. When you configure an IP address for the IPAddressesMatch parameter, the Connection Filter agent acts only on messages that match the IP address status code returned by the IP Allow list provider service.

Priority

Optional

System.Int32

The Priority parameter specifies the order that the Connection Filter agent queries the IP Allow list provider services that you have configured. By default, every time that you add a new IP Allow list provider service, the entry is assigned a priority of N+1, where N is the number of IP Allow list provider services that you have configured.

If you set the Priority parameter to a value that's the same as another IP Allow list provider service, the priority of the IP Allow list provider service that you add first is incremented by 1.

WhatIf

Optional

System.Management.Automation.SwitchParameter

The WhatIf switch instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, you can view what changes would occur without having to apply any of those changes. You don't have to specify a value with the WhatIf switch.

Input Types

To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.

Return Types

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.

Examples

EXAMPLE 1

This example adds a new IP Allow list provider and configures the Connection Filter agent to treat any IP address status code returned from the IP Allow list provider as a match and allow the connection.

Copy Code
Add-IPAllowListProvider -Name Contoso -LookupDomain Fabrikam.com -AnyMatch $true