Export (0) Print
Expand All

Set-SPSite

 

Applies to: SharePoint Server 2013 Enterprise, SharePoint Foundation 2013

Topic Last Modified: 2014-02-11

Configures the specified sites.

Set-SPSite [-Identity] <SPSitePipeBind> [-AdministrationSiteType <None | TenantAdministration>] [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-LockState <String>] [-MaxSize <Int64>] [-OwnerAlias <SPUserPipeBind>] [-QuotaTemplate <SPQuotaTemplatePipeBind>] [-SecondaryOwnerAlias <SPUserPipeBind>] [-SharingType <String>] [-Template <SPWebTemplatePipeBind>] [-Url <String>] [-UserAccountDirectoryPath <String>] [-WarningSize <Int64>] [-WhatIf [<SwitchParameter>]]
Set-SPSite [-Identity] <SPSitePipeBind> [-AdministrationSiteType <None | TenantAdministration>] [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-SiteSubscription <SPSiteSubscriptionPipeBind>] [-WhatIf [<SwitchParameter>]]

This cmdlet contains more than one parameter set. You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. For more information about how to use parameter sets, see Cmdlet Parameter Sets.

The Set-SPSite cmdlet configures the site collection that is specified by the Identity parameter. If a parameter is not used, the value is not changed.

NoteNote:
The QuotaTemplate parameter is mutually exclusive to the MaxSize parameter and WarningSize parameter.

 

Parameter Required Type Description

Identity

Required

Microsoft.SharePoint.PowerShell.SPSitePipeBind

Specifies the URL or GUID of the site collection to configure, or refers to an SPSite object that contains sites to configure.

The type must be a valid URL, in the form http://server_name; a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or an SPSite object.

AdministrationSiteType

Optional

Microsoft.SharePoint.SPAdministrationSiteType

Specifies the site type.

Valid values are None or TentantAdministration.

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.

NoteNote:
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

Force

Optional

System.Management.Automation.SwitchParameter

Suppresses confirmation messages involved in setting the site subscription. This parameter is used in conjunction with the SiteSubscription parameter.

LockState

Optional

System.String

Sets the lock state of this site collection. The valid lock states are

Unlock   Unlocks the site collection and makes it available to users

NoAdditions   Prevents users from adding new content to the site collection. Updates and deletions are still allowed

ReadOnly   Prevents users from adding, updating, or deleting content.

NoAccess   Prevents access to content completely. Users who attempt to access the site receive an access-denied message.

MaxSize

Optional

System.Int32

Sets the maximum storage size for the site collection in megabytes.

The integer value must be larger than the WarningSize value. You cannot use this parameter if the site collection is using a quota template.

OwnerAlias

Optional

System.String

Specifies the alias name of the site collection administrator.

The type must be a valid e-mail alias, in the form domain\username.

QuotaTemplate

Optional

Microsoft.SharePoint.PowerShell.SPQuotaTemplatePipeBind

Specifies the new quota template for this site collection.

The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890abcdef or a string

SecondaryOwnerAlias

Optional

System.String

Sets the alias of the secondary site collection administrator.

The type must be a valid e-mail alias, in the form domain\username.

SharingType

Optional

System.String

Specifies whether external access a site collection should be disabled, limited to external users only, or enabled for external users and anonymous guests.

SiteSubscription

Optional

Microsoft.SharePoint.PowerShell.SPSiteSubscriptionPipeBind

Specifies the Site Group to get site collections.

Template

Optional

Microsoft.SharePoint.PowerShell.SPWebTemplatePipeBind

Specifies the template for this site collection.

The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890abcdef.

Url

Optional

System.String

Specifies the URL of the new site.

UserAccountDirectoryPath

Optional

String

Sets an organization unit to which to scope user accounts.

WarningSize

Optional

System.Int32

Sets the storage warning level for the site collection.

The integer value must be between 0 and the MaxSize value. You cannot use this parameter if the site collection is using a quota 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

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

Get-SPSite http://sitename/sites/teams/* | Set-SPSite -SecondaryOwnerAlias "DOMAIN\Jdoe"

This example sets the secondary owner on a set of site collections to DOMAIN\Jdoe.

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

Set-SPSite -identity "http://sitename" -MaxSize 4000000 -WarningSize 2000000

This example configures the Quota settings for the site collection http://sitename.

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