Commands › Exchange Online
Add-IPBlockListProvider
This cmdlet is available or effective only on Edge Transport servers in on-premises Exchange. Use the Add-IPBlockListProvider cmdlet to create IP Block list providers that are used by the Connection Filtering agent on Edge Transport servers.
Quick start script
# Add-IPBlockListProvider — quick start (serv365.ai)
# 1. Connect (app-only shown; interactive: omit the certificate parameters)
Connect-ExchangeOnline -CertificateThumbprint $thumb -AppId $appId -Organization $org
# 2. Run and inspect
Add-IPBlockListProvider -Name <String> -LookupDomain <SmtpDomain> | Format-List
# 3. Export for evidence / drift tracking
Add-IPBlockListProvider | Export-Clixml .\IPBlockListProvider-$(Get-Date -Format yyyyMMdd).xmlSyntax
Add-IPBlockListProvider [-Name] <String> -LookupDomain <SmtpDomain>
[-AnyMatch <Boolean>]
[-BitmaskMatch <IPAddress>]
[-Confirm]
[-DomainController <Fqdn>]
[-Enabled <Boolean>]
[-IPAddressesMatch <MultiValuedProperty>]
[-Priority <Int32>]
[-RejectionResponse <AsciiString>]
[-WhatIf]
[<CommonParameters>]Parameters (11)
| Parameter | Type | Required | What it controls |
|---|---|---|---|
| -Name | String | yes | The Name parameter specifies a descriptive name for the IP Block list provider. |
| -LookupDomain | SmtpDomain | yes | The LookupDomain parameter specifies the host name that's required to use the block list provider. Connection filtering sends the IP address of the connecting SMTP server to the host name value that you specify. An... |
| -AnyMatch | Boolean | The AnyMatch parameter specifies whether any response by the block 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... | |
| -BitmaskMatch | IPAddress | The BitmaskMatch parameter specifies the bit mask status code that's returned by the block list provider. Use this parameter if the block list provider returns bitmask responses. Valid input for this parameter is a... | |
| -Confirm | SwitchParameter | The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on whether the cmdlet requires confirmation before proceeding. | |
| -DomainController | Fqdn | The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name... | |
| -Enabled | Boolean | The Enabled parameter specifies whether the connection filtering uses this IP Block list provider. Valid input for this parameter is $true or $false. The default value is $true. By default, connection filtering uses... | |
| -IPAddressesMatch | MultiValuedProperty | The IPAddressesMatch parameter specifies the IP address status codes that are returned by the block list provider. Use this parameter if the block list provider returns IP address or A record responses. Valid input... | |
| -Priority | Int32 | The Priority parameter specifies the order that the Connection Filtering agent queries the IP Block list providers. A lower priority integer value indicates a higher priority. By default, every time that you add a... | |
| -RejectionResponse | AsciiString | The RejectionResponse parameter specifies the text that you want to include in the SMTP rejection response when messages are blocked by connection filtering. The argument can't exceed 240 characters. If the value... | |
| -WhatIf | SwitchParameter | The WhatIf switch shows what the command does without making any changes. You don't need to specify a value with this switch. |
Reference facts derived from Microsoft documentation, © Microsoft, licensed CC BY 4.0; restructured with original guidance by serv365.ai.