Export (0) Print
Expand All
Expand Minimize

New-SPEnterpriseSearchSecurityTrimmer

Published: May 12, 2010

Adds a custom security trimmer to a shared search application.

New-SPEnterpriseSearchSecurityTrimmer [-Id] <Int32> -RulePath <String> -SearchApplication <SearchServiceApplicationPipeBind> -TypeName <String> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-Properties <String>] [-WhatIf [<SwitchParameter>]]

Parameters

 

Parameter Required Type Description

Id

Required

System.Int32

Specifies the identity of the pluggable security trimmer to use for the specified search application. If this parameter specifies an existing custom security trimmer, the trimmer will be removed and replaced with the custom trimmer.

RulePath

Required

System.String

Specifies the content path to which the security trimmer will be applied.

The string must be a valid URI, in the form file:\\server_name\content, and it must correspond to an existing crawl rule.

SearchApplication

Required

Microsoft.Office.Server.Search.Cmdlet.SearchServiceApplicationPipeBind

Adds the security trimmer to the specified search application.

The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid search application name (for example, SearchApp1); or an instance of a valid SearchServiceApplication object.

TypeName

Required

System.String

Specifies the fully-qualified type name of a security trimmer type. The name must refer to a type whose assembly is deployed to the global assembly cache on a query server, and that type must implement the ISecurityTrimmer interface (Microsoft.Office.Server.Search.Query.ISecurityTrimmer).

AssignmentCollection

Optional

Microsoft.SharePoint.PowerShell.SPAssignmentCollection

Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.

note Note:

When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.

Confirm

Optional

System.Management.Automation.SwitchParameter

Prompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparameters

Properties

Optional

System.String

Specifies the name-value pairs that specify the configuration properties.

The type must be in the following name/value pair format: Name1~Value1~Name2~Value2~

WhatIf

Optional

System.Management.Automation.SwitchParameter

Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparameters

Detailed Description

The New-SPEnterpriseSearchSecurityTrimmer cmdlet creates a new object to configure the pluggable security trimmer. SPEnterpriseSearchSecurityTrimmer represents a pluggable security trimmer that performs customized security trimming of search results at query time, when the results are returned to the user.

Input Types

 

Return Types

 

------------------EXAMPLE------------------

$ssa = Get-SPEnterpriseSearchServiceApplication –Identity "MySSA"
New-SPEnterpriseSearchSecurityTrimmer -Id 1234 -SearchApplication $ssa -TypeName Contoso.Security.QueryTrimmer -RulePath http://myServer

This example adds a new custom security trimmer of type Contoso.Security.QueryTrimmer to the path http://myServer.

Change History

 

Date Description Reason

May 12, 2010

Initial publication

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