Skip to content

running-upgrade-advisor-command-prompt.md

Latest commit

 

History

History
170 lines (138 loc) · 11.6 KB

running-upgrade-advisor-command-prompt.md

File metadata and controls

170 lines (138 loc) · 11.6 KB
title Running Upgrade Advisor (Command Prompt) | Microsoft Docs
ms.custom
ms.date 03/06/2017
ms.prod sql-server-2014
ms.reviewer
ms.technology database-engine
ms.topic conceptual
helpviewer_keywords
Upgrade Advisor [SQL Server], running
command prompt [Upgrade Advisor]
UpgradeAdvisorWizardCmd utility
XML formats [Upgrade Advisor]
ms.assetid 7c83049b-9227-4723-9b7f-66288bc6bd1d
author mashamsft
ms.author mathoma
manager craigg

Running Upgrade Advisor (Command Prompt)

Use the UpgradeAdvisorWizardCmd utility to run Upgrade Advisor from the command prompt. You can choose to receive results in XML format or in a file with comma-separated values.

Syntax

  
      UpgradeAdvisorWizardCmd [ -? ]  |   
    [ -ConfigFilefilename | <server_info> ]  
    [ -SqlUserlogin_id-SqlPasswordpassword ]  
    [ -CSV ]  
  
where <server_info> is any combination of the following:  
        -Serverserver_name-Instanceinstance_name-ASInstanceAS_instance_name-RSInstanceRS_instance_name

Arguments

-?
Displays the command syntax.

-ConfigFile filename
Is the path name and file name of an XML file that contains settings to use when you run the UpgradeAdvisorWizardCmd utility.

<server_info>
Specifies which computer and instance to analyze. Use these options if you are not using a configuration file.

<server_info> can be any combination of the following four arguments:

-Server server_name
Specifies the name of the computer to analyze. This can be the local computer, which is the default value, or a remote computer.

-Instance instance_name
Specifies the name of the instance to analyze. There is no default value. If you do not specify this parameter, the [!INCLUDEssDE] is not scanned. The value for a default instance of [!INCLUDEssNoVersion] is MSSQLSERVER. For a named instance, use the instance name.

-ASInstance AS_instance_name
Specifies the name of the instance of [!INCLUDEssASnoversion] to analyze. There is no default value. If you do not specify this value, [!INCLUDEssASnoversion] is not scanned. The value for a default instance of [!INCLUDEssASnoversion] is MSSQLServerOLAPService. For a named instance, use the instance name.

-RSInstance RS_instance_name
Specifies the name of the instance of [!INCLUDEssRSnoversion] to analyze. There is no default value. If you do not specify this value, [!INCLUDEssRSnoversion] is not scanned. The value for a default instance of [!INCLUDEssRSnoversion] is ReportServer. For a named instance, use the instance name.

-SqlUser login_id
If you are using [!INCLUDEssNoVersion] Authentication, this value is the [!INCLUDEssNoVersion] login that Upgrade Advisor will use to connect to the instance of [!INCLUDEssNoVersion]. If you do not specify a login, Windows Authentication is used to connect to the [!INCLUDEssNoVersion] instance.

-SqlPassword password
If you use the -SqlUser argument, use this argument to specify the password for the [!INCLUDEssNoVersion] login.

-CSV
Specifies to provide results as comma-separated values to a .csv file in addition to the standard XML results. Results are written to the My Documents\[!INCLUDEssNoVersion] Upgrade Advisor\110\Reports folder.

Return Values

The following table shows the values that UpgradeAdvisorWizardCmd returns.

Value Description
0 Analysis succeeded, no upgrade issues found.
positive integer Analysis succeeded, upgrade issues found.
negative integer Analysis failed.

Remarks

All information that is required to run the analysis, other than [!INCLUDEssNoVersion] Authentication user names and passwords, can be provided in an XML configuration file. This XML configuration file is documented in the template. If you do not use a configuration file, you can analyze all installed components in an instance of [!INCLUDEssNoVersion] using default settings by specifying computer names and instance names. See the "Element Descriptions" table later in this topic for a description of the default configuration file settings.

Configuration File Template

Use the following XML as a template for creating your own configuration files. You can modify the template to meet the needs of your organization.

<Configuration>  
    <Server> </Server>  
    <Instance></Instance>  
    <Components>  
        <SQLServer>  
            <Databases>  
                <Database></Database>  
            </Databases>  
            <TraceFiles>  
                <TraceFile></TraceFile>  
            </TraceFiles>  
            <BatchFiles>  
                <BatchFile></BatchFile>  
            </BatchFiles>  
            <BatchSeparator></BatchSeparator>  
        </SQLServer>  
        <AnalysisServices>  
            <ASInstance></ASInstance>  
            <Databases>  
                <Database></Database>  
            </Databases>  
        </AnalysisServices>  
        <ReportingServices>  
            <RSInstance></RSInstance>  
        </ReportingServices>  
        <IntegrationServices>  
            <PackagePath></PackagePath>  
        </IntegrationServices>  
    </Components>  
</Configuration>

Element Descriptions

Tag Definition Occurrence
Configuration Parent element for Upgrade Advisor configuration file. Required once per configuration file.
Server Name of the server to analyze. Optional once per configuration file. The default value is the local computer.
Instance Name of the [!INCLUDEssDE] instance to analyze. Optional once per configuration file. The default value is the default instance.

Required once per configuration file, if a [!INCLUDEssNoVersion] element or an IntegrationServices element is present on the server.
Components Contains elements that specify which components to analyze. Required once per configuration file.
SQLServer Contains analysis settings for an instance of the [!INCLUDEssDE]. Optional once per configuration file. If not specified, [!INCLUDEssDE] databases are not analyzed.
Databases for SQLServer element Contains a list of databases to analyze. Optional once per SQLServer element. If this element is not present, all databases in the instance are analyzed.
Database for SQLServer element Specifies the name of a database to analyze. Required once or more if the Databases element is present. If a Database element contains the value "*", all databases in the instance are analyzed. There is no default value.
TraceFiles Contains a list of trace files to analyze. Optional once per SQLServer element.
TraceFile Specifies the path and name of a trace file to analyze. Required once or more if the TraceFiles element is present. There is no default value.
BatchFiles Contains a list of batch files to analyze. Optional once per SQLServer element.
BatchFile Specifies a batch file to analyze. Can be multiple. Required once or more if the BatchFiles element is present. There is no default value.
BatchSeparator Specifies the batch separator used in your [!INCLUDEssNoVersion] batch files. Optional once per SQLServer element. The default value is GO.
AnalysisServices Contains analysis settings for [!INCLUDEssASnoversion]. Optional once per configuration file. If not specified, [!INCLUDEssASnoversion] databases are not analyzed.
ASInstance Specifies the name of an instance of [!INCLUDEssASnoversion]. Required once per AnalysisServices element. There is no default value.
Databases for Analysis Services element Contains a list of databases to analyze. Optional once per AnalysisServices element. If this element is not present, all databases in the instance are analyzed.
Database for AnalysisServices element Specifies the name of a database to analyze. Required once or more if the Databases element is present. If a Database element contains the value "*", all databases in the instance are analyzed. There is no default value.
ReportingServices Specifies to run analysis against [!INCLUDEssRSnoversion]. Optional once per configuration file. If not specified, [!INCLUDEssRSnoversion] is not analyzed.
RSInstance Specifies the name of an instance of [!INCLUDEssRSnoversion]. Required once per ReportingServices element. There is no default value.
IntegrationServices Contains analysis settings for [!INCLUDEssNoVersion] [!INCLUDEssISnoversion]. Optional once per configuration file. If not specified, [!INCLUDEssISnoversion] is not analyzed.
PackagePath Specifies the path of a set of [!INCLUDEssISnoversion] packages. Optional once per IntegrationServices element. If this element is not present, analysis occurs on the [!INCLUDEssNoVersion] instance, and no externally stored packages are analyzed. There is no default value.

Examples

A. Run Upgrade Advisor Using a Configuration File

The following example shows how to run Upgrade Advisor from the command prompt by using a configuration file that specifies what to analyze. This example uses Windows Authentication to connect to [!INCLUDEssNoVersion].

UpgradeAdvisorWizardCmd -ConfigFile "C:\My Documents\UpgradeConfig1.xml"

B. Run Upgrade Advisor Using Default Configuration Settings

The following example shows how to run Upgrade Advisor from the command prompt by using default configuration settings and Windows Authentication.

UpgradeAdvisorWizardCmd -Server MyServer -Instance MyInst

C. Run Upgrade Advisor Using [!INCLUDEssNoVersion] Authentication

The following example shows how to run Upgrade Advisor from the command prompt by using a configuration file. This example specifies a [!INCLUDEssNoVersion] user name and password to connect to the instance of [!INCLUDEssNoVersion].

UpgradeAdvisorWizardCmd -ConfigFile "C:\My Documents\UpgradeConfig1.xml"   
    -SqlUser "MyUserName" -SqlPassword "QweRTy-55"

See Also

Resolving Upgrade Issues
Working with Upgrade Advisor
Running Upgrade Advisor (User Interface)