Applies to: Exchange Server 2007 SP3, Exchange Server 2007 SP2, Exchange Server 2007 SP1
Topic Last Modified: 2007-06-28

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

Syntax


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


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

Parameters

Parameter	Required	Type	Description
Identity	Required	Microsoft.Exchange.Configuration.Tasks.IPAllowListProviderIdParameter	The Identity parameter can take a string value, which is the Name value, or the GUID.
AnyMatch	Optional	System.Boolean	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 that is returned by the IP Allow List provider service as a match.
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 IP Address status code that is returned by the IP Allow List provider service.
Confirm	Optional	System.Management.Automation.SwitchParameter	The Confirm parameter 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 parameter.
DomainController	Optional	Microsoft.Exchange.Data.Fqdn	To specify which domain controller writes this configuration change for the connection filtering configuration data to the Active Directory directory service, include the DomainController parameter on the command. If you are running this command on a computer that has the Edge Transport server role installed, the DomainController parameter is not supported. The Edge Transport server writes only to the local ADAM instance.
Enabled	Optional	System.Boolean	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 that is set for this IP Allow List provider configuration.
Instance	Optional	Microsoft.Exchange.Data.Directory.SystemConfiguration.IPAllowListProvider	The Instance parameter enables 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 Allow List provider service.
LookupDomain	Optional	Microsoft.Exchange.Data.SmtpDomain	The domain name that the Connection Filter agent queries for updated IP Allow list data.
Name	Optional	System.String	The name of the IP Allow 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 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 you have configured. If you set the Priority parameter to a value that is the same as another IP Allow List provider service, the priority of the IP Allow List provider service that you added first is incremented by 1.
WhatIf	Optional	System.Management.Automation.SwitchParameter	The WhatIf parameter instructs the command to simulate the actions that it would take on the object. By using the WhatIf parameter, 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 parameter.

Detailed Description

Use the Set-IPAllowListProvider cmdlet to modify existing IP Allow List provider configurations. This configuration is used by the Connection Filter agent. The Identity parameter is required.

To run the Set-IPAllowListProvider 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-IPAllowListProvider 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.

Input Types

Return Types

Errors

Error	Description

Example

The first code example shows a Set-IPAllowListProvider command that sets the Connection Filter to treat any match by the IP Allow List provider service as an actionable event.

The second code example shows a Set-IPAllowListProvider command that sets the priority of an existing configuration to 1.

	Copy Code
Set-IPAllowListProvider -Identity Example.com -AnyMatch:$true Set-IPAllowListProvider -Identity Example.com -Priority 1