Get-SPSiteUpgradeSessionInfo
Manage or report site upgrade.
Syntax
ContentDB
Get-SPSiteUpgradeSessionInfo
-ContentDatabase <SPContentDatabasePipeBind>
[-AssignmentCollection <SPAssignmentCollection>]
[-HideWaiting]
[-ShowCompleted]
[-ShowFailed]
[-ShowInProgress]
[-SiteSubscription <SPSiteSubscriptionPipeBind>]
[<CommonParameters>]
Site
Get-SPSiteUpgradeSessionInfo
-Site <SPSitePipeBind>
[-AssignmentCollection <SPAssignmentCollection>]
[<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.
Use the Get-SPSiteUpgradeSessionInfo cmdlet to manage or report site upgrade of the farm.
This cmdlet has two modes, get upgrade information for a specific SPSite object or for a given content database.
For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at SharePoint Server Cmdlets.
Examples
EXAMPLE 1
C:\PS>$db = Get-SPContentDatabase -Identity wss_content
Get-SPSiteUpgradeSessionInfo -ContentDatabase $db
This example returns siteupgradeinfo for every SPContentDatabase returned from Get-SPContentDatabase cmdlet.
EXAMPLE 2
C:\PS>$site=Get-SPSite -Identity https://localhost
Get-SPSiteUpgradeSessionInfo -Site $site
This example returns siteupgradeinfo for every SPSite object returned from Get-SPSite cmdlet.
Parameters
-AssignmentCollection
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
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.
Parameter properties
| Type: | SPAssignmentCollection |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ContentDatabase
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies the GUID of the content database from which to list site collections.The type must be a valid database name, in the form SPContentDB01, or a valid GUID (for example, 12345678-90ab-cdef-1234-567890bcdefgh).
Parameter properties
| Type: | SPContentDatabasePipeBind |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ContentDB
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-HideWaiting
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies to hide site collections that upgrade has not started.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ContentDB
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ShowCompleted
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies to show site collections that has completed upgrade.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ContentDB
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ShowFailed
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies to show site collections that have failed upgrade.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ContentDB
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ShowInProgress
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Displays site collections that are in the process of being upgraded.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ContentDB
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Site
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Parameter properties
| Type: | SPSitePipeBind |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Site
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-SiteSubscription
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies to limit the result to site collections within the site subscription.
Parameter properties
| Type: | SPSiteSubscriptionPipeBind |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ContentDB
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.