Get-SPSiteUpgradeSessionInfo
Manage or report site upgrade.
Syntax
Get-SPSiteUpgradeSessionInfo
-ContentDatabase <SPContentDatabasePipeBind>
[-AssignmentCollection <SPAssignmentCollection>]
[-HideWaiting]
[-ShowCompleted]
[-ShowFailed]
[-ShowInProgress]
[-SiteSubscription <SPSiteSubscriptionPipeBind>]
[<CommonParameters>] 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 $dbThis example returns siteupgradeinfo for every SPContentDatabase returned from Get-SPContentDatabase cmdlet.
-----------EXAMPLE 2----------
C:\PS>$site=Get-SPSite -Identity https://localhost
Get-SPSiteUpgradeSessionInfo -Site $siteThis example returns siteupgradeinfo for every SPSite object returned from Get-SPSite cmdlet.
Parameters
-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 2013, SharePoint Server 2016, SharePoint Server 2019 |
-ContentDatabase
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).
| Type: | SPContentDatabasePipeBind |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-HideWaiting
Specifies to hide site collections that upgrade has not started.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-ShowCompleted
Specifies to show site collections that has completed upgrade.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-ShowFailed
Specifies to show site collections that have failed upgrade.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-ShowInProgress
Displays site collections that are in the process of being upgraded.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-Site
| Type: | SPSitePipeBind |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-SiteSubscription
Specifies to limit the result to site collections within the site subscription.
| Type: | SPSiteSubscriptionPipeBind |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
Related Links
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for