Remove-FASTSearchMetadataRankProfile

Article
07/25/2014

Applies to: SharePoint Server 2010

Removes a rank profile from the Microsoft FAST Search Server 2010 for SharePoint system.

Syntax

Remove-FASTSearchMetadataRankProfile -RankProfile <RankProfile> [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]]

Remove-FASTSearchMetadataRankProfile [-Name] <String> [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]]

Detailed Description

This cmdlet removes a rank profile from the FAST Search Server 2010 for SharePoint system. It contains more than one parameter set. You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. When doing simple operations, there is no difference between using the RankProfile versus the Name parameter. The only difference is when using the Name parameter you look up the rank profile each time, while when using the RankProfile parameter you use the object you already have a reference to. However, when dealing with operations involving a large set of objects (for example iterating over all categories), avoiding extra lookups by name can be slightly more efficient. For more information about how to use parameter sets, see Cmdlet Parameter Sets.

A rank profile controls relevance calculation when searching a full text index. If a deleted rank profile is specified when searching, then the default rank profile is used.

The default rank profile cannot be deleted.

Parameters

Parameter	Required	Type	Description
Name	Required	System.String	The name of the rank profile to remove.
RankProfile	Required	Microsoft.SharePoint.Search.Extended.Administration.Schema.RankProfile	An object representing the rank profile to remove.
Confirm	Optional	System.Management.Automation.SwitchParameter	Activates user prompting to confirm the operation. If set, prompting is activated. If Confirm is false `(-Confirm:$false`), confirmation prompting is not used. In cases where Confirm is not specified, the cmdlet will prompt if the `$ConfirmPreference` shell variable is greater than or equal to the ConfirmImpact setting of the cmdlet (HIGH).
Force	Optional	System.Management.Automation.SwitchParameter	Overrides any user prompting settings, so that confirmation of the operation is not required.
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

Input Types

Return Types

Example

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

Remove-FASTSearchMetadataRankProfile -Name webcontent

This example removes the rank profile “webcontent”.

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

$rankprofile = Get-FASTSearchMetadataRankProfile -Name newrankprofile
Remove-FASTSearchMetadataRankProfile -Force -RankProfile $rankprofile

This example deletes the rank profile object which represents the rank profile named “newrankprofile”.

No confirmation is required, since the Force parameter is specified.

Share via