Skip to content

Latest commit

 

History

History
248 lines (188 loc) · 7.64 KB

Get-SPFeature.md

File metadata and controls

248 lines (188 loc) · 7.64 KB
Raw
external help file module name online version applicable title schema
Microsoft.SharePoint.PowerShell.dll-help.xml
SharePointServer
SharePoint Server Subscription Edition
Get-SPFeature
2.0.0

Get-SPFeature

SYNOPSIS

Returns the SharePoint Features based on a given scope.

SYNTAX

FarmFeatures

Get-SPFeature [[-Identity] <SPFeatureDefinitionPipeBind>] [-AssignmentCollection <SPAssignmentCollection>]
 [-Farm] [-Limit <String>] [<CommonParameters>]

SiteFeatures

Get-SPFeature [[-Identity] <SPFeatureDefinitionPipeBind>] [-AssignmentCollection <SPAssignmentCollection>]
 [-Limit <String>] [-Site <SPSitePipeBind>] [-Sandboxed] [<CommonParameters>]

WebFeatures

Get-SPFeature [[-Identity] <SPFeatureDefinitionPipeBind>] [-AssignmentCollection <SPAssignmentCollection>]
 [-Limit <String>] [-Web <SPWebPipeBind>] [<CommonParameters>]

WebApplicationFeatures

Get-SPFeature [[-Identity] <SPFeatureDefinitionPipeBind>] [-AssignmentCollection <SPAssignmentCollection>]
 [-Limit <String>] [-WebApplication <SPWebApplicationPipeBind>] [<CommonParameters>]

FarmFeatureDefinitions

Get-SPFeature [[-Identity] <SPFeatureDefinitionPipeBind>] [-AssignmentCollection <SPAssignmentCollection>]
 [-Limit <String>] [-CompatibilityLevel <Int32>] [<CommonParameters>]

DESCRIPTION

This cmdlet 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. For more information about how to use parameter sets, see Cmdlet Parameter Sets https://go.microsoft.com/fwlink/?LinkID=18781.

All parameter sets take the Identity parameter, which can be either the relative path of the SharePoint Feature (considered the feature name) or the GUID of a Feature definition.

If the Identity parameter is provided, the cmdlets attempt to find the given Feature definition or instance for the given scope. If no parameters are specified, all installed features are returned.

The Get-SPFeature cmdlet behaves differently at each scope, returning the enabled Features at each level. If no scope is provided, all installed Features are returned.

For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at https://go.microsoft.com/fwlink/p/?LinkId=251831.

EXAMPLES

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

Get-SPFeature -Limit ALL | Where-Object {$_.Scope -eq "SITE"}

This example returns a list of all installed SITE scoped Features.

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

Get-SPSite https://somesite | Get-SPWeb -Limit ALL |%{ Get-SPFeature -Web $_ } | Select DisplayName,ID -Unique

This example returns the name and identifier (ID) of each uniquely enabled Feature on every SPWeb object in the site collection at https://somesite.

PARAMETERS

-Identity

Specifies the name of the Feature to retrieve.

The type must be the full or partial name, in the form Feature1, or a GUID, in the form 1234-4567-9879, of the Feature to get.

Type: SPFeatureDefinitionPipeBind
Parameter Sets: (All)
Aliases: 
Applicable: SharePoint Server Subscription Edition

Required: False
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-AssignmentCollection

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.

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.

Type: SPAssignmentCollection
Parameter Sets: (All)
Aliases: 
Applicable: SharePoint Server Subscription Edition

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Farm

Specifies that if this parameter is used, only enabled farm Features are displayed.

Type: SwitchParameter
Parameter Sets: FarmFeatures
Aliases: 
Applicable: SharePoint Server Subscription Edition

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Limit

Limits the display results. If "All" is specified, all Features are displayed.

The type must be a valid number greater than 0. The default value is 200.

Type: String
Parameter Sets: (All)
Aliases: 
Applicable: SharePoint Server Subscription Edition

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Site

Specifies the name of the site collection from which to get enabled Features.

The type must be a valid URL for a site collection, in the form https://server_name .

Type: SPSitePipeBind
Parameter Sets: SiteFeatures
Aliases: 
Applicable: SharePoint Server Subscription Edition

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Web

Specifies the URL or GUID of the Web.

The type must be a valid URL, in the form https://server_name , or a GUID, in the form 1234-5678-9876-0987.

Type: SPWebPipeBind
Parameter Sets: WebFeatures
Aliases: 
Applicable: SharePoint Server Subscription Edition

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WebApplication

Specifies the name of the Web application from which to get enabled Features.

The type must be a valid URL to the Web application in the form https://server_name .

Type: SPWebApplicationPipeBind
Parameter Sets: WebApplicationFeatures
Aliases: 
Applicable: SharePoint Server Subscription Edition

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-CompatibilityLevel

Specifies the version of templates to use when creating a new SPSite object. This value sets the initial CompatibilityLevel value for the site collection. When this parameter is not specified, the CompatibilityLevel will default to the highest possible version for the web application depending on the CompatibilityRange setting.

Type: Int32
Parameter Sets: FarmFeatureDefinitions
Aliases: 
Applicable: SharePoint Server Subscription Edition

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Sandboxed

Specifies to retrieve Sandbox features.

Type: SwitchParameter
Parameter Sets: SiteFeatures
Aliases: 
Applicable: SharePoint Server Subscription Edition

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

OUTPUTS

NOTES

RELATED LINKS