Export (0) Print
Expand All

Set-SPWebTemplate

SharePoint 2010

Published: May 12, 2010

Changes the title and description of an installed site template.

Set-SPWebTemplate [-Identity] <SPWebTemplatePipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-Description <String>] [-Name <String>] [-WhatIf [<SwitchParameter>]]

Parameters

 

Parameter Required Type Description

Identity

Required

Microsoft.SharePoint.PowerShell.SPWebTemplatePipeBind

Specifies the name of the Web template to be changed.

The type must the ID or full name of the Web template.

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.

note Note:

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

Description

Optional

System.String

Specifies the new description.

The type must be a valid description; for example, This is template.

Name

Optional

System.String

Specifies the new name for the template.

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

Detailed Description

The Set-SPWebTemplate cmdlet changes the title and description of an installed site template.

Input Types

 

Return Types

 

------------------EXAMPLE-----------------------

Get-SPSiteTemplate "ATH#0" | Set-SPSiteTemplate –name "Athletics Site"
Set-SPSiteTemplate "ATH#0" –name "Athletics Site"

This examples change the ATH#0 template title to Athletics Site.

Change History

 

Date Description Reason

May 12, 2010

Initial publication

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