Edit

Share via


Disable-SPWebTemplateForSiteMaster

Disables the site master in the farm.

Syntax

Default (Default)

Disable-SPWebTemplateForSiteMaster
    [-AssignmentCollection <SPAssignmentCollection>]
    [-CompatibilityLevel <Int32>]
    -Template <SPWebTemplatePipeBind>
    [<CommonParameters>]

Description

Use the Disable-SPWebTemplateForSiteMaster cmdlet to disable a site master in the farm.

Examples

Example 1

Disable-SPWebTemplateForSiteMaster -Template STS#0

This example disables the template in the site master of a farm.

Parameters

-AssignmentCollection

Applicable: SharePoint Server 2016, SharePoint Server 2019

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.

Parameter properties

Type:SPAssignmentCollection
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-CompatibilityLevel

Applicable: SharePoint Server 2016, SharePoint Server 2019

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 parameter will default to the highest possible version for the web application depending on the SiteCreationMode setting.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Template

Applicable: SharePoint Server 2016, SharePoint Server 2019

Specifies the name of the template. For example, SPSPERS#2.

Parameter properties

Type:SPWebTemplatePipeBind
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Microsoft.SharePoint.PowerShell.SPAssignmentCollection

Outputs

System.Object