Export (0) Print
Expand All
Expand Minimize

Add-IPAllowListProvider

 

Applies to: Exchange Server 2013

Topic Last Modified: 2014-04-11

This cmdlet is available or effective only on Edge Transport servers in on-premises Exchange Server 2013.

Use the Add-IPAllowListProvider cmdlet to create IP Allow list providers that are used by the Connection Filtering agent on Edge Transport servers.

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

This example adds a new IP Allow list provider and configures connection filtering to treat any IP address status code returned from the IP Allow list provider as a match and allow the connection. You get the value for the LookupDomain parameter from the allow list provider.

Add-IPAllowListProvider -Name "Contoso.com Allow List" -LookupDomain allowlist.contoso.com -AnyMatch $true

This example adds an IP Allow list provider and configures a bitmask return value from the provider. You get the values for the LookupDomain and BitmaskMatch parameters from the allow list provider.

Add-IPAllowListProvider -Name "Fabrikam.com Allow List" -LookupDomain allowlist.fabrikam.com -BitmaskMatch 127.1.0.1

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 - Edge Transport" entry in the Anti-spam and anti-malware permissions topic.

 

Parameter Required Type Description

LookupDomain

Required

Microsoft.Exchange.Data.SmtpDomain

The LookupDomain parameter specifies the host name that's required to use the allow list provider. Connection filtering sends the IP address of the connecting SMTP server to the host name value that you specify. An example value is allowlist.spamservice.com. The actual value you need to use is provided by the allow list provider.

Name

Required

System.String

The Name parameter specifies a descriptive name for the IP Allow list provider.

AnyMatch

Optional

System.Boolean

The AnyMatch parameter specifies whether any response by the allow list provider is treated as a match. Valid input for this parameter is $true or $false. The default value is $false. When this parameter is set to $true, and connection filtering sends the IP address of the connecting SMTP server to the allow list provider, any response code returned by the allow list provider causes connection filtering to allow messages from that source.

BitmaskMatch

Optional

System.Net.IPAddress

The BitmaskMatch parameter specifies the bit mask status code that's returned by the allow list provider. Use this parameter if the allow list provider returns bitmask responses. Valid input for this parameter is a single IP address in the format 127.0.0.1.

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 Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data.

Enabled

Optional

System.Boolean

The Enabled parameter specifies whether the connection filtering uses this IP Allow List provider. Valid input for this parameter is $true or $false. The default value is $true. By default, connection filtering uses new IP Allow List providers that you create.

IPAddressesMatch

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The IPAddressesMatch parameter specifies the IP address status codes that are returned by the allow list provider. Use this parameter if the allow list provider returns IP address or A record responses. Valid input for this parameter one or more IP addresses in the format 127.0.0.1. You can enter multiple IP addresses separated by commas.

Priority

Optional

System.Int32

The Priority parameter specifies the order that the Connection Filtering agent queries the IP Allow list providers that you have configured. A lower priority integer value indicates a higher priority. By default, every time that you add a new IP Allow list provider, the entry is assigned a priority of N+1, where N is the number of IP Allow list providers that you have configured.

If you set the Priority parameter to a value that's the same as another IP Allow list provider, the priority of the IP Allow list provider that you add first is incremented by 1.

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.

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.

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.

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft