Get-ContentFilterPhrase
Applies to: Exchange Server 2007 SP1, Exchange Server 2007 SP2, Exchange Server 2007 SP3
Use the Get-ContentFilterPhrase cmdlet to view one or all custom words that the Content Filter agent processes.
Syntax
Get-ContentFilterPhrase [-Identity <ContentFilterPhraseIdParameter>] [-DomainController <Fqdn>]
Get-ContentFilterPhrase [-DomainController <Fqdn>] [-Phrase <ContentFilterPhraseIdParameter>]
Detailed Description
To run the Get-ContentFilterPhrase cmdlet, the account you use must be delegated the following:
- Exchange View-Only Administrator role
To run the Get-ContentFilterPhrase 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 |
---|---|---|---|
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
To specify the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to the Active Directory directory service, include the DomainController parameter on the command. The DomainController parameter is not supported on computers that run the Edge Transport server role. The Edge Transport server role reads and writes only to the local ADAM instance. |
Identity |
Optional |
Microsoft.Exchange.Configuration.Tasks.ContentFilterPhraseIdParameter |
Use the Identity parameter to display a specific custom word or phrase. The Identity parameter specifies the phrase that you want to view. You must enclose the Identity parameter in double quotation marks. For example, if you want to get the custom word configuration data for the BadWord identity, For this command, the Identity parameter is not different from the Phrase parameter. |
Phrase |
Optional |
Microsoft.Exchange.Configuration.Tasks.ContentFilterPhraseIdParameter |
Use the Phrase parameter to display a specific custom word. The Phrase parameter is the Phrase parameter in the ContentFilterPhrase configuration. You must enclose the Phrase parameter in double quotation marks. For example, if you want to get the custom word configuration data for the BadWord phrase, |
Input Types
Return Types
Errors
Error | Description |
---|---|
|
Example
The following code examples show the syntax for the Get-ContentFilterPhrase cmdlet.
The first example shows how to use the Get-ContentFilterPhrase cmdlet to return all custom words that are stored on the computer where the command is being run.
The second example shows how to use the Get-ContentFilterPhrase cmdlet to return a specific custom word that is specified by the Phrase parameter. In this example, the custom word is the BadWord phrase, This is a bad phrase
.
Get-ContentFilterPhrase
Get-ContentFilterPhrase -Phrase "This is a bad phrase"