Export (0) Print
Expand All

Add-SPPluggableSecurityTrimmer

 

Applies to: SharePoint Server 2013 Enterprise

Topic Last Modified: 2013-12-18

Adds a pluggable security trimmer to a Profile service application proxy.

Add-SPPluggableSecurityTrimmer [-UserProfileApplicationProxyId] <Guid> -PlugInId <Int32> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-CustomProperties <NameValueCollection>] [-QualifiedTypeName <String>] [-WhatIf [<SwitchParameter>]]

Use the Add-SPPluggableSecurityTrimmer cmdlet to add a specified pluggable security trimmer to a User Profile service application proxy.

 

Parameter Required Type Description

UserProfileApplicationProxyId

Required

System.Guid

Specifies the ID of the User Profile service application proxy to which you are adding the pluggable security trimmer.

The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh.

PlugInId

Required

System.Int32

The index of the pluggable security trimmer must have an integer value greater than or equal to zero.

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.

NoteNote:
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

QualifiedTypeName

Optional

System.String

Specifies the qualified type name of the class that implements the pluggable security trimmer.

The type must be a valid qualified type name, in the form Microsoft.Office.Server.SocialData.SocialSecurityTrimmer,Microsoft.Office.Server.UserProfiles,Version=14.0.0.0,Culture=neutral,PublicKeyToken=71e9bce111e9429c.

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

----------------EXAMPLE 1--------------------

$pr = Get-SPServiceApplicationProxy | ? {$_.TypeName.Contains("Profile")}
Add-SPPluggableSecurityTrimmer -UserProfileApplicationProxyId $pr.Id -PlugInId 0

This example adds a pluggable security trimmer that is related to the User Profile service application proxy.

-----------------EXAMPLE 2----------------------

$proxy = Get-SPServiceApplicationProxy | ? {$_.TypeName.Contains("Profile")} $proxy.Id
Add-SPPluggableSecurityTrimmer -UserProfileApplicationProxyId $proxy.Id -PlugInId 0

This example turns on security trimming in a User Profile Service Application.

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