[This topic is in progress.]

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

Topic Last Modified: 2011-05-07

Use the Set-IPBlockListProvider cmdlet to modify the configuration information for a specific IP Block list provider on a computer that has the Edge Transport server role or the Hub Transport server role installed.

Syntax

Set-IPBlockListProvider -Identity <IPBlockListProviderIdParameter> [-AnyMatch <$true | $false>] [-BitmaskMatch <IPAddress>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-Enabled <$true | $false>] [-IPAddressesMatch <MultiValuedProperty>] [-LookupDomain <SmtpDomain>] [-Name <String>] [-Priority <Int32>] [-RejectionResponse <AsciiString>] [-WhatIf [<SwitchParameter>]]

Detailed Description

The Set-IPBlockListProvider cmdlet modifies existing IP Block list provider configurations. This configuration is used by the Connection Filter agent. The Connection Filter agent acts on the IP address of the remote server that initiates the SMTP connection to determine what action, if any, to take on an incoming message.

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

Identity

Required

Microsoft.Exchange.Configuration.Tasks.IPBlockListProviderIdParameter

The Identity parameter specifies the name or GUID of the IP Block list provider.

AnyMatch

Optional

System.Boolean

The AnyMatch parameter specifies whether the Connection Filter agent treats any IP address status code returned by the IP Block list provider service as a match. Valid input for the Enabled 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 Block 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 an IP address for the BitmaskMatch parameter, the Connection Filter agent acts only on messages that match the same IP address status code returned by the IP Block 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 the IP Block list provider service according to the priority set for this IP Block 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 Block list provider service according to the priority set for this IP Block 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 Block list provider service. When you configure IP address responses for the IPAddressesMatch parameter, the Connection Filter agent acts only on messages for which the IP address status code returned by the IP Block list provider service matches the listed IP address responses.

LookupDomain

Optional

Microsoft.Exchange.Data.SmtpDomain

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

Name

Optional

System.String

The Name parameter specifies the name of the IP Block list provider service. The string value for the Identity parameter doesn't change if you change this value.

Priority

Optional

System.Int32

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

If you set the Priority parameter to a value that's the same as another IP Block list provider, the other IP Block list provider is incremented by 1.

RejectionResponse

Optional

Microsoft.Exchange.Data.AsciiString

The RejectionResponse parameter specifies a string. Enter the message body that you want delivered in the SMTP session to senders whose messages are blocked by the Connection Filter agent when an IP Block list provider service matches the sender's IP address. We recommend that you specify the IP Block list provider service in the response so that legitimate senders contact the provider service. The argument can't exceed 240 characters. When you pass an argument, you must enclose the RejectionResponse parameter in quotation marks (") if the phrase contains spaces, for example: "Originating IP addresses matched to Contoso.com IP Block list provider service".

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 configures the Connection Filter agent to block an IP address if any IP address status codes are returned by the IP Block list provider Contoso.com.

Copy Code
Set-IPBlockListProvider -Identity Contoso.com -AnyMatch $true 

EXAMPLE 2

This example sets the priority of the IP Block list provider Contoso.com to 1.

Copy Code
Set-IPBlockListProvider -Identity Contoso.com -Priority 1