Applies to: Exchange Server 2010 SP3, Exchange Server 2010 SP2
Topic Last Modified: 2011-05-03
Use the Add-IPBlockListProvider cmdlet to create an IP Block List provider configuration on the computer that has the Edge Transport server role or the Hub Transport server role installed.
Syntax
Add-IPBlockListProvider -Name <String>
-LookupDomain <SmtpDomain> [-AnyMatch <$true | $false>]
[-BitmaskMatch <IPAddress>] [-Confirm
[<SwitchParameter>]] [-DomainController <Fqdn>]
[-Enabled <$true | $false>] [-IPAddressesMatch
<MultiValuedProperty>] [-Priority <Int32>]
[-RejectionResponse <AsciiString>] [-WhatIf
[<SwitchParameter>]]
|
Detailed Description
The IP Block 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 Block List data. |
Name |
Required |
System.String |
The Name parameter specifies the name of the IP Block 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
Block List provider service as a match. Valid input for the
AnyMatch parameter is |
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 status code, the Connection Filter agent acts only on messages that match the 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 this IP Block List provider service according
to the priority set for this IP Block List provider configuration.
Valid input for the Enabled parameter is |
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 the IPAddressesMatch parameter is configured to use an IP address, the Connection Filter agent acts only on messages that match the same IP address status code returned by the IP Block List provider service. |
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 that 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 that you have configured. If you set the Priority parameter to a value that's the same as another IP Block List provider service, the priority of the IP Block List provider that you add first 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 can contact the
IP Block List 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, |
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 an IP Block List provider and sets a rejection response.
Copy Code | |
---|---|
Add-IPBlockListProvider -Name NewIpBlockListProvider -LookupDomain Contoso.com -RejectionResponse "Originating IP address matched to Contoso.com's IP Block List provider service" |
EXAMPLE 2
This example adds an IP Block List provider and configures a bitmask return value from the provider.
Copy Code | |
---|---|
Add-IPBlockListProvider -Name NewIpBlockListProvider -LookupDomain Contoso.com -BitmaskMatch 127.1.0.1 |