Pre-upgrade scanning and reporting for future releases (Windows SharePoint Services)
Applies To: Windows SharePoint Services 3.0
Topic Last Modified: 2009-07-22
The Stsadm command provides a rule-based scanning operation to determine whether servers in an existing SharePoint environment meet the core requirements for upgrading from Windows SharePoint Services 3.0 and related products to future releases of SharePoint Products and Technologies.
The pre-upgrade scanning and reporting operation is implemented as Stsadm –o preupgradecheck, and can be run with or without parameters. For more information, see Preupgradecheck: Stsadm operation (Windows SharePoint Services).
You can use this Stsadm operation to scan farm servers before starting an upgrade to ensure that some upgrade prerequisites are met and to detect known issues that can prevent the upgrade from completing successfully. The results of the scan enable you to address any issues that are identified.
The upgrade checker does not do the following:
Supersede the Microsoft Best Practices Analyzer for Windows SharePoint Services 3.0 and the 2007 Microsoft Office system.
Automatically fix issues that are identified.
Prerequisites and permissions
Each server that you want to scan must have Service Pack 2 for Windows SharePoint Services 3.0 installed in order to initiate a scanning session and generate a report about the upgrade readiness of the server.
In order to run a scan with the upgrade checker you must be a member of the Farm Administrators SharePoint Group and have administrator permissions on the server that you scan.
Pre-upgrade operation structure and processing
The pre-upgrade Stsadm operation comprises a set of routines that load one or more XML rule files as input that is evaluated against the current SharePoint farm and server configuration. During the scanning process, each rule passes the results to a routine that writes the results to log files. Thus, the focus is on rules and output:
Rules
Output
The rule collection
The upgrade checker rule collection consists of rule files and the rules that these files contain. A list of the existing default rules appears later in this topic.
Rule files
Rule files are not processed in any specific order unless the person running the scan specifies a rule file or set of rule files as parameters that are passed to the preupgradecheck operation. In this case, the rule files are processed in the in the specified order in which they are passed in. The rule files are located in the %COMMONPROGRAMFILES%\Microsoft Shared\web server extensions\12\CONFIG\PREUPGRADECHECK directory.
Rules
The rules in a rule file specify the checks to be performed during a scan. The rules contained in a rule file are processed in the order in which they are listed. There are two types of rules: informational rules and error rules.
Informational rules
This category of rules provides upgrade-related statistics for the farm that can be used for planning an upgrade. An example is the FarmInfo rule, which provides information about the version of SharePoint that is installed, the number of servers in the farm, and other information. The FarmInfo informational rule provides the following information:
Summary:
The components from this farm
Description:
The software based on SharePoint Products and Technologies currently running on this farm is <binary build version number>. The farm contains the following components:
<Component>[Number of Servers] Servers</Component>
<Component>[Number of Web Applications] Web applications</Component>
<Component>[Number of Content Databases] Content databases, approximate total size = [Total Size of Databases] bytes</Component>
<Component>[Number of Site Collections] Site collections</Component>
Additional information:
See https://www.microsoft.com/sharepoint/upgrade to estimate how long it will take to upgrade your farm compared to a similar farm on Microsoft's benchmark hardware. For more information about this rule, see KB article 954759 in the rule article list in the Windows SharePoint Services Solution Center (https://go.microsoft.com/fwlink/?LinkId=149394&clcid=0x409).
Error rules
This category of the rules provides information about the local server or farm configuration that the administrator needs to fix before starting an upgrade. An example is the DatabaseSchema rule, which lists the names of content databases that have different schema than the standard Windows SharePoint Services 3.0 content database. The DatabaseSchema error rule provides the following information:
Summary:
Content database has database schemas modified by user
Description:
User modifications to the SharePoint content database, including but not limited to table schemas, an index, and stored procedures, are not supported and will cause attempts to upgrade to future versions of SharePoint to fail.
The databases in the following list seem to have been modified from the original schema: [ForEach Database]<Database>[Database Name]</Database>
Additional information and remedy if result is an error:
For more information about this rule, see KB article 954772 in the rule article list in the Windows SharePoint Services Solution Center (https://go.microsoft.com/fwlink/?LinkID=120257).
Default rules
The rules described in the following table are provided with this release of the pre-upgrade requirements operation.
Upgrade checker rules
| Name | Description | Local server or farm | Severity |
|---|---|---|---|
ServerInfo |
All servers that are running SharePoint bits in the farm. |
Local |
Information |
FarmInfo |
The components of this farm. |
Farm |
Information |
UpgradeType |
The upgrade types supported by the farm. |
Local |
Information |
SiteTemplates |
This farm uses the following site definitions. |
Local |
Information |
Features |
The features installed on the farm. |
Local |
Information |
LanguagePacks |
The language packs required for the farm. |
Local |
Information |
AAMURLs |
AAM URLs within the current environment to be considered when upgrading. |
Local |
Information |
OSType |
This server machine in the farm does not have the 64-bit edition of Windows Server 2008 or later installed. |
Local |
Error |
DatabaseSchema |
Content databases are modified by user, and cannot be upgraded. |
Farm |
Error |
DataOrphan |
Content databases contain orphans. |
Farm |
Error |
SiteOrphan |
Some sites cannot be referenced properly. |
Farm |
Error |
UnfinishedGradualUpgrade |
This farm is currently being upgraded by using the gradual upgrade process. |
Farm |
Error |
MissingWebConfig |
This Web site does not have a web.config file. |
Local |
Error |
InvalidHostNames |
Invalid host names found. |
Local |
Error |
InvalidServiceAccount |
The application pool account must be fixed. |
Local |
Error |
DatabaseReadOnly |
Databases in this farm are configured as read-only and the upgrade will fail unless they are configured as read-write. |
Farm |
Error |
WYukonLargeDatabase |
Databases in this farm are hosted on the Windows Internal Database uses SQL Server technology as a relational data store for Windows roles and features only, such as Windows SharePoint Services, Active Directory Rights Management Services, UDDI Services, Windows Server Update Services, and Windows System Resources Manager. and are larger than 4 gigabytes. |
Farm |
Error |
WYukonLargeSiteCollection |
Site collections in this farm are hosted on the Windows Internal Database and are larger than 4 gigabytes. |
Farm |
Error |
Pre-upgrade operation output
As rules are processed during the pre-upgrade scanning, the results from each rule are written to an XML log file and a text log file. These log files are written to the %COMMONPROGRAMFILES%\Microsoft Shared\web server extensions\12\LOGS directory and use the following naming convention, where a random number is used to differentiate between possible simultaneous attempts to run the pre-upgrade command:
PreUpgradeCheck_YYYYMMDD-hhmmss-millisecond-random-number.XML
PreUpgradeCheck_YYYYMMDD-hhmmss-millisecond-random-number.LOG
Both of the preceding log files contain the following information:
The checks that were run.
The issues that were found.
A description of how to fix the detected issue or a link to a KB article that pertains to the issue.
After the scan is finished, the XML results are transformed to HTML format that can be viewed as a page in the default Web browser. The file-naming convention for the transformed XML is PreUpgradeCheck_YYYYMMDD-hhmmss-millisecond-random-number.HTM. The result of this conversion is an HTML page that you can view in your Web browser.