Set-SPSite
Configures the specified sites.
Syntax
Set-SPSite
[-Identity] <SPSitePipeBind>
[-AdministrationSiteType <SPAdministrationSiteType>]
[-AssignmentCollection <SPAssignmentCollection>]
[-Confirm]
[-Force]
[-SiteSubscription <SPSiteSubscriptionPipeBind>]
[-WhatIf]
[<CommonParameters>]Set-SPSite
[-Identity] <SPSitePipeBind>
[-AdministrationSiteType <SPAdministrationSiteType>]
[-AssignmentCollection <SPAssignmentCollection>]
[-Confirm]
[-LockState <String>]
[-MaxSize <Int64>]
[-OwnerAlias <SPUserPipeBind>]
[-QuotaTemplate <SPQuotaTemplatePipeBind>]
[-SecondaryOwnerAlias <SPUserPipeBind>]
[-SharingType <String>]
[-Template <SPWebTemplatePipeBind>]
[-Url <String>]
[-UserAccountDirectoryPath <String>]
[-WarningSize <Int64>]
[-WhatIf]
[<CommonParameters>]Description
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.
The QuotaTemplate parameter is mutually exclusive to the MaxSize parameter and WarningSize parameter.
For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at SharePoint Server Cmdlets.
Examples
--------------------EXAMPLE 1---------------------
Get-SPSite https://sitename/sites/teams/* | Set-SPSite -SecondaryOwner "DOMAIN\Jdoe"This example sets the secondary owner on a set of site collections to DOMAIN\Jdoe.
--------------------EXAMPLE 2---------------------
Set-SPSite -identity "https://sitename" -MaxSize 4000000 -WarningSize 2000000This example configures the Quota settings for the site collection https://sitename.
Parameters
-AdministrationSiteType
Specifies the site type.
Valid values are None or TentantAdministration.
| Type: | SPAdministrationSiteType |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-AssignmentCollection
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.
| Type: | SPAssignmentCollection |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-Confirm
Prompts you for confirmation before executing the command.
For more information, type the following command: get-help about_commonparameters
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-Force
Suppresses confirmation messages involved in setting the site subscription. This parameter is used in conjunction with the SiteSubscription parameter.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-Identity
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 https://server_name; a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; or an SPSite object.
| Type: | SPSitePipeBind |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-LockState
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.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-MaxSize
Sets the maximum storage size for the site collection in bytes.
The integer value must be larger than the WarningSize value. You cannot use this parameter if the site collection is using a quota template.
| Type: | Int64 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-OwnerAlias
Specifies the alias name of the site collection administrator.
The type must be a valid e-mail alias, in the form domain\username.
| Type: | SPUserPipeBind |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-QuotaTemplate
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
| Type: | SPQuotaTemplatePipeBind |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-SecondaryOwnerAlias
Sets the alias of the secondary site collection administrator.
The type must be a valid e-mail alias, in the form domain\username.
| Type: | SPUserPipeBind |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-SharingType
Specifies whether external access a site collection should be disabled, limited to external users only, or enabled for external users and anonymous guests.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-SiteSubscription
Specifies the Site Group to get site collections.
| Type: | SPSiteSubscriptionPipeBind |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-Template
Specifies the template for this site collection.
The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890abcdef.
| Type: | SPWebTemplatePipeBind |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-Url
Specifies the URL of the new site.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-UserAccountDirectoryPath
Sets an organization unit to which to scope user accounts.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-WarningSize
Sets the storage warning level for the site collection in bytes.
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.
| Type: | Int64 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-WhatIf
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
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |