Disable-SPFeature

Reference

Module:: sharepoint-server

Applies to:: SharePoint Server Subscription Edition

Disables an installed SharePoint Feature at a given scope.

Syntax

Disable-SPFeature
       [-Identity] <SPFeatureDefinitionPipeBind>
       [-AssignmentCollection <SPAssignmentCollection>]
       [-Confirm]
       [-Force]
       [-Url <String>]
       [-WhatIf]
       [<CommonParameters>]

Description

The Disable-SPFeature cmdlet disables a SharePoint Feature at the given scope. If the scope of the Feature is the farm, the URL is not needed. Otherwise, provide the URL at which this Feature is to be deactivated (explicit scope is not needed).

For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at SharePoint Server Cmdlets.

Examples

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

Disable-SPFeature -identity "MyCustom" -URL https://somesite

This example disables the "MyCustom" Web site scoped feature at https://somesite.

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

$w = Get-SPWeb https://somesite/myweb | ForEach{ $_.URL }
Get-SPFeature -Web $w | ForEach-Object { Disable-SPFeature -Identity $_ -URL $w}

This example disables all features in the subsite at https://somesite/myweb.

You do not need to use the SPAssignment cmdlets in this case because the Web object is not stored -- only the string value for the URL.

Parameters

-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
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-Confirm

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

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-Force

Forces a Feature to be disabled.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-Identity

Specifies the name of the Feature or GUID to disable.

The type must be the name of the Feature folder located in the "$env:ProgramFiles\Common Files\Microsoft Shared\Web Server Extensions[14|15|16]\Template\Features" folder or GUID, in the format 21d186e1-7036-4092-a825-0eb6709e9281.

Type:	SPFeatureDefinitionPipeBind
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-Url

Specifies the URL of the Web application, site collection, or Web site to which the Feature is being disabled.

The type must be a valid URL, such as https://server_name.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-WhatIf

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

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

Share via