Set-IPBlockListProvider (RTM)
Microsoft Exchange Server 2007 will reach end of support on April 11, 2017. To stay supported, you will need to upgrade. For more information, see Resources to help you upgrade your Office 2007 servers and clients.
Applies to: Exchange Server 2007
Use the Set-IPBlockListProvider cmdlet to modify the configuration information for a specific IP Block List provider configuration 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>] [-DomainController <Fqdn>] [-Enabled <$true | $false>] [-IPAddressesMatch <MultiValuedProperty>] [-LookupDomain <SmtpDomain>] [-Name <String>] [-Priority <Int32>] [-RejectionResponse <AsciiString>]
Set-IPBlockListProvider [-AnyMatch <$true | $false>] [-BitmaskMatch <IPAddress>] [-DomainController <Fqdn>] [-Enabled <$true | $false>] [-Instance <IPBlockListProvider>] [-IPAddressesMatch <MultiValuedProperty>] [-LookupDomain <SmtpDomain>] [-Name <String>] [-Priority <Int32>] [-RejectionResponse <AsciiString>]
Detailed Description
Use the Set-IPBlockListProvider cmdlet to modify existing IP Block List provider configurations. This configuration is used by the Connection Filter agent. The Identity parameter is required.
To run the Set-IPBlockListProvider cmdlet, the account you use must be delegated the following:
- Exchange Server Administrator role and local Administrators group for the target server
To run the Set-IPBlockListProvider cmdlet on a computer that has the Edge Transport server role installed, you must log on by using an account that is a member of the local Administrators group on that computer.
For more information about permissions, delegating roles, and the rights that are required to administer Microsoft Exchange Server 2007, see Permission Considerations.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Identity |
Required |
Microsoft.Exchange.Configuration.Tasks.IPBlockListProviderIdParameter |
The Identity parameter can take a string value, which is the Name value, or the GUID. |
AnyMatch |
Optional |
System.Boolean |
Valid input for the Enabled parameter is |
BitmaskMatch |
Optional |
System.Net.IPAddress |
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 that is returned by the IP Block List provider service. |
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
To specify the fully qualified domain name of the domain controller that writes this configuration change to the Active Directory directory service, include the DomainController parameter on the command. The DomainController parameter is not supported on computers that run the Edge Transport server role. The Edge Transport server role writes only to the local ADAM instance. |
Enabled |
Optional |
System.Boolean |
Valid input for the Enabled parameter is |
Instance |
Optional |
Microsoft.Exchange.Data.Directory.SystemConfiguration.IPBlockListProvider |
The Instance parameter lets you to pass an entire object to the command to be processed. It is mainly used in scripts where an entire object must be passed to the command. |
IPAddressesMatch |
Optional |
Microsoft.Exchange.Data.MultiValuedProperty |
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 that is returned by the IP Block List provider service. |
LookupDomain |
Optional |
Microsoft.Exchange.Data.SmtpDomain |
This parameter specifies the domain name that the Connection Filter agent queries for updated IP Block list data. |
Name |
Optional |
System.String |
This parameter specifies the name of the IP Block List provider service. The string value for the Identity parameter does not change if you change this value. |
Priority |
Optional |
System.Int32 |
Set the Priority parameter to configure 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 you have configured. If you set the Priority parameter to a value that is 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 takes 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 cannot exceed 240 characters. When you pass an argument, you must enclose the RejectionResponse parameter in double quotation marks if the phrase contains spaces as follows, for example: |
Input Types
Return Types
Errors
| Error | Description |
|---|---|
|
Example
The following code examples shows two Set-IPBlockListProvider commands.
The first code example shows a Set-IPBlockListProvider command that sets the Connection Filter to treat any match by the IP Block List provider service as an actionable event.
The second code example shows a Set-IPBlockListProvider command that sets the priority of an existing configuration to 1.
Set-IPBlockListProvider -Identity Example.com -AnyMatch:$true
Set-IPBlockListProvider -Identity Example.com -Priority 1