Export (0) Print
Expand All

Add-IPAllowListProvider

 

Applies to: Exchange Server 2007 SP3, Exchange Server 2007 SP2, Exchange Server 2007 SP1

Topic Last Modified: 2007-06-22

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.


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

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

The Name parameter and the LookupDomain parameter are required. If you do not pass the required parameters, the Exchange Management Shell prompts you for them.

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

 

Parameter Required Type Description

LookupDomain

Required

Microsoft.Exchange.Data.SmtpDomain

The domain name that the Connection Filter agent queries for updated IP Allow list information

Name

Required

System.String

The name of the IP Allow List provider service

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 the BitmaskMatch parameter to use an IP address, 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.

IPAddressesMatch

Optional

Microsoft.Exchange.Data.MultiValuedProperty

When you configure an IP address for the IPAddressMatch 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.

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 that 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 add first is incremented by 1.

TemplateInstance

Optional

System.Management.Automation.PSObject

When an existing object is supplied to this parameter, the command will use that object's configuration to create an exact duplicate of the object on a local or target server.

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.

 

Error Description

 

 

The following code example shows an Add-IPAllowListProvider command that has the required parameters: LookupDomain and Name.

Add-IPAllowListProvider -Name:Example -LookupDomain:Example.com
 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2015 Microsoft