Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

Install-SPWebTemplate

SharePoint 2010

Published: May 12, 2010

Installs the given site template.

Install-SPWebTemplate [-Path] <String> -Name <String> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-Description <String>] [-WhatIf [<SwitchParameter>]]

Parameters

 

Parameter Required Type Description

Path

Required

System.String

Specifies the path to the site template package.

The type must be a valid path; for example, <example of path>.

Name

Required

System.String

Specifies the name of the template.

The type must be a valid name; for example, MyTemplate.

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 template description.

The type must be a valid description; for example, Joe’s 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 Install-SPWebTemplate cmdlet installs the given site template using the name provided (title) as the unique ID.

Input Types

 

Return Types

 

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

Install-SPWebTemplate –path "mytemplate.cab" –name "My Template" –description "TestFarm"

This example installs the mytemplate.cab file as My Template with the description "TestFarm" on the farm.

Change History

 

Date Description Reason

May 12, 2010

Initial publication

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.