.png)
Set-SPWeb
Published: July 16, 2012
Applies to: SharePoint Foundation 2013 | SharePoint Server 2013 Enterprise
Configures the specified subsite.
Set-SPWeb [-Identity] <SPWebPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-Description <String>] [-RelativeUrl <String>] [-Template <SPWebTemplatePipeBind>] [-Theme <String>] [-WhatIf [<SwitchParameter>]]
Parameters
| Parameter | Required | Type | Description | ||
|---|---|---|---|---|---|
| Identity | Required | Microsoft.SharePoint.PowerShell.SPWebPipeBind | The URL of the Web or SPWeb object that represents the Web. The type must be a valid URL, in the form http://server_name, or an SPWeb object. | ||
| Name | Optional | String | Specifies the new name of the Web. | ||
| Description | Optional | System.String | Specifies the new description of the Web. | ||
| RelativeUrl | Optional | System.String | Specifies the new relative URL for the Web. This is the URL path after the site collection URL. | ||
| Theme | Optional | System.String | Specifies the new theme to apply to the Web. | ||
| Template | Optional | Microsoft.SharePoint.PowerShell.SPWebTemplatePipeBind | Specifies the new template to apply to the Web. This cannot be done if the template is already applied. | ||
| 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.
| ||
| 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 | ||
| 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 |
Note: Detailed Description
The Set-SPWeb cmdlet configures the subsite specified by the Identity parameter. Settings for any parameters that are not provided are not changed.
Input Types
Return Types
one
------------------EXAMPLE-----------------------
Get-SPWeb http://sitename/subweb | Set-SPWeb -Title "My Site Title"
This example sets the title of an existing subsite.
Change History
| Date | Description |
|---|---|
| July 16, 2012 | Initial publication |
