Set-IPAllowListProvidersConfig

 

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

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

Syntax

Set-IPAllowListProvidersConfig [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-Enabled <$true | $false>] [-ExternalMailEnabled <$true | $false>] [-Instance <IPAllowListProviderConfig>] [-InternalMailEnabled <$true | $false>] [-WhatIf [<SwitchParameter>]]

Detailed Description

The Set-IPAllowListProvidersConfig cmdlet sets the configuration used by the Connection Filter agent.

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

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 the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory directory service, include the DomainController parameter on the command. The DomainController parameter is not supported on computers that have the Edge Transport server role installed. The Edge Transport server role 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, connection filtering is enabled on the computer where you are running the command.

ExternalMailEnabled

Optional

System.Boolean

Valid input for the ExternalMailEnabled parameter is $true or $false. The default setting is $true. When the ExternalMailEnabled parameter is set to $true, all messages from connections outside the Exchange organization are passed through the Connection Filter agent for processing.

Instance

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.IPAllowListProviderConfig

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.

InternalMailEnabled

Optional

System.Boolean

Valid input for the InternalMailEnabled parameter is $true or $false. The default setting is $false. When the InternalMailEnabled parameter is set to $true, all messages from senders inside your Exchange organization are passed through the Connection Filter agent for processing. Authenticated partner messages are not considered internal mail.

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.

Input Types

Return Types

Errors

Error Description

 

Example

The following code example shows the syntax for the Set-IPAllowListProvidersConfig command. The example shows a command that enables the IP Allow List providers on messages that come from internal domains.

Set-IPAllowListProvidersConfig -InternalMailEnabled:$true