| title | Install, Configure, or Uninstall SQL Server on Windows from the Command Prompt | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| description | This article describes command prompt parameters for SQL Server installation on Windows. You can specify features to install, configure, or uninstall. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| author | rwestMSFT | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ms.author | randolphwest | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ms.date | 11/18/2025 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ms.service | sql | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ms.subservice | install | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ms.topic | install-set-up-deploy | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ms.custom |
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| helpviewer_keywords |
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| monikerRange | >=sql-server-2016 |
[!INCLUDE SQL Server -Windows Only]
Before you run [!INCLUDE ssNoVersion] Setup, review Plan a SQL Server installation.
Installing a new instance of [!INCLUDE ssNoVersion] from the command prompt enables you to specify the features to install and how they should be configured. You can also specify silent, basic, or full interaction with the Setup user interface.
To install or configure your [!INCLUDE ssnoversion-md] instance from the command prompt, open an administrative command prompt and navigate to where setup.exe is located within the SQL Server Setup media. Run the setup.exe command, along with the required and optional parameters that accomplish what you're trying to do:
C:\SQLMedia\SQLServer2025> setup.exe /[Option] /[Option] = {value}
The following example installs the [!INCLUDE ssDEnoversion], [!INCLUDE ssNoVersion] Analysis Services, [!INCLUDE ssNoVersion], and Integration Services in quiet mode:
C:\SQLMedia\SQLServer2025> setup.exe /Q /IACCEPTSQLSERVERLICENSETERMS /ACTION="install"
/PID="AAAAA-BBBBB-CCCCC-DDDDD-EEEEE" /FEATURES=SQL,AS,IS
/INSTANCENAME=MSSQLSERVER /SQLSVCACCOUNT="MyDomain\MyAccount"
/SQLSVCPASSWORD="************" /SQLSYSADMINACCOUNTS="MyDomain\MyAccount "
/AGTSVCACCOUNT="MyDomain\MyAccount" /AGTSVCPASSWORD="************"
/ASSVCACCOUNT="MyDomain\MyAccount" /ASSVCPASSWORD="************"
/ISSVCACCOUNT="MyDomain\MyAccount" /ISSVCPASSWORD="************"
/ASSYSADMINACCOUNTS="MyDomain\MyAccount"To view a list of all possible commands within the console, run the executable with the /help flag:
C:\SQLMedia\SQLServer2025> setup.exe /helpImportant
The /PRODUCTCOVEREDBYSA installation parameter was introduced in [!INCLUDE sssql22-md]. This parameter indicates whether the provided product key (/PID=) license is covered under a Software Assurance or SQL Server Subscription contract, or just a SQL Server license.
The rest of the article provides a detailed description of the available parameters.
Note
When installing through the command line, [!INCLUDE ssNoVersion] supports full quiet mode with the /Q parameter, or quiet simple mode with the /QS parameter. The /QS switch only shows progress, doesn't accept any input, and displays no error messages if encountered. The /QS parameter is only supported when /ACTION=INSTALL is specified.
Regardless of the installation method, you're required to confirm acceptance of the software license terms as an individual or on behalf of an entity, unless your use of the software is governed by a separate agreement such as a Microsoft volume licensing agreement or a third-party agreement with an ISV or OEM.
The license terms are displayed for review and acceptance in the Setup user interface. Unattended installations (using the /Q or /QS parameters) must include the /IACCEPTSQLSERVERLICENSETERMS parameter. You can review the license terms separately at Microsoft Software License Terms.
[!INCLUDE sql-eula-link]
Depending on how you received the software (for example, through Microsoft volume licensing), your use of the software can be subject to additional terms and conditions.
Command line installation is supported in the following scenarios:
- Installing, upgrading, or removing an instance and shared components of [!INCLUDE ssNoVersion] on a local computer by using syntax and parameters specified from the command prompt.
- Installing, upgrading, or removing a failover cluster instance.
- Upgrading from one [!INCLUDE ssNoVersion] edition to another edition of [!INCLUDE ssNoVersion].
- Installing an instance of [!INCLUDE ssNoVersion] on a local computer by using syntax and parameters specified in a configuration file. You can use this method to copy an installation configuration to multiple computers, or to install multiple nodes of a failover cluster installation.
Note
For local installations, you must run Setup as an administrator. If you install [!INCLUDE ssNoVersion] from a remote share, you must use a domain account that has read and execute permissions on the remote share. For failover cluster installations, you must be a local administrator with permissions to login as a service, and to act as part of the operating system on all failover cluster nodes.
Use the following guidelines to develop installation commands that have correct syntax:
| Parameter | Example |
|---|---|
| /PARAMETER | /INDICATEPROGRESS |
| /PARAMETER=true/false | /SQLSVCINSTANTFILEINIT=True |
| /PARAMETER=1/0 for Boolean types | /TCPENABLED=1 |
| /PARAMETER="value" for all single-value parameters. For a parameter that requires a path: /INSTANCEDIR=C:\Path or /INSTANCEDIR="C:\Path" is supported. |
/PID="PID" /SQLSVCSTARTUPTYPE="Automatic" |
| /PARAMETER="value1" "value2" "value3" for all multiple-value parameters. Exception: /FEATURES, which is a multivalued parameter, but its format is /FEATURES=AS,RS,IS without a space, comma-delimited. |
/SQLSYSADMINACCOUNTS="Contoso\John" "Contoso\Mary" |
Important
When installing [!INCLUDE ssNoVersion], if you specify the same directory path for INSTANCEDIR and SQLUSERDBDIR, [!INCLUDE ssNoVersion] Agent and Full Text Search don't start due to missing permissions.
Note
The relational server values support the additional terminating backslash formats: backslash (\) or two backslash characters (\\) for the path.
The following sections provide parameters to develop command-line installation scripts for install, update, and repair scenarios. Parameters can take different values depending on the chosen scenario.
Parameters that are listed for a [!INCLUDE ssDEnoversion] component are specific to that component. [!INCLUDE ssNoVersion] Agent and [!INCLUDE ssNoVersion] Browser parameters are applicable when you install the [!INCLUDE ssDEnoversion].
- Installation parameters
- SysPrep parameters
- Upgrade parameters
- Repair parameters
- Rebuild system database parameters
- Uninstall parameters
- Failover cluster parameters
- Service account parameters
- Feature parameters
- Role parameters
- Control failover behavior using the /FAILOVERCLUSTERROLLOWNERSHIP parameter
- Instance ID or InstanceID configuration
Use the parameters in the following table to develop command-line scripts for installing a new instance of [!INCLUDE ssnoversion-md].
| [!INCLUDE ssDEnoversion] component | Parameter | Description |
|---|---|---|
| [!INCLUDE ssde-md] Setup Control | /ACTIONRequired |
Required to indicate the installation workflow. Supported values: Install. |
| [!INCLUDE ssde-md] Setup Control | /SUPPRESSPRIVACYSTATEMENTNOTICERequired, when the /Q or /QS parameter is specified for unattended installations |
Suppresses the privacy notice statement. By using this flag, you're agreeing with the privacy notice. |
| [!INCLUDE ssde-md] Setup Control | /IACCEPTSQLSERVERLICENSETERMSRequired, when the /Q or /QS parameter is specified for unattended installations |
Required to acknowledge acceptance of the license terms. Beginning with [!INCLUDE sssql22-md], read the Microsoft [!INCLUDE ssNoVersion] Software License Terms at aka.ms/useterms. |
| [!INCLUDE ssNoVersion] Python Setup Control | /IACCEPTPYTHONLICENSETERMSRequired, when the /Q or /QS parameter is specified for unattended installations that include the Anaconda Python package. |
Required to acknowledge acceptance of the license terms. |
| [!INCLUDE ssNoVersion] R Setup Control | /IACCEPTROPENLICENSETERMSRequired, when the /Q or /QS parameter is specified for unattended installations that include the Microsoft R Open package. |
Required to acknowledge acceptance of the license terms. |
| [!INCLUDE ssde-md] Setup Control | /ENUOptional |
Use this parameter to install the English version of [!INCLUDE ssNoVersion] on a localized operating system when the installation media includes language packs for both English and the language corresponding to the operating system. |
| [!INCLUDE ssde-md] Setup Control | /UpdateEnabledOptional |
Specify whether [!INCLUDE ssNoVersion] Setup should discover and include product updates. The valid values are True and False or 1 and 0. By default, [!INCLUDE ssNoVersion] Setup includes updates that are found. |
| [!INCLUDE ssde-md] Setup Control | /UpdateSourceOptional |
Specify the location where [!INCLUDE ssNoVersion] Setup obtains product updates. The valid values are "MU" to search [!INCLUDE msCoName] Update, a valid folder path, a relative path such as .\MyUpdates, or a UNC share. By default, [!INCLUDE ssNoVersion] Setup searches [!INCLUDE msCoName] Update or a Windows Update Service through the Windows Server Update Services. |
| [!INCLUDE ssde-md] Setup Control | /CONFIGURATIONFILEOptional |
Specifies the configuration file to use. |
| [!INCLUDE ssde-md] Setup Control | /ERRORREPORTINGApplies to: [!INCLUDE sssql14-md] and earlier versions Optional |
To manage how error feedback is sent to Microsoft, see Configure usage and diagnostic data collection for SQL Server (CEIP). In older versions, this value specifies the error reporting for [!INCLUDE ssNoVersion]. For more information, see SQL Server privacy supplement. Supported values: - 1 = enabled- 0 = disabled |
| [!INCLUDE ssde-md] Setup Control | /FEATURES or /ROLERequired |
Specifies the components to install. Choose /FEATURES to specify individual [!INCLUDE ssNoVersion] components to install. For more information, see Feature Parameters later in this article.Choose /ROLE to specify a setup role. Setup roles install [!INCLUDE ssNoVersion] in a predetermined configuration. |
| [!INCLUDE ssde-md] Setup Control | /HELP or ?Optional |
Displays usage options for the parameters. |
| [!INCLUDE ssde-md] Setup Control | /INDICATEPROGRESSOptional |
Specifies that the verbose Setup log file is piped to the console. |
| [!INCLUDE ssde-md] Setup Control | /INSTALLSHAREDDIROptional |
Specifies a nondefault installation directory for 64-bit shared components. Default is %Program Files%\Microsoft SQL ServerCan't be set to %Program Files(x86)%\Microsoft SQL Server |
| [!INCLUDE ssde-md] Setup Control | /INSTALLSHAREDWOWDIROptional |
Specifies a nondefault installation directory for 32-bit shared components. Supported only on a 64-bit system. Default is %Program Files(x86)%\Microsoft SQL ServerCan't be set to %Program Files%\Microsoft SQL Server |
| [!INCLUDE ssde-md] Setup Control | /INSTANCEDIROptional |
Specifies a nondefault installation directory for instance-specific components. |
| [!INCLUDE ssde-md] Setup Control | /INSTANCEIDOptional |
Specifies a nondefault value for an InstanceID. |
| [!INCLUDE ssde-md] Setup Control | /INSTANCENAMERequired |
Specifies a [!INCLUDE ssDEnoversion] instance name. For more information, see Installation Wizard help. |
| [!INCLUDE ssde-md] Setup Control | /PRODUCTCOVEREDBYSAApplies to: [!INCLUDE sssql22-md] and later versions Required, when installing the Azure Extension feature from the command prompt with AZUREEXTENSION. |
Specifies the license coverage for [!INCLUDE ssnoversion-md]./PRODUCTCOVEREDBYSA=True, or just /PRODUCTCOVEREDBYSA, indicates it's covered under Software Assurance or [!INCLUDE ssnoversion-md] subscription./PRODUCTCOVEREDBYSA=False, or omitting the parameter, indicates it's covered under a SQL Server license. |
| [!INCLUDE ssde-md] Setup Control | /PIDOptional |
Specifies the product key for the edition of [!INCLUDE ssNoVersion]. If this parameter isn't specified, Evaluation is used. Note: If you're installing [!INCLUDE ssExpress], [!INCLUDE ssExpress] with Advanced Services, [!INCLUDE ssExpress] with tools, [!INCLUDE ssdeveloper], or [!INCLUDE ssevaluation], the PID is predefined. |
| [!INCLUDE ssde-md] Setup Control | /Q or /QUIETOptional |
Specifies that Setup runs in a quiet mode without any user interface. This is used for unattended installations. The /Q parameter overrides the input of the /QS parameter. |
| [!INCLUDE ssde-md] Setup Control | /QS or /QUIETSIMPLEOptional |
Specifies that Setup runs and shows progress through the UI, but doesn't accept any input or show any error messages. |
| [!INCLUDE ssde-md] Setup Control | /UIMODEOptional |
Specifies whether to present only the minimum number of dialog boxes during setup./UIMODE can only be used with the /ACTION=INSTALL and UPGRADE parameters.Supported values: - /UIMODE=Normal is the default for non-Express editions and presents all setup dialog boxes for the selected features.- /UIMODE=AutoAdvance is the default for Express editions and skips nonessential dialog boxes.When combined with other parameters, UIMODE is overridden. For example, when /UIMODE=AutoAdvance and /ADDCURRENTUSERASSQLADMIN=FALSE are both provided, the provisioning dialog box isn't auto populated with the current user.The UIMODE setting can't be used with the /Q or /QS parameters. |
| [!INCLUDE ssde-md] Setup Control | /SQMREPORTINGApplies to: [!INCLUDE sssql14-md] and earlier versions Optional |
To manage how error feedback is sent to Microsoft, see Configure usage and diagnostic data collection for SQL Server (CEIP). In older versions this specifies feature usage reporting for [!INCLUDE ssNoVersion]. Supported values: - 1 = enabled- 0 = disabled |
| [!INCLUDE ssde-md] Setup Control | /HIDECONSOLEOptional |
Specifies that the console window is hidden or closed. |
| [!INCLUDE ssNoVersion] Agent | /AGTSVCACCOUNTRequired |
Specifies the account for the [!INCLUDE ssNoVersion] Agent service. |
| [!INCLUDE ssNoVersion] Agent | /AGTSVCPASSWORDRequired |
Specifies the password for [!INCLUDE ssNoVersion] Agent service account. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| [!INCLUDE ssNoVersion] Agent | /AGTSVCSTARTUPTYPEOptional |
Specifies the startup mode for the [!INCLUDE ssNoVersion] Agent service. Supported values: - Automatic- Disabled- Manual |
| PolyBase Engine | /PBENGSVCACCOUNTOptional |
Specifies the account for the engine service. Default value: NT AUTHORITY\NETWORK SERVICE. |
| PolyBase Engine | /PBENGSVCPASSWORDOptional |
Specifies the password for the engine service account. |
| PolyBase Engine | /PBENGSVCSTARTUPTYPEOptional |
Specifies the startup mode for the PolyBase Engine service. Supported values: - Automatic (default)- Disabled- Manual |
| PolyBase Data Movement | /PBDMSSVCACCOUNTOptional |
Specifies the account for the data movement service. Default value: NT AUTHORITY\NETWORK SERVICE. |
| PolyBase Data Movement | /PBDMSSVCPASSWORDOptional |
Specifies the password for the data movement account. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| PolyBase Data Movement | /PBDMSSVCSTARTUPTYPEOptional |
Specifies the startup mode for the data movement service. Supported values: - Automatic (default)- Disabled- Manual |
| PolyBase | /PBPORTRANGEOptional |
Specifies a port range with at least six ports for PolyBase services. Example:/PBPORTRANGE=16450-16460 |
| PolyBase | /PBSCALEOUTOptional |
Specifies if the [!INCLUDE ssDEnoversion] instance is used as a part of PolyBase Scale-out computational group. Use this option if you're configuring a PolyBase Scale-out computational group including the head node. Supported values: True, False |
| [!INCLUDE ssASnoversion] | /ASBACKUPDIROptional |
Specifies the directory for [!INCLUDE ssASnoversion] backup files. Default values: For WOW mode on 64-bit: %Program Files(x86)%\Microsoft SQL Server\<INSTANCEDIR>\<ASInstanceID>\OLAP\BackupFor all other installations: %Program Files%\Microsoft SQL Server\<INSTANCEDIR>\<ASInstanceID>\OLAP\Backup |
| [!INCLUDE ssASnoversion] | /ASCOLLATIONOptional |
Specifies the collation setting for [!INCLUDE ssASnoversion]. Default value: Latin1_General_CI_ASNote: Only Windows collation is supported. Using SQL collation can result in unexpected behavior. |
| [!INCLUDE ssASnoversion] | /ASCONFIGDIROptional |
Specifies the directory for [!INCLUDE ssASnoversion] configuration files. Default values: For WOW mode on 64-bit: %Program Files(x86)%\Microsoft SQL Server\<INSTANCEDIR>\<ASInstanceID>\OLAP\ConfigFor all other installations: %Program Files%\Microsoft SQL Server\<INSTANCEDIR>\<ASInstanceID>\OLAP\Config |
| [!INCLUDE ssASnoversion] | /ASDATADIROptional |
Specifies the directory for [!INCLUDE ssASnoversion] data files. Default values: For WOW mode on 64-bit: %Program Files(x86)%\Microsoft SQL Server\<INSTANCEDIR>\<ASInstanceID>\OLAP\DataFor all other installations: %Program Files%\Microsoft SQL Server\<INSTANCEDIR>\<ASInstanceID>\OLAP\Data |
| [!INCLUDE ssASnoversion] | /ASLOGDIROptional |
Specifies the directory for [!INCLUDE ssASnoversion] log files. Default values: For WOW mode on 64-bit: %Program Files(x86)%\Microsoft SQL Server\<INSTANCEDIR>\<ASInstanceID>\OLAP\LogFor all other installations: %Program Files%\Microsoft SQL Server\<INSTANCEDIR>\<ASInstanceID>\OLAP\Log |
| [!INCLUDE ssASnoversion] | /ASSERVERMODEOptional |
Specifies the server mode of the [!INCLUDE ssASnoversion] instance. Valid values in a cluster scenario are MULTIDIMENSIONAL or TABULAR. ASSERVERMODE is case-sensitive. All values must be expressed in uppercase. For more information about valid values, see Install Analysis Services in Tabular Mode. |
| [!INCLUDE ssASnoversion] | /ASSVCACCOUNTRequired |
Specifies the account for the [!INCLUDE ssASnoversion] service. |
| [!INCLUDE ssASnoversion] | /ASSVCPASSWORDRequired |
Specifies the password for the [!INCLUDE ssASnoversion] service. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| [!INCLUDE ssASnoversion] | /ASSVCSTARTUPTYPEOptional |
Specifies the startup mode for the [!INCLUDE ssASnoversion] service. Supported values: - Automatic- Disabled- Manual |
| [!INCLUDE ssASnoversion] | /ASSYSADMINACCOUNTSRequired |
Specifies the administrator credentials for [!INCLUDE ssASnoversion]. |
| [!INCLUDE ssASnoversion] | /ASTEMPDIROptional |
Specifies the directory for [!INCLUDE ssASnoversion] temporary files. Default values: For WOW mode on 64-bit: %Program Files(x86)%\Microsoft SQL Server\<INSTANCEDIR>\<ASInstanceID>\OLAP\TempFor all other installations: %Program Files%\Microsoft SQL Server\<INSTANCEDIR>\<ASInstanceID>\OLAP\Temp |
| [!INCLUDE ssASnoversion] | /ASPROVIDERMSOLAPOptional |
Specifies whether the MSOLAP provider can run in-process. Default value: - 1 = enabled |
| [!INCLUDE ssASnoversion] | /FARMACCOUNTRequired, for SPI_AS_NewFarm |
Specifies a domain user account for running SharePoint Central Administration services and other essential services in a farm. This parameter is used only for [!INCLUDE ssASnoversion] instances that are installed through /ROLE = SPI_AS_NEWFARM. |
| [!INCLUDE ssASnoversion] | /FARMPASSWORDRequired, for SPI_AS_NewFarm |
Specifies a password for the farm account. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| [!INCLUDE ssASnoversion] | /PASSPHRASERequired, for SPI_AS_NewFarm |
Specifies a passphrase that is used to add additional application servers or Web front-end servers to a SharePoint farm. This parameter is used only for [!INCLUDE ssASnoversion] instances that are installed through /ROLE = SPI_AS_NEWFARM. |
| [!INCLUDE ssASnoversion] | /FARMADMINIPORTRequired, for SPI_AS_NewFarm |
Specifies a port used to connect to the SharePoint Central Administration web application. This parameter is used only for [!INCLUDE ssASnoversion] instances that are installed through /ROLE = SPI_AS_NEWFARM. |
| [!INCLUDE ssNoVersion] Browser | /BROWSERSVCSTARTUPTYPEOptional |
Specifies the startup mode for [!INCLUDE ssNoVersion] Browser service. Supported values: - Automatic- Disabled- Manual |
| [!INCLUDE ssDEnoversion] | /ENABLERANUOptional |
Enables run-as credentials for [!INCLUDE ssExpress] installations. |
| [!INCLUDE ssDEnoversion] | /INSTALLSQLDATADIROptional |
Specifies the data directory for [!INCLUDE ssNoVersion] data files. Default values: For WOW mode on 64-bit: %Program Files(x86)%\Microsoft SQL Server\For all other installations: %Program Files%\Microsoft SQL Server\ |
| [!INCLUDE ssDEnoversion] | /SAPWDRequired, when /SECURITYMODE=SQL |
Specifies the password for the [!INCLUDE ssNoVersion] SA account. |
| [!INCLUDE ssDEnoversion] | /SECURITYMODEOptional |
Specifies the security mode for [!INCLUDE ssNoVersion]. If this parameter isn't supplied, then Windows-only authentication mode is supported. Supported value: SQL |
| [!INCLUDE ssDEnoversion] | /SQLBACKUPDIROptional |
Specifies the directory for backup files. Default value: <InstallSQLDataDir>\<SQLInstanceID>\MSSQL\Backup |
| [!INCLUDE ssDEnoversion] | /SQLCOLLATIONOptional |
Specifies the collation settings for [!INCLUDE ssNoVersion]. The default installation setting is determined by the operating system (OS) locale. The server-level collation can either be changed during setup, or by changing the OS locale before installation. The default collation is set to the oldest available version that is associated with each specific locale. This is due to backward compatibility reasons. Therefore, this isn't always the recommended collation. To take full advantage of [!INCLUDE ssNoVersion] features, change the default installation settings to use Windows collations. For example, for the OS locale English (United States) (code page 1252), the default collation during setup is SQL_Latin1_General_CP1_CI_AS and can be changed to its closest Windows collation counterpart Latin1_General_100_CI_AS_SC.For more information, see Collation and Unicode support. |
| [!INCLUDE ssDEnoversion] | /ADDCURRENTUSERASSQLADMINOptional |
Adds the current user to the [!INCLUDE ssNoVersion] sysadmin fixed server role. The /ADDCURRENTUSERASSQLADMIN parameter can be used when installing Express editions or when /ROLE=AllFeatures_WithDefaults is used. For more information, see /ROLE later in this article.Use of /ADDCURRENTUSERASSQLADMIN is optional, but either /ADDCURRENTUSERASSQLADMIN or /SQLSYSADMINACCOUNTS is required.Default values: True for editions of [!INCLUDE ssExpress]False for all other editions |
| [!INCLUDE ssDEnoversion] | /SQLSVCACCOUNTRequired |
Specifies the startup account for the [!INCLUDE ssNoVersion] service. |
| [!INCLUDE ssDEnoversion] | /SQLSVCPASSWORDRequired |
Specifies the password for SQLSVCACCOUNT. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| [!INCLUDE ssDEnoversion] | /SQLSVCSTARTUPTYPEOptional |
Specifies the startup mode for the [!INCLUDE ssNoVersion] service. Supported values: - Automatic- Disabled- Manual |
| [!INCLUDE ssDEnoversion] | /SQLSYSADMINACCOUNTSRequired |
Use this parameter to provision logins to be members of the sysadmin role. For [!INCLUDE ssNoVersion] editions other than [!INCLUDE ssExpress], /SQLSYSADMINACCOUNTS is required. For editions of [!INCLUDE ssExpress], use of /SQLSYSADMINACCOUNTS is optional, but either /SQLSYSADMINACCOUNTS or /ADDCURRENTUSERASSQLADMIN is required. |
| [!INCLUDE ssDEnoversion] | /SQLTEMPDBDIROptional |
Specifies the directories for tempdb data files. When specifying more than one directory, separate the directories with a blank space. If multiple directories are specified, the tempdb data files are spread across the directories in a round-robin fashion.Default value: <InstallSQLDataDir>\<SQLInstanceID>\MSSQL\Data (System Data Directory)Note: This parameter is added to RebuildDatabase scenario as well. |
| [!INCLUDE ssDEnoversion] | /SQLTEMPDBLOGDIROptional |
Specifies the directory for tempdb log file.Default value: <InstallSQLDataDir>\<SQLInstanceID>\MSSQL\Data (System Data Directory)Note: This parameter is added to RebuildDatabase scenario as well. |
| [!INCLUDE ssDEnoversion] | /SQLTEMPDBFILECOUNTOptional |
Specifies the number of tempdb data files to be added by setup. This value can be increased up to the number of cores.Default value: 1 for [!INCLUDE ssExpress] 8 or the number of cores, whichever is lower for all other editions Important: The primary database file for tempdb is still tempdb.mdf. The additional tempdb files are named as tempdb_mssql_#.ndf where # represents a unique number for each additional tempdb database file created during setup. The purpose of this naming convention is to make them unique. Uninstalling an instance of [!INCLUDE ssNoVersion] deletes the files with naming convention tempdb_mssql_#.ndf. Don't use tempdb_mssql_\*.ndf naming convention for user database files.Warning: [!INCLUDE ssExpress] isn't supported for configuring this parameter. Setup installs only 1 tempdb data file. |
| [!INCLUDE ssDEnoversion] | /SQLTEMPDBFILESIZEApplies to: [!INCLUDE sssql16-md] and later versions Optional |
Specifies the initial size of each tempdb data file.Default = 4 MB for [!INCLUDE ssExpress], 8 MB for all other editions Min = 4 MB or 8 MB Max = 1024 MB |
| [!INCLUDE ssDEnoversion] | /SQLTEMPDBFILEGROWTHOptional |
Specifies the file growth increment of each tempdb data file in MB. A value of 0 indicates that automatic growth is off and no additional space is allowed. Setup allows the size up to 1024.Default value: 64. Allowed range: Min = 0, Max = 1024 |
| [!INCLUDE ssDEnoversion] | /SQLTEMPDBLOGFILESIZEApplies to: [!INCLUDE sssql16-md] and later versions Optional |
Specifies the initial size of the tempdb log file in MB. Setup allows the size up to 1024.Default value: 4 for [!INCLUDE ssExpress] 8 for all other editions Allowed range: Min = default value (4 or 8), Max = 1024 |
| [!INCLUDE ssDEnoversion] | /SQLTEMPDBLOGFILEGROWTHApplies to: [!INCLUDE sssql16-md] and later versions Optional |
Specifies the file growth increment of the tempdb log file in MB. A value of 0 indicates that automatic growth is off and no additional space is allowed. Setup allows the size up to 1024.Default value: 64. Allowed range: Min = 0, Max = 1024 |
| [!INCLUDE ssDEnoversion] | /SQLUSERDBDIROptional |
Specifies the directory for the data files for user databases. Default value: <InstallSQLDataDir>\<SQLInstanceID>\MSSQL\Data |
| [!INCLUDE ssDEnoversion] | /SQLSVCINSTANTFILEINITOptional |
Enables instant file initialization for [!INCLUDE ssNoVersion] service account. For security and performance considerations, see Database instant file initialization. Supported values: - False (default)- True |
| [!INCLUDE ssDEnoversion] | /SQLUSERDBLOGDIROptional |
Specifies the directory for the log files for user databases. Default value: <InstallSQLDataDir>\<SQLInstanceID>\MSSQL\Data |
| [!INCLUDE ssDEnoversion] | /SQLMAXDOP=parameterApplies to: [!INCLUDE sql-server-2019] and later versions Optional. If omitted on unattended (silent) installs, MAXDOP aligns with the max degree of parallelism guidelines. |
Specifies the max degree of parallelism, which determines how many processors a single statement can utilize during the execution of a single statement. Default value aligns with the max degree of parallelism guidelines |
| [!INCLUDE ssDEnoversion] | /USESQLRECOMMENDEDMEMORYLIMITSApplies to: [!INCLUDE sql-server-2019] and later versions Optional. If /USESQLRECOMMENDEDMEMORYLIMITS, /SQLMINMEMORY, and /SQLMAXMEMORY are omitted on unattended (silent) installs, the [!INCLUDE ssDEnoversion] uses the default [!INCLUDE ssNoVersion] memory configuration. |
Specifies that the [!INCLUDE ssDEnoversion] uses calculated recommended values that align with the server memory configuration guidelines for a standalone [!INCLUDE ssNoVersion] instance. Note: This parameter can't be used with /SQLMINMEMORY and /SQLMAXMEMORY. |
| [!INCLUDE ssDEnoversion] | /SQLMINMEMORYApplies to: [!INCLUDE sql-server-2019] and later versions Optional. If /USESQLRECOMMENDEDMEMORYLIMITS, /SQLMINMEMORY, and /SQLMAXMEMORY are omitted on unattended (silent) installs, the [!INCLUDE ssDEnoversion] uses the default [!INCLUDE ssNoVersion] memory configuration. |
Specifies the Min Server Memory configuration in MB. Default value: 0. Note: This parameter can't be used with /USESQLRECOMMENDEDMEMORYLIMITS. |
| [!INCLUDE ssDEnoversion] | /SQLMAXMEMORYApplies to: [!INCLUDE sql-server-2019] and later versions Optional. If /USESQLRECOMMENDEDMEMORYLIMITS, /SQLMINMEMORY, and /SQLMAXMEMORY are omitted on unattended (silent) installs, the [!INCLUDE ssDEnoversion] uses the default [!INCLUDE ssNoVersion] memory configuration. |
Specifies the Max Server Memory configuration in MB. Default value: calculated recommended value that aligns with the server memory configuration guidelines for a standalone [!INCLUDE ssNoVersion] instance. Note: This parameter can't be used with /USESQLRECOMMENDEDMEMORYLIMITS. |
| FILESTREAM | /FILESTREAMLEVELOptional |
Specifies the access level for the FILESTREAM feature. Supported values: - 0 = disable FILESTREAM support for this instance. (Default value)- 1 = enable FILESTREAM for [!INCLUDE tsql] access.- 2 = enable FILESTREAM for [!INCLUDE tsql] and file I/O streaming access. (Not valid for Cluster scenarios)- 3 = allow remote clients to have streaming access to FILESTREAM data. |
| FILESTREAM | /FILESTREAMSHARENAMEOptional Required when FILESTREAMLEVEL is greater than 1. |
Specifies the name of the Windows share in which the FILESTREAM data will be stored. |
| [!INCLUDE ssNoVersion] Full Text | /FTSVCACCOUNTOptional |
Specifies the account for Full-Text filter launcher service. This parameter is ignored in [!INCLUDE winserver2008] or higher. ServiceSID is used to help secure the communication between [!INCLUDE ssNoVersion] and Full-text Filter Daemon. If the values aren't provided, the Full-text Filter Launcher Service is disabled. You have to use [!INCLUDE ssNoVersion] Control Manager to change the service account and enable full-text functionality. Default value: Local Service Account |
| [!INCLUDE ssNoVersion] Full Text | /FTSVCPASSWORDOptional |
Specifies the password for the Full-Text filter launcher service. This parameter is ignored in [!INCLUDE winserver2008] or higher. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| [!INCLUDE ssISnoversion] | /ISSVCACCOUNTRequired |
Specifies the account for [!INCLUDE ssISnoversion]. Default value: NT AUTHORITY\NETWORK SERVICE |
| [!INCLUDE ssISnoversion] | /ISSVCPASSWORDRequired |
Specifies the [!INCLUDE ssISnoversion] password. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| [!INCLUDE ssISnoversion] | /ISSVCStartupTypeOptional |
Specifies the startup mode for the [!INCLUDE ssISnoversion] service. |
| [!INCLUDE ssNoVersion] Network Configuration | /NPENABLEDOptional |
Specifies the state of the Named Pipes protocol for the [!INCLUDE ssNoVersion] service. Supported values: - 0 = disable the Named Pipes protocol- 1 = enable the Named Pipes protocol |
| [!INCLUDE ssNoVersion] Network Configuration | /TCPENABLEDOptional |
Specifies the state of the TCP protocol for the [!INCLUDE ssNoVersion] service. Supported values: - 0 = disable the TCP protocol- 1 = enable the TCP protocol |
| [!INCLUDE ssRSnoversion] | /RSINSTALLMODEApplies to: [!INCLUDE sssql16-md] and earlier versions Optional Available only on FilesOnlyMode |
Specifies the Install mode for [!INCLUDE ssRSnoversion]. Supported values: - SharePointFilesOnlyMode- DefaultNativeMode- FilesOnlyModeNote: If the installation includes the [!INCLUDE ssNoVersion] [!INCLUDE ssDE], the default RSINSTALLMODE is DefaultNativeMode.If the installation doesn't include the [!INCLUDE ssNoVersion] [!INCLUDE ssDE], the default RSINSTALLMODE is FilesOnlyMode.If you choose DefaultNativeMode but the installation doesn't include the [!INCLUDE ssNoVersion] [!INCLUDE ssDE], the installation automatically changes the RSINSTALLMODE to FilesOnlyMode. |
| [!INCLUDE ssRSnoversion] | /RSSVCACCOUNTApplies to: [!INCLUDE sssql16-md] and earlier versions Required |
Specifies the startup account for the [!INCLUDE ssRSnoversion]. |
| [!INCLUDE ssRSnoversion] | /RSSVCPASSWORDApplies to: [!INCLUDE sssql16-md] and earlier versions Required |
Specifies the password for the startup account for the [!INCLUDE ssRSnoversion] service. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| [!INCLUDE ssRSnoversion] | /RSSVCStartupTypeApplies to: [!INCLUDE sssql16-md] and earlier versions Optional |
Specifies the startup mode for [!INCLUDE ssRSnoversion]. Supported values: - Automatic- Disabled- Manual |
| Python/Machine Learning Services (In-Database) | /MPYCACHEDIRECTORYOptional |
Reserved for future use. Use %TEMP% to store Python .CAB files for installation on a computer that doesn't have an internet connection. |
| R/Machine Learning Services (In-Database) | /MRCACHEDIRECTORYOptional |
Use this parameter to specify the Cache directory for Microsoft R Open, [!INCLUDE sssql16-md] R Services, [!INCLUDE sssql16-md] R Server (Standalone), or R feature support in [!INCLUDE ssNoVersion] Machine Learning Services or Machine Learning Server (Standalone). This setting is typically used when installing R components from the command prompt on a computer without Internet access. |
| Java/Language Extensions | /SQL_INST_JAVA,/SQLJAVADIR = "path"Applies to: [!INCLUDE sssql19-md] only Optional |
Specifies installing Java with Language Extensions. If /SQL_INST_JAVA is provided without the /SQLJAVADIR parameter, it's assumed you want to install the Zulu Open JRE that is provided by the installation media.Providing a path for /SQLJAVADIR indicates you would like to use an already-installed JRE or JDK. |
| Azure extension for SQL Server | /FEATURES=AZUREEXTENSIONApplies to: [!INCLUDE sssql22-md] and later versions Optional |
For [!INCLUDE sssql22-md] and later versions, connect the instance to Azure Arc. For [!INCLUDE sssql25-md], connect the instance to Azure Arc or [!INCLUDE ssnoversion-md] on Azure VM. |
| Azure extension for SQL Server | /AZURESUBSCRIPTIONIDApplies to: [!INCLUDE sssql22-md] and later versions Optional |
Azure subscription where the [!INCLUDE ssNoVersion] instance resource will be created. |
| Azure extension for SQL Server | /AZURERESOURCEGROUPApplies to: [!INCLUDE sssql22-md] and later versions Optional |
Azure resource group where the [!INCLUDE ssNoVersion] instance resource will be created. |
| Azure extension for SQL Server | /AZUREREGIONApplies to: [!INCLUDE sssql22-md] and later versions Optional |
Azure region where the [!INCLUDE ssNoVersion] instance resource will be created. |
| Azure extension for SQL Server | /AZURETENANTIDApplies to: [!INCLUDE sssql22-md] and later versions Optional |
Azure tenant ID in which the service principal exists. |
| Azure extension for SQL Server | /AZURESERVICEPRINCIPALApplies to: [!INCLUDE sssql22-md] and later versions Optional |
Service principal to authenticate against given tenant ID, subscription, and resource group. |
| Azure extension for SQL Server | /AZURESERVICEPRINCIPALSECRETApplies to: [!INCLUDE sssql22-md] and later versions Optional |
Service principal secret. |
| Azure extension for SQL Server | /AZUREARCPROXYApplies to: [!INCLUDE sssql22-md] and later versions Optional |
Name of the proxy server used to connect to Azure Arc. |
To install a new, stand-alone instance with the [!INCLUDE ssDEnoversion], Replication, and Full-Text Search components and enable instant file initialization for [!INCLUDE ssDEnoversion].
setup.exe /q /ACTION=Install /FEATURES=SQL /INSTANCENAME=MSSQLSERVER /SQLSVCACCOUNT="<DomainName\UserName>" /SQLSVCPASSWORD="<StrongPassword>" /SQLSYSADMINACCOUNTS="<DomainName\UserName>" /AGTSVCACCOUNT="NT AUTHORITY\NETWORK SERVICE" /SQLSVCINSTANTFILEINIT="True" /IACCEPTSQLSERVERLICENSETERMSBeginning with [!INCLUDE sssql22-md], you can install the Azure Arc agent with the Azure extension for SQL Server using SQL Server setup. When you install the Azure Arc agent and SQL Server extension, you automatically Arc-enable all the instances on the host, which registers the SQL Server instances as resources in Azure and make them eligible to have additional Azure management services attached.
Beginning with [!INCLUDE sssql25-md], you can install the Azure extension for SQL Server using SQL Server setup on Azure virtual machines. When you install the Azure SQL Server extension, you automatically register with SQL Server on Azure VM service and enable the additional management capabilities that the service provides.
The following example installs a SQL Server instance, the Azure Arc agent (if not on an Azure VM), and the Azure extension for SQL Server so that the SQL Server instance is connected to Azure after installation. Before you run the example, replace the information in angle brackets ( < ... > ) with your information.
setup.exe /qs /ACTION=Install /FEATURES=SQLEngine,AZUREEXTENSION /INSTANCENAME=<instance name> /SQLSYSADMINACCOUNTS="<sysadmin account>" /IACCEPTSQLSERVERLICENSETERMS /AZURESUBSCRIPTIONID="<Azure subscription>" /AZURETENANTID="<Azure tenant ID>" /AZURERESOURCEGROUP="<resource group name>" /AZURESERVICEPRINCIPAL="<service principal>" /AZURESERVICEPRINCIPALSECRET="<secret>" /AZUREREGION=<Azure region>The following example installs the Azure Arc agent and Azure extension for SQL Server to manage all the existing [!INCLUDE ssNoVersion] instances that are installed.
setup.exe /qs /ACTION=Install /FEATURES=AZUREEXTENSION /IACCEPTSQLSERVERLICENSETERMS /AZURESUBSCRIPTIONID="<Azure subscription>" /AZURETENANTID="<Azure tenant ID>" /AZURERESOURCEGROUP="<resource group name>" /AZURESERVICEPRINCIPAL="<service principal>" /AZURESERVICEPRINCIPALSECRET="<secret>" /AZUREREGION=<Azure region>The following example shows how to remove the Azure extension for SQL Server using SQL Server setup:
Note
This command doesn't physically uninstall the Azure extension for SQL Server. Instead, the command marks this feature as not selected in the setup. To remove the Azure resource for this instance, go to Azure portal and delete.
setup.exe /qs /ACTION=Uninstall /FEATURES=AZUREEXTENSION /IACCEPTSQLSERVERLICENSETERMSFor more information about connecting to Azure Arc or [!INCLUDE ssnoversion-md] on Azure VM, see:
- SQL Server enabled by Azure Arc
- Connect your SQL Server to Azure Arc
- What is SQL Server on Azure Windows Virtual Machines?
- Register Windows SQL Server VM with SQL IaaS Agent extension
For more information about [!INCLUDE ssNoVersion] SysPrep, see Install SQL Server with SysPrep.
Use the parameters in the following table to develop command-line scripts for preparing an instance of [!INCLUDE ssNoVersion] without configuring it.
| [!INCLUDE ssDEnoversion] component | Parameter | Description |
|---|---|---|
| [!INCLUDE ssde-md] Setup Control | /ACTIONRequired |
Required to indicate the installation workflow. Supported values: PrepareImage |
| [!INCLUDE ssde-md] Setup Control | /IACCEPTSQLSERVERLICENSETERMSRequired, when the /Q or /QS parameter is specified for unattended installations |
Required to acknowledge acceptance of the license terms. Beginning with [!INCLUDE sssql22-md], read the Microsoft [!INCLUDE ssNoVersion] Software License Terms at aka.ms/useterms. |
| [!INCLUDE ssde-md] Setup Control | /ENUOptional |
Use this parameter to install the English version of [!INCLUDE ssNoVersion] on a localized operating system when the installation media includes language packs for both English and the language corresponding to the operating system. |
| [!INCLUDE ssde-md] Setup Control | /UpdateEnabledOptional |
Specify whether [!INCLUDE ssNoVersion] Setup should discover and include product updates. The valid values are True and False or 1 and 0. By default, [!INCLUDE ssNoVersion] Setup includes updates that are found. |
| [!INCLUDE ssde-md] Setup Control | /UpdateSourceOptional |
Specify the location where [!INCLUDE ssNoVersion] Setup obtains product updates. The valid values are "MU" to search [!INCLUDE msCoName] Update, a valid folder path, a relative path such as .\MyUpdates, or a UNC share. By default, [!INCLUDE ssNoVersion] Setup searches [!INCLUDE msCoName] Update or a Windows Update Service through the Windows Server Update Services. |
| [!INCLUDE ssde-md] Setup Control | /CONFIGURATIONFILEOptional |
Specifies the configuration file to use. |
| [!INCLUDE ssde-md] Setup Control | /FEATURESRequired |
Specifies components to install. Supported values are SQLEngine, Replication, FullText, DQ, AS, AS_SPI, RS, RS_SHP, RS_SHPWFE, DQC, Conn, IS, BC, SDK, DREPLAY_CTLR, DREPLAY_CLT, SNAC_SDK, SQLODBC, SQLODBC_SDK, LocalDB, MDS, POLYBASE 1 |
| [!INCLUDE ssde-md] Setup Control | /HELP or ?Optional |
Displays usage options for the parameters. |
| [!INCLUDE ssde-md] Setup Control | /HIDECONSOLEOptional |
Specifies that the console window is hidden or closed. |
| [!INCLUDE ssde-md] Setup Control | /INDICATEPROGRESSOptional |
Specifies that the verbose Setup log file is piped to the console. |
| [!INCLUDE ssde-md] Setup Control | /INSTALLSHAREDDIROptional |
Specifies a nondefault installation directory for 64-bit shared components. Default is %Program Files%\Microsoft SQL ServerCan't be set to %Program Files(x86)%\Microsoft SQL Server |
| [!INCLUDE ssde-md] Setup Control | /INSTANCEDIROptional |
Specifies a nondefault installation directory for instance-specific components. |
| [!INCLUDE ssde-md] Setup Control | /INSTANCEIDRequired for instance features. |
Specifies an InstanceID for the instance that's being prepared. |
| PolyBase Engine | /PBENGSVCACCOUNTOptional |
Specifies the account for the engine service. Default value: NT AUTHORITY\NETWORK SERVICE. |
| PolyBase Data Movement | /PBDMSSVCPASSWORDOptional |
Specifies the password for the data movement account. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| PolyBase Engine | /PBENGSVCSTARTUPTYPEOptional |
Specifies the startup mode for the PolyBase Engine service. Supported values: - Automatic (default)- Disabled- Manual |
| PolyBase | /PBPORTRANGEOptional |
Specifies a port range with at least six ports for PolyBase services. Example:/PBPORTRANGE=16450-16460 |
| PolyBase | /PBSCALEOUTOptional |
Specifies if the [!INCLUDE ssDEnoversion] instance is used as a part of PolyBase Scale-out computational group. Use this option if you're configuring a PolyBase Scale-out computational group including the head node. Supported values: True, False |
| [!INCLUDE ssde-md] Setup Control | /Q or /QUIETOptional |
Specifies that Setup runs in a quiet mode without any user interface. This is used for unattended installations. The /Q parameter overrides the input of the /QS parameter. |
| [!INCLUDE ssde-md] Setup Control | /QS or /QUIETSIMPLEOptional |
Specifies that Setup runs and shows progress through the UI, but doesn't accept any input or show any error messages. |
1 Distributed Replay, SDK, and SNAC aren't available in [!INCLUDE sssql22-md] and later versions.
To prepare a new, stand-alone instance with the [!INCLUDE ssDEnoversion], Replication, and Full-Text Search components, and [!INCLUDE ssRSnoversion].
setup.exe /q /ACTION=PrepareImage /FEATURES=SQL,RS /InstanceID =<MYINST> /IACCEPTSQLSERVERLICENSETERMSUse the parameters in the following table to develop command-line scripts for completing and configuring a prepared instance of [!INCLUDE ssNoVersion].
| [!INCLUDE ssNoVersion] component | Parameter | Description |
|---|---|---|
| [!INCLUDE ssde-md] Setup Control | /ACTIONRequired |
Required to indicate the installation workflow. Supported values: CompleteImage |
| [!INCLUDE ssde-md] Setup Control | /IACCEPTSQLSERVERLICENSETERMSRequired, when the /Q or /QS parameter is specified for unattended installations |
Required to acknowledge acceptance of the license terms. Beginning with [!INCLUDE sssql22-md], read the Microsoft [!INCLUDE ssNoVersion] Software License Terms at aka.ms/useterms. |
| [!INCLUDE ssde-md] Setup Control | /ENUOptional |
Use this parameter to install the English version of [!INCLUDE ssNoVersion] on a localized operating system when the installation media includes language packs for both English and the language corresponding to the operating system. |
| [!INCLUDE ssde-md] Setup Control | /CONFIGURATIONFILEOptional |
Specifies the configuration file to use. |
| [!INCLUDE ssde-md] Setup Control | /ERRORREPORTINGApplies to: [!INCLUDE sssql14-md] and earlier versions Optional |
To manage how error feedback is sent to Microsoft, see Configure usage and diagnostic data collection for SQL Server (CEIP). In older versions this specifies the error reporting for [!INCLUDE ssNoVersion]. For more information, see SQL Server privacy supplement. Supported values: - 1 = enabled- 0 = disabled |
| [!INCLUDE ssde-md] Setup Control | /HELP or ?Optional |
Displays usage options for the parameters. |
| [!INCLUDE ssde-md] Setup Control | /INDICATEPROGRESSOptional |
Specifies that the verbose Setup log file is piped to the console. |
| [!INCLUDE ssde-md] Setup Control | /INSTANCEIDOptional |
Use the Instance ID specified during the prepare image step. Supported values: InstanceID of a prepared instance. |
| [!INCLUDE ssde-md] Setup Control | /INSTANCENAMEOptional |
Specifies a [!INCLUDE ssNoVersion] instance name for the instance that's being completed. For more information, see Installation Wizard help. |
| [!INCLUDE ssde-md] Setup Control | /PRODUCTCOVEREDBYSAApplies to: [!INCLUDE sssql22-md] and later versions Required, when installing the Azure Extension feature from the command prompt with AZUREEXTENSION. |
Specifies the license coverage for [!INCLUDE ssnoversion-md]./PRODUCTCOVEREDBYSA=True, or just /PRODUCTCOVEREDBYSA, indicates it's covered under Software Assurance or [!INCLUDE ssnoversion-md] subscription./PRODUCTCOVEREDBYSA=False, or omitting the parameter, indicates it's covered under a SQL Server license. |
| [!INCLUDE ssde-md] Setup Control | /PIDOptional |
Specifies the product key for the edition of [!INCLUDE ssNoVersion]. If this parameter isn't specified, Evaluation is used. Note: If you're installing [!INCLUDE ssExpress], [!INCLUDE ssExpress] with Advanced Services, [!INCLUDE ssExpress] with tools, [!INCLUDE ssdeveloper], or [!INCLUDE ssevaluation], the PID is predefined. |
| [!INCLUDE ssde-md] Setup Control | /Q or /QUIETOptional |
Specifies that Setup runs in a quiet mode without any user interface. This is used for unattended installations. The /Q parameter overrides the input of the /QS parameter. |
| [!INCLUDE ssde-md] Setup Control | /QS or /QUIETSIMPLEOptional |
Specifies that Setup runs and shows progress through the UI, but doesn't accept any input or show any error messages. |
| [!INCLUDE ssde-md] Setup Control | /SQMREPORTINGApplies to: [!INCLUDE sssql14-md] and earlier versions Optional |
To manage how error feedback is sent to Microsoft, see Configure usage and diagnostic data collection for SQL Server (CEIP). In older versions this specifies feature usage reporting for [!INCLUDE ssNoVersion]. Supported values: - 1 = enabled- 0 = disabled |
| [!INCLUDE ssde-md] Setup Control | /HIDECONSOLEOptional |
Specifies that the console window is hidden or closed. |
| [!INCLUDE ssNoVersion] Agent | /AGTSVCACCOUNTRequired |
Specifies the account for the [!INCLUDE ssNoVersion] Agent service. |
| [!INCLUDE ssNoVersion] Agent | /AGTSVCPASSWORDRequired |
Specifies the password for [!INCLUDE ssNoVersion] Agent service account. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| [!INCLUDE ssNoVersion] Agent | /AGTSVCSTARTUPTYPEOptional |
Specifies the startup mode for the [!INCLUDE ssNoVersion] Agent service. Supported values: - Automatic- Disabled- Manual |
| PolyBase Engine | /PBENGSVCACCOUNTOptional |
Specifies the account for the engine service. Default value: NT AUTHORITY\NETWORK SERVICE. |
| PolyBase Data Movement | /PBDMSSVCPASSWORDOptional |
Specifies the password for the data movement account. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| PolyBase Engine | /PBENGSVCSTARTUPTYPEOptional |
Specifies the startup mode for the PolyBase Engine service. Supported values: - Automatic (default)- Disabled- Manual |
| PolyBase | /PBPORTRANGEOptional |
Specifies a port range with at least six ports for PolyBase services. Example:/PBPORTRANGE=16450-16460 |
| PolyBase | /PBSCALEOUTOptional |
Specifies if the [!INCLUDE ssDEnoversion] instance is used as a part of PolyBase Scale-out computational group. Use this option if you're configuring a PolyBase Scale-out computational group including the head node. Supported values: True, False |
| [!INCLUDE ssNoVersion] Browser | /BROWSERSVCSTARTUPTYPEOptional |
Specifies the startup mode for [!INCLUDE ssNoVersion] Browser service. Supported values: - Automatic- Disabled- Manual |
| [!INCLUDE ssDEnoversion] | /ENABLERANUOptional |
Enables run-as credentials for [!INCLUDE ssExpress] installations. |
| [!INCLUDE ssDEnoversion] | /INSTALLSQLDATADIROptional |
Specifies the data directory for [!INCLUDE ssNoVersion] data files. Default values: For WOW mode on 64-bit: %Program Files(x86)%\Microsoft SQL Server\For all other installations: %Program Files%\Microsoft SQL Server\ |
| [!INCLUDE ssDEnoversion] | /SAPWDRequired, when /SECURITYMODE=SQL |
Specifies the password for the [!INCLUDE ssNoVersion] SA account. |
| [!INCLUDE ssDEnoversion] | /SECURITYMODEOptional |
Specifies the security mode for [!INCLUDE ssNoVersion]. If this parameter isn't supplied, then Windows-only authentication mode is supported. Supported value: SQL |
| [!INCLUDE ssDEnoversion] | /SQLBACKUPDIROptional |
Specifies the directory for backup files. Default value: <InstallSQLDataDir>\<SQLInstanceID>\MSSQL\Backup |
| [!INCLUDE ssDEnoversion] | /SQLCOLLATIONOptional |
Specifies the collation settings for [!INCLUDE ssNoVersion]. The default value is based on the locale of your Windows operating system. For more information, see Collation and Unicode support. |
| [!INCLUDE ssDEnoversion] | /SQLSVCACCOUNTRequired |
Specifies the startup account for the [!INCLUDE ssNoVersion] service. |
| [!INCLUDE ssDEnoversion] | /SQLSVCPASSWORDRequired |
Specifies the password for SQLSVCACCOUNT. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| [!INCLUDE ssDEnoversion] | /SQLSVCSTARTUPTYPEOptional |
Specifies the startup mode for the [!INCLUDE ssNoVersion] service. Supported values: - Automatic- Disabled- Manual |
| [!INCLUDE ssDEnoversion] | /SQLSYSADMINACCOUNTSRequired |
Use this parameter to provision logins to be members of the sysadmin role. For [!INCLUDE ssNoVersion] editions other than [!INCLUDE ssExpress], /SQLSYSADMINACCOUNTS is required. For editions of [!INCLUDE ssExpress], use of /SQLSYSADMINACCOUNTS is optional, but either /SQLSYSADMINACCOUNTS or /ADDCURRENTUSERASSQLADMIN is required. |
| [!INCLUDE ssDEnoversion] | /SQLTEMPDBDIROptional |
Specifies the directories for tempdb data files. When specifying more than one directory, separate the directories with a blank space. If multiple directories are specified, the tempdb data files are spread across the directories in a round-robin fashion.Default value: <InstallSQLDataDir>\<SQLInstanceID>\MSSQL\Data (System Data Directory)Note: This parameter is added to RebuildDatabase scenario as well. |
| [!INCLUDE ssDEnoversion] | /SQLTEMPDBLOGDIROptional |
Specifies the directory for tempdb log file.Default value: <InstallSQLDataDir>\<SQLInstanceID>\MSSQL\Data (System Data Directory)Note: This parameter is added to RebuildDatabase scenario as well. |
| [!INCLUDE ssDEnoversion] | /SQLTEMPDBFILESIZEApplies to: [!INCLUDE sssql16-md] and later versions Optional |
Specifies the initial size of each tempdb data file.Default = 4 MB for [!INCLUDE ssExpress], 8 MB for all other editions Min = 4 MB or 8 MB Max = 1024 MB |
| [!INCLUDE ssDEnoversion] | /SQLTEMPDBFILEGROWTHOptional |
Specifies the file growth increment of each tempdb data file in MB. A value of 0 indicates that automatic growth is off and no additional space is allowed. Setup allows the size up to 1024.Default value: 64. Allowed range: Min = 0, Max = 1024 |
| [!INCLUDE ssDEnoversion] | /SQLTEMPDBLOGFILESIZEApplies to: [!INCLUDE sssql16-md] and later versions Optional |
Specifies the initial size of the tempdb log file in MB. Setup allows the size up to 1024.Default value: 4 for [!INCLUDE ssExpress] 8 for all other editions Allowed range: Min = default value (4 or 8), Max = 1024 |
| [!INCLUDE ssDEnoversion] | /SQLTEMPDBLOGFILEGROWTHApplies to: [!INCLUDE sssql16-md] and later versions Optional |
Specifies the file growth increment of the tempdb log file in MB. A value of 0 indicates that automatic growth is off and no additional space is allowed. Setup allows the size up to 1024.Default value: 64. Allowed range: Min = 0, Max = 1024 |
| [!INCLUDE ssDEnoversion] | /SQLTEMPDBFILECOUNTOptional |
Specifies the number of tempdb data files to be added by setup. This value can be increased up to the number of cores.Default value: 1 for [!INCLUDE ssExpress] 8 or the number of cores, whichever is lower for all other editions Important: The primary database file for tempdb is still tempdb.mdf. The additional tempdb files are named as tempdb_mssql_#.ndf where # represents a unique number for each additional tempdb database file created during setup. The purpose of this naming convention is to make them unique. Uninstalling an instance of [!INCLUDE ssNoVersion] deletes the files with naming convention tempdb_mssql_#.ndf. Don't use tempdb_mssql_\*.ndf naming convention for user database files.Warning: [!INCLUDE ssExpress] isn't supported for configuring this parameter. Setup installs only 1 tempdb data file. |
| [!INCLUDE ssDEnoversion] | /SQLUSERDBDIROptional |
Specifies the directory for the data files for user databases. Default value: <InstallSQLDataDir>\<SQLInstanceID>\MSSQL\Data |
| [!INCLUDE ssDEnoversion] | /SQLUSERDBLOGDIROptional |
Specifies the directory for the log files for user databases. Default value: <InstallSQLDataDir>\<SQLInstanceID>\MSSQL\Data |
| FILESTREAM | /FILESTREAMLEVELOptional |
Specifies the access level for the FILESTREAM feature. Supported values: - 0 = disable FILESTREAM support for this instance. (Default value)- 1 = enable FILESTREAM for [!INCLUDE tsql] access.- 2 = enable FILESTREAM for [!INCLUDE tsql] and file I/O streaming access. (Not valid for Cluster scenarios)- 3 = allow remote clients to have streaming access to FILESTREAM data. |
| FILESTREAM | /FILESTREAMSHARENAMEOptional Required when FILESTREAMLEVEL is greater than 1. |
Specifies the name of the Windows share in which the FILESTREAM data will be stored. |
| [!INCLUDE ssNoVersion] Full Text | /FTSVCACCOUNTOptional |
Specifies the account for Full-Text filter launcher service. This parameter is ignored in [!INCLUDE winserver2008] or higher. ServiceSID is used to help secure the communication between [!INCLUDE ssNoVersion] and Full-text Filter Daemon. If the values aren't provided, the Full-text Filter Launcher Service is disabled. You have to use [!INCLUDE ssNoVersion] Control Manager to change the service account and enable full-text functionality. Default value: Local Service Account |
| [!INCLUDE ssNoVersion] Full Text | /FTSVCPASSWORDOptional |
Specifies the password for the Full-Text filter launcher service. This parameter is ignored in [!INCLUDE winserver2008] or higher. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| [!INCLUDE ssNoVersion] Network Configuration | /NPENABLEDOptional |
Specifies the state of the Named Pipes protocol for the [!INCLUDE ssNoVersion] service. Supported values: - 0 = disable the Named Pipes protocol- 1 = enable the Named Pipes protocol |
| [!INCLUDE ssNoVersion] Network Configuration | /TCPENABLEDOptional |
Specifies the state of the TCP protocol for the [!INCLUDE ssNoVersion] service. Supported values: - 0 = disable the TCP protocol- 1 = enable the TCP protocol |
| [!INCLUDE ssRSnoversion] | /RSINSTALLMODEApplies to: [!INCLUDE sssql16-md] and earlier versions Optional Available only on FilesOnlyMode |
Specifies the Install mode for [!INCLUDE ssRSnoversion]. Supported values: - SharePointFilesOnlyMode- DefaultNativeMode- FilesOnlyModeNote: If the installation includes the [!INCLUDE ssNoVersion] [!INCLUDE ssDE], the default RSINSTALLMODE is DefaultNativeMode.If the installation doesn't include the [!INCLUDE ssNoVersion] [!INCLUDE ssDE], the default RSINSTALLMODE is FilesOnlyMode.If you choose DefaultNativeMode but the installation doesn't include the [!INCLUDE ssNoVersion] [!INCLUDE ssDE], the installation automatically changes the RSINSTALLMODE to FilesOnlyMode. |
| [!INCLUDE ssRSnoversion] | /RSSVCACCOUNTApplies to: [!INCLUDE sssql16-md] and earlier versions Required |
Specifies the startup account for the [!INCLUDE ssRSnoversion]. |
| [!INCLUDE ssRSnoversion] | /RSSVCPASSWORDApplies to: [!INCLUDE sssql16-md] and earlier versions Required |
Specifies the password for the startup account for the [!INCLUDE ssRSnoversion] service. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| [!INCLUDE ssRSnoversion] | /RSSVCStartupTypeApplies to: [!INCLUDE sssql16-md] and earlier versions Optional |
Specifies the startup mode for [!INCLUDE ssRSnoversion]. Supported values: - Automatic- Disabled- Manual |
To complete a prepared, stand-alone instance that includes [!INCLUDE ssDEnoversion], Replication, and Full-Text Search components.
setup.exe /q /ACTION=CompleteImage /INSTANCENAME=MYNEWINST /INSTANCEID=<MYINST> /SQLSVCACCOUNT="<DomainName\UserName>" /SQLSVCPASSWORD="<StrongPassword>" /SQLSYSADMINACCOUNTS="<DomainName\UserName>" /AGTSVCACCOUNT="NT AUTHORITY\NETWORK SERVICE" /IACCEPTSQLSERVERLICENSETERMSUse the parameters in the following table to develop command-line scripts for upgrade.
| [!INCLUDE ssDEnoversion] component | Parameter | Description |
|---|---|---|
| [!INCLUDE ssde-md] Setup Control | /ACTIONRequired |
Required to indicate the installation workflow. Supported values: - Upgrade- EditionUpgradeThe value EditionUpgrade is used to upgrade an existing edition of [!INCLUDE ssnoversion] to a different edition. For more information about the supported version and edition upgrades, see Supported version and edition upgrades (SQL Server 2025). |
| [!INCLUDE ssde-md] Setup Control | /IACCEPTSQLSERVERLICENSETERMSRequired, when the /Q or /QS parameter is specified for unattended installations |
Required to acknowledge acceptance of the license terms. Beginning with [!INCLUDE sssql22-md], read the Microsoft [!INCLUDE ssNoVersion] Software License Terms at aka.ms/useterms. |
| [!INCLUDE ssde-md] Setup Control | /ENUOptional |
Use this parameter to install the English version of [!INCLUDE ssNoVersion] on a localized operating system when the installation media includes language packs for both English and the language corresponding to the operating system. |
| [!INCLUDE ssde-md] Setup Control | /UpdateEnabledOptional |
Specify whether [!INCLUDE ssNoVersion] Setup should discover and include product updates. The valid values are True and False or 1 and 0. By default, [!INCLUDE ssNoVersion] Setup includes updates that are found. |
| [!INCLUDE ssde-md] Setup Control | /UpdateSourceOptional |
Specify the location where [!INCLUDE ssNoVersion] Setup obtains product updates. The valid values are "MU" to search [!INCLUDE msCoName] Update, a valid folder path, a relative path such as .\MyUpdates, or a UNC share. By default, [!INCLUDE ssNoVersion] Setup searches [!INCLUDE msCoName] Update or a Windows Update Service through the Windows Server Update Services. |
| [!INCLUDE ssde-md] Setup Control | /CONFIGURATIONFILEOptional |
Specifies the configuration file to use. |
| [!INCLUDE ssde-md] Setup Control | /ERRORREPORTINGApplies to: [!INCLUDE sssql14-md] and earlier versions Optional |
To manage how error feedback is sent to Microsoft, see Configure usage and diagnostic data collection for SQL Server (CEIP). In older versions this specifies the error reporting for [!INCLUDE ssNoVersion]. For more information, see SQL Server privacy supplement. Supported values: - 1 = enabled- 0 = disabled |
| [!INCLUDE ssde-md] Setup Control | /HELP or ?Optional |
Displays usage options for the parameters. |
| [!INCLUDE ssde-md] Setup Control | /INDICATEPROGRESSOptional |
Specifies that the verbose Setup log file is piped to the console. |
| [!INCLUDE ssde-md] Setup Control | / INSTANCEDIROptional |
Specifies a nondefault installation directory for shared components. |
| [!INCLUDE ssde-md] Setup Control | /INSTANCEIDRequired, when you upgrade from [!INCLUDE sql2008-md] or later versions. Optional, when you upgrade from [!INCLUDE ssVersion2005]. |
Specifies a nondefault value for an InstanceID. |
| [!INCLUDE ssde-md] Setup Control | /INSTANCENAMERequired |
Specifies a [!INCLUDE ssDEnoversion] instance name. For more information, see Installation Wizard help. |
| [!INCLUDE ssde-md] Setup Control | /PIDOptional |
Specifies the product key for the edition of [!INCLUDE ssNoVersion]. If this parameter isn't specified, Evaluation is used. Note: If you're installing [!INCLUDE ssExpress], [!INCLUDE ssExpress] with Advanced Services, [!INCLUDE ssExpress] with tools, [!INCLUDE ssdeveloper], or [!INCLUDE ssevaluation], the PID is predefined. |
| [!INCLUDE ssde-md] Setup Control | /Q or /QUIETOptional |
Specifies that Setup runs in a quiet mode without any user interface. This is used for unattended installations. The /Q parameter overrides the input of the /QS parameter. |
| [!INCLUDE ssde-md] Setup Control | /UIMODEOptional |
Specifies whether to present only the minimum number of dialog boxes during setup./UIMODE can only be used with the /ACTION=INSTALL and UPGRADE parameters.Supported values: - /UIMODE=Normal is the default for non-Express editions and presents all setup dialog boxes for the selected features.- /UIMODE=AutoAdvance is the default for Express editions and skips nonessential dialog boxes.When combined with other parameters, UIMODE is overridden. For example, when /UIMODE=AutoAdvance and /ADDCURRENTUSERASSQLADMIN=FALSE are both provided, the provisioning dialog box isn't auto populated with the current user.The UIMODE setting can't be used with the /Q or /QS parameters. |
| [!INCLUDE ssde-md] Setup Control | /SQMREPORTINGApplies to: [!INCLUDE sssql14-md] and earlier versions Optional |
To manage how error feedback is sent to Microsoft, see Configure usage and diagnostic data collection for SQL Server (CEIP). In older versions this specifies feature usage reporting for [!INCLUDE ssNoVersion]. Supported values: - 1 = enabled- 0 = disabled |
| [!INCLUDE ssde-md] Setup Control | /HIDECONSOLEOptional |
Specifies that the console window is hidden or closed. |
| [!INCLUDE ssNoVersion] Browser | /BROWSERSVCSTARTUPTYPEOptional |
Specifies the startup mode for [!INCLUDE ssNoVersion] Browser service. Supported values: - Automatic- Disabled- Manual |
| [!INCLUDE ssNoVersion] Full-Text | /FTUPGRADEOPTIONOptional |
Specifies the Full-Text catalog upgrade option. Supported values: - REBUILD- RESET- IMPORT |
| [!INCLUDE ssnoversion-md] Data Quality Services | /IACCEPTDQUNINSTALLOptional |
Removes Data Quality Services during upgrade to [!INCLUDE sssql25-md] and later versions. For more information, see Upgrade fails if Data Quality Services is installed. Applies to: [!INCLUDE sssql25-md] and later versions. |
| [!INCLUDE ssISnoversion] | /ISSVCACCOUNTRequired |
Specifies the account for [!INCLUDE ssISnoversion]. Default value: NT AUTHORITY\NETWORK SERVICE |
| [!INCLUDE ssISnoversion] | /ISSVCPASSWORDRequired |
Specifies the [!INCLUDE ssISnoversion] password. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| [!INCLUDE ssISnoversion] | /ISSVCStartupTypeOptional |
Specifies the startup mode for the [!INCLUDE ssISnoversion] service. |
| [!INCLUDE ssRSnoversion] | /RSUPGRADEDATABASEACCOUNTOptional |
The property is only used when upgrading a SharePoint mode Report Server that is version 2008 R2 or earlier. Additional upgrade operations are performed for report servers that use the older SharePoint mode architecture, which was changed in [!INCLUDE ssSQL11] [!INCLUDE ssRSnoversion]. If this option isn't included with the command-line installation, the default service account for the old report server instance is used. If this property is used, supply the password for the account using the /RSUPGRADEPASSWORD property. |
| [!INCLUDE ssRSnoversion] | /RSUPGRADEPASSWORDOptional |
Password of the existing Report Server service account. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| [!INCLUDE ssRSnoversion] | /ALLOWUPGRADEFORSSRSSHAREPOINTMODE |
The switch is required when upgrading a SharePoint Mode installation that is based on the SharePoint shared service architecture. The switch isn't needed for upgrading non-shared service versions of [!INCLUDE ssRSnoversion]. |
To upgrade an existing instance or failover cluster node from a previous [!INCLUDE ssDEnoversion] version,
setup.exe /q /ACTION=upgrade /INSTANCEID = <INSTANCEID>/INSTANCENAME=MSSQLSERVER /RSUPGRADEDATABASEACCOUNT="<Provide a SQL Server logon account that can connect to the report server during upgrade>" /RSUPGRADEPASSWORD="<Provide a password for the report server upgrade account>" /ISSVCAccount="NT AUTHORITY\NETWORK SERVICE" /IACCEPTSQLSERVERLICENSETERMSUse the parameters in the following table to develop command-line scripts for repair.
| [!INCLUDE ssDEnoversion] component | Parameter | Description |
|---|---|---|
| [!INCLUDE ssde-md] Setup Control | /ACTIONRequired |
Required to indicate the repair workflow. Supported values: Repair |
| [!INCLUDE ssde-md] Setup Control | /ENUOptional |
Use this parameter to install the English version of [!INCLUDE ssNoVersion] on a localized operating system when the installation media includes language packs for both English and the language corresponding to the operating system. |
| [!INCLUDE ssde-md] Setup Control | /FEATURESRequired |
Specifies components to repair. |
| [!INCLUDE ssde-md] Setup Control | /INSTANCENAMERequired |
Specifies a [!INCLUDE ssDEnoversion] instance name. For more information, see Installation Wizard help. |
| PolyBase Engine | /PBENGSVCACCOUNTOptional |
Specifies the account for the engine service. Default value: NT AUTHORITY\NETWORK SERVICE. |
| PolyBase Data Movement | /PBDMSSVCPASSWORDOptional |
Specifies the password for the data movement account. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| PolyBase Engine | /PBENGSVCSTARTUPTYPEOptional |
Specifies the startup mode for the PolyBase Engine service. Supported values: - Automatic (default)- Disabled- Manual |
| PolyBase | /PBPORTRANGEOptional |
Specifies a port range with at least six ports for PolyBase services. Example:/PBPORTRANGE=16450-16460 |
| PolyBase | /PBSCALEOUTOptional |
Specifies if the [!INCLUDE ssDEnoversion] instance is used as a part of PolyBase Scale-out computational group. Use this option if you're configuring a PolyBase Scale-out computational group including the head node. Supported values: True, False |
| [!INCLUDE ssde-md] Setup Control | /Q or /QUIETOptional |
Specifies that Setup runs in a quiet mode without any user interface. This is used for unattended installations. The /Q parameter overrides the input of the /QS parameter. |
| [!INCLUDE ssde-md] Setup Control | /HIDECONSOLEOptional |
Specifies that the console window is hidden or closed. |
Repair an instance and shared components.
setup.exe /q /ACTION=Repair /INSTANCENAME=<instancename>Use the parameters in the following table to develop command-line scripts for rebuilding the master, model, msdb, and tempdb system databases. For more information, see Rebuild system databases.
| [!INCLUDE ssDEnoversion] component | Parameter | Description |
|---|---|---|
| [!INCLUDE ssde-md] Setup Control | /ACTIONRequired |
Required to indicate the rebuild database workflow. Supported values: RebuildDatabase |
| [!INCLUDE ssde-md] Setup Control | /INSTANCENAMERequired |
Specifies a [!INCLUDE ssDEnoversion] instance name. For more information, see Installation Wizard help. |
| [!INCLUDE ssde-md] Setup Control | /Q or /QUIETOptional |
Specifies that Setup runs in a quiet mode without any user interface. This is used for unattended installations. The /Q parameter overrides the input of the /QS parameter. |
| [!INCLUDE ssDEnoversion] | /SQLCOLLATIONOptional |
Specifies a new server-level collation. The default value is based on the locale of your Windows operating system. For more information, see Collation and Unicode support. |
| [!INCLUDE ssDEnoversion] | /SAPWDRequired, when /SECURITYMODE=SQL was specified during installation of the instance. |
Specifies the password for [!INCLUDE ssNoVersion] SA account. |
| [!INCLUDE ssDEnoversion] | /SQLSYSADMINACCOUNTSRequired |
Use this parameter to provision logins to be members of the sysadmin role. For [!INCLUDE ssNoVersion] editions other than [!INCLUDE ssExpress], /SQLSYSADMINACCOUNTS is required. For editions of [!INCLUDE ssExpress], use of /SQLSYSADMINACCOUNTS is optional, but either /SQLSYSADMINACCOUNTS or /ADDCURRENTUSERASSQLADMIN is required. |
| [!INCLUDE ssDEnoversion] | /SQLTEMPDBDIROptional |
Specifies the directories for tempdb data files. When specifying more than one directory, separate the directories with a blank space. If multiple directories are specified, the tempdb data files are spread across the directories in a round-robin fashion.Default value: <InstallSQLDataDir>\<SQLInstanceID>\MSSQL\Data (System Data Directory)Note: This parameter is added to RebuildDatabase scenario as well. |
| [!INCLUDE ssDEnoversion] | /SQLTEMPDBLOGDIROptional |
Specifies the directory for tempdb log file.Default value: <InstallSQLDataDir>\<SQLInstanceID>\MSSQL\Data (System Data Directory)Note: This parameter is added to RebuildDatabase scenario as well. |
| [!INCLUDE ssDEnoversion] | /SQLTEMPDBFILECOUNTOptional |
Specifies the number of tempdb data files to be added by setup. This value can be increased up to the number of cores.Default value: 1 for [!INCLUDE ssExpress] 8 or the number of cores, whichever is lower for all other editions Important: The primary database file for tempdb is still tempdb.mdf. The additional tempdb files are named as tempdb_mssql_#.ndf where # represents a unique number for each additional tempdb database file created during setup. The purpose of this naming convention is to make them unique. Uninstalling an instance of [!INCLUDE ssNoVersion] deletes the files with naming convention tempdb_mssql_#.ndf. Don't use tempdb_mssql_\*.ndf naming convention for user database files.Warning: [!INCLUDE ssExpress] isn't supported for configuring this parameter. Setup installs only 1 tempdb data file. |
| [!INCLUDE ssDEnoversion] | /SQLTEMPDBFILESIZEApplies to: [!INCLUDE sssql16-md] and later versions Optional |
Specifies the initial size of each tempdb data file.Default = 4 MB for [!INCLUDE ssExpress], 8 MB for all other editions Min = 4 MB or 8 MB Max = 1024 MB |
| [!INCLUDE ssDEnoversion] | /SQLTEMPDBFILEGROWTHOptional |
Specifies the file growth increment of each tempdb data file in MB. A value of 0 indicates that automatic growth is off and no additional space is allowed. Setup allows the size up to 1024.Default value: 64. Allowed range: Min = 0, Max = 1024 |
| [!INCLUDE ssDEnoversion] | /SQLTEMPDBLOGFILESIZEApplies to: [!INCLUDE sssql16-md] and later versions Optional |
Specifies the initial size of the tempdb log file in MB. Setup allows the size up to 1024.Default value: 4 for [!INCLUDE ssExpress] 8 for all other editions Allowed range: Min = default value (4 or 8), Max = 1024 |
| [!INCLUDE ssDEnoversion] | /SQLTEMPDBLOGFILEGROWTHApplies to: [!INCLUDE sssql16-md] and later versions Optional |
Specifies the file growth increment of the tempdb log file in MB. A value of 0 indicates that automatic growth is off and no additional space is allowed. Setup allows the size up to 1024.Default value: 64. Allowed range: Min = 0, Max = 1024 |
Use the parameters in the following table to develop command-line scripts for uninstallation.
| [!INCLUDE ssDEnoversion] component | Parameter | Description |
|---|---|---|
| [!INCLUDE ssde-md] Setup Control | /ACTIONRequired |
Required to indicate the uninstall work flow. Supported values: Uninstall |
| [!INCLUDE ssde-md] Setup Control | /CONFIGURATIONFILEOptional |
Specifies the configuration file to use. |
| [!INCLUDE ssde-md] Setup Control | /FEATURESRequired |
Specifies components to uninstall. |
| [!INCLUDE ssde-md] Setup Control | /HELP or ?Optional |
Displays usage options for the parameters. |
| [!INCLUDE ssde-md] Setup Control | /INDICATEPROGRESSOptional |
Specifies that the verbose Setup log file is piped to the console. |
| [!INCLUDE ssde-md] Setup Control | /INSTANCENAMERequired |
Specifies a [!INCLUDE ssDEnoversion] instance name. For more information, see Installation Wizard help. |
| [!INCLUDE ssde-md] Setup Control | /Q or /QUIETOptional |
Specifies that Setup runs in a quiet mode without any user interface. This is used for unattended installations. The /Q parameter overrides the input of the /QS parameter. |
| [!INCLUDE ssde-md] Setup Control | /HIDECONSOLEOptional |
Specifies that the console window is hidden or closed. |
Use the following command to uninstall an existing instance of [!INCLUDE ssNoVersion] from the command prompt.
setup.exe /Action=Uninstall /FEATURES=SQL,AS,RS,IS,Tools /INSTANCENAME=MSSQLSERVERTo remove a named instance, specify the name of the instance instead of MSSQLSERVER in the previous example.
To uninstall an existing [!INCLUDE ssNoVersion] update from the command prompt, you can find the complete uninstall command for a specific component in the Windows registry, using the following registry path. Look for the "UninstallString" key.
Warning
[!INCLUDE ssnoteregistry-md]
The following example shows the path for a specific KB update.
Computer\HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Uninstall\KB5014356
You can get the uninstall command from "UninstallString" in this registry key. For example:
C:\Program Files\Microsoft SQL Server\150\Setup Bootstrap\Update Cache\KB5014356\GDR\setup.exe" /Action=RemovePatch /AllInstancesBefore you install a [!INCLUDE ssDEnoversion] failover cluster instance, review the following articles:
-
Always On failover cluster instances (SQL Server)
[!IMPORTANT]
All failover cluster installation commands require an underlying Windows cluster. All the nodes that are part of a [!INCLUDE ssDEnoversion] failover cluster must be part of the same Windows cluster.
Test and modify the following failover cluster installation scripts to meet the needs of your organization.
Use the parameters in the following table to develop command-line scripts for failover cluster installation.
For more information about Integrated Installation, see Always On failover cluster instances (SQL Server).
Note
To add more nodes after the installation, use Add Node action.
| [!INCLUDE ssDEnoversion] component | Parameter | Details |
|---|---|---|
| [!INCLUDE ssde-md] Setup Control | /ACTIONRequired |
Required to indicate the failover cluster installation work flow. Supported value: InstallFailoverCluster |
| [!INCLUDE ssde-md] Setup Control | /IACCEPTSQLSERVERLICENSETERMSRequired, when the /Q or /QS parameter is specified for unattended installations |
Required to acknowledge acceptance of the license terms. Beginning with [!INCLUDE sssql22-md], read the Microsoft [!INCLUDE ssNoVersion] Software License Terms at aka.ms/useterms. |
| [!INCLUDE ssde-md] Setup Control | /ENUOptional |
Use this parameter to install the English version of [!INCLUDE ssNoVersion] on a localized operating system when the installation media includes language packs for both English and the language corresponding to the operating system. |
| [!INCLUDE ssde-md] Setup Control | /FAILOVERCLUSTERGROUPOptional |
Specifies the name of the resource group to be used for the [!INCLUDE ssDEnoversion] failover cluster. It can be the name of an existing cluster group or the name of a new resource group. Default value: SQL Server (<InstanceName>) |
| PolyBase Engine | /PBENGSVCACCOUNTOptional |
Specifies the account for the engine service. Default value: NT AUTHORITY\NETWORK SERVICE. |
| PolyBase Data Movement | /PBDMSSVCPASSWORDOptional |
Specifies the password for the data movement account. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| PolyBase Engine | /PBENGSVCSTARTUPTYPEOptional |
Specifies the startup mode for the PolyBase Engine service. Supported values: - Automatic (default)- Disabled- Manual |
| PolyBase | /PBPORTRANGEOptional |
Specifies a port range with at least six ports for PolyBase services. Example:/PBPORTRANGE=16450-16460 |
| PolyBase | /PBSCALEOUTOptional |
Specifies if the [!INCLUDE ssDEnoversion] instance is used as a part of PolyBase Scale-out computational group. Use this option if you're configuring a PolyBase Scale-out computational group including the head node. Supported values: True, False |
| [!INCLUDE ssde-md] Setup Control | /UpdateEnabledOptional |
Specify whether [!INCLUDE ssNoVersion] Setup should discover and include product updates. The valid values are True and False or 1 and 0. By default, [!INCLUDE ssNoVersion] Setup includes updates that are found. |
| [!INCLUDE ssde-md] Setup Control | /UpdateSourceOptional |
Specify the location where [!INCLUDE ssNoVersion] Setup obtains product updates. The valid values are "MU" to search [!INCLUDE msCoName] Update, a valid folder path, a relative path such as .\MyUpdates, or a UNC share. By default, [!INCLUDE ssNoVersion] Setup searches [!INCLUDE msCoName] Update or a Windows Update Service through the Windows Server Update Services. |
| [!INCLUDE ssde-md] Setup Control | /CONFIGURATIONFILEOptional |
Specifies the configuration file to use. |
| [!INCLUDE ssde-md] Setup Control | /ERRORREPORTINGApplies to: [!INCLUDE sssql14-md] and earlier versions Optional |
To manage how error feedback is sent to Microsoft, see Configure usage and diagnostic data collection for SQL Server (CEIP). In older versions this specifies the error reporting for [!INCLUDE ssNoVersion]. For more information, see SQL Server privacy supplement. Supported values: - 1 = enabled- 0 = disabled |
| [!INCLUDE ssde-md] Setup Control | /FEATURESRequired |
Specifies components to install. |
| [!INCLUDE ssde-md] Setup Control | /HELP or ?Optional |
Displays usage options for the parameters. |
| [!INCLUDE ssde-md] Setup Control | /INDICATEPROGRESSOptional |
Specifies that the verbose Setup log file is piped to the console. |
| [!INCLUDE ssde-md] Setup Control | /INSTALLSHAREDDIROptional |
Specifies a nondefault installation directory for 64-bit shared components. Default is %Program Files%\Microsoft SQL ServerCan't be set to %Program Files(x86)%\Microsoft SQL Server |
| [!INCLUDE ssde-md] Setup Control | /INSTALLSHAREDWOWDIROptional |
Specifies a nondefault installation directory for 32-bit shared components. Supported only on a 64-bit system. Default is %Program Files(x86)%\Microsoft SQL ServerCan't be set to %Program Files%\Microsoft SQL Server |
| [!INCLUDE ssde-md] Setup Control | /INSTANCEDIROptional |
Specifies a nondefault installation directory for instance-specific components. |
| [!INCLUDE ssde-md] Setup Control | /INSTANCEIDOptional |
Specifies a nondefault value for an InstanceID. |
| [!INCLUDE ssde-md] Setup Control | /INSTANCENAMERequired |
Specifies a [!INCLUDE ssDEnoversion] instance name. For more information, see Installation Wizard help. |
| [!INCLUDE ssde-md] Setup Control | /PRODUCTCOVEREDBYSAApplies to: [!INCLUDE sssql22-md] and later versions Required, when installing the Azure Extension feature from the command prompt with AZUREEXTENSION. |
Specifies the license coverage for [!INCLUDE ssnoversion-md]./PRODUCTCOVEREDBYSA=True, or just /PRODUCTCOVEREDBYSA, indicates it's covered under Software Assurance or [!INCLUDE ssnoversion-md] subscription./PRODUCTCOVEREDBYSA=False, or omitting the parameter, indicates it's covered under a SQL Server license. |
| [!INCLUDE ssde-md] Setup Control | /PIDOptional |
Specifies the product key for the edition of [!INCLUDE ssNoVersion]. If this parameter isn't specified, Evaluation is used. Note: If you're installing [!INCLUDE ssExpress], [!INCLUDE ssExpress] with Advanced Services, [!INCLUDE ssExpress] with tools, [!INCLUDE ssdeveloper], or [!INCLUDE ssevaluation], the PID is predefined. |
| [!INCLUDE ssde-md] Setup Control | /Q or /QUIETOptional |
Specifies that Setup runs in a quiet mode without any user interface. This is used for unattended installations. The /Q parameter overrides the input of the /QS parameter. |
| [!INCLUDE ssde-md] Setup Control | /QS or /QUIETSIMPLEOptional |
Specifies that Setup runs and shows progress through the UI, but doesn't accept any input or show any error messages. |
| [!INCLUDE ssde-md] Setup Control | /SQMREPORTINGApplies to: [!INCLUDE sssql14-md] and earlier versions Optional |
To manage how error feedback is sent to Microsoft, see Configure usage and diagnostic data collection for SQL Server (CEIP). In older versions this specifies feature usage reporting for [!INCLUDE ssNoVersion]. Supported values: - 1 = enabled- 0 = disabled |
| [!INCLUDE ssde-md] Setup Control | /HIDECONSOLEOptional |
Specifies that the console window is hidden or closed. |
| [!INCLUDE ssde-md] Setup Control | /FAILOVERCLUSTERDISKSOptional |
Specifies the list of shared disks to be included in the [!INCLUDE ssDEnoversion] failover cluster resource group. Default value: The first drive is used as the default drive for all databases. |
| [!INCLUDE ssde-md] Setup Control | /FAILOVERCLUSTERIPADDRESSESRequired |
Specifies an encoded IP address. The encodings are semicolon-delimited (;) and follow the format <IP Type>;<address>;<network name>;<subnet mask>. Supported IP types include DHCP, IPv4, and IPv6. You can specify multiple failover cluster IP addresses with a space in between. See the following examples: FAILOVERCLUSTERIPADDRESSES=DEFAULTFAILOVERCLUSTERIPADDRESSES=IPv4;DHCP;ClusterNetwork1FAILOVERCLUSTERIPADDRESSES=IPv6;DHCP;ClusterNetwork1FAILOVERCLUSTERIPADDRESSES=IPv6;2041:0:1a0f::8a5b:131c |
| [!INCLUDE ssde-md] Setup Control | /FAILOVERCLUSTERNETWORKNAMERequired |
Specifies the network name for the new [!INCLUDE ssDEnoversion] failover cluster. This name is used to identify the new [!INCLUDE ssDEnoversion] failover cluster instance on the network. |
| [!INCLUDE ssNoVersion] Agent | /AGTSVCACCOUNTRequired |
Specifies the account for the [!INCLUDE ssNoVersion] Agent service. |
| [!INCLUDE ssNoVersion] Agent | /AGTSVCPASSWORDRequired |
Specifies the password for [!INCLUDE ssNoVersion] Agent service account. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| [!INCLUDE ssASnoversion] | /ASBACKUPDIROptional |
Specifies the directory for [!INCLUDE ssASnoversion] backup files. Default values: For WOW mode on 64-bit: %Program Files(x86)%\Microsoft SQL Server\<INSTANCEDIR>\<ASInstanceID>\OLAP\BackupFor all other installations: %Program Files%\Microsoft SQL Server\<INSTANCEDIR>\<ASInstanceID>\OLAP\Backup |
| [!INCLUDE ssASnoversion] | /ASCOLLATIONOptional |
Specifies the collation setting for [!INCLUDE ssASnoversion]. Default value: Latin1_General_CI_ASNote: Only Windows collation is supported. Using SQL collation can result in unexpected behavior. |
| [!INCLUDE ssASnoversion] | /ASCONFIGDIROptional |
Specifies the directory for [!INCLUDE ssASnoversion] configuration files. Default values: For WOW mode on 64-bit: %Program Files(x86)%\Microsoft SQL Server\<INSTANCEDIR>\<ASInstanceID>\OLAP\ConfigFor all other installations: %Program Files%\Microsoft SQL Server\<INSTANCEDIR>\<ASInstanceID>\OLAP\Config |
| [!INCLUDE ssASnoversion] | /ASDATADIROptional |
Specifies the directory for [!INCLUDE ssASnoversion] data files. Default values: For WOW mode on 64-bit: %Program Files(x86)%\Microsoft SQL Server\<INSTANCEDIR>\<ASInstanceID>\OLAP\DataFor all other installations: %Program Files%\Microsoft SQL Server\<INSTANCEDIR>\<ASInstanceID>\OLAP\Data |
| [!INCLUDE ssASnoversion] | /ASLOGDIROptional |
Specifies the directory for [!INCLUDE ssASnoversion] log files. Default values: For WOW mode on 64-bit: %Program Files(x86)%\Microsoft SQL Server\<INSTANCEDIR>\<ASInstanceID>\OLAP\LogFor all other installations: %Program Files%\Microsoft SQL Server\<INSTANCEDIR>\<ASInstanceID>\OLAP\Log |
| [!INCLUDE ssASnoversion] | /ASSYSADMINACCOUNTSRequired |
Specifies the administrator credentials for [!INCLUDE ssASnoversion]. |
| [!INCLUDE ssASnoversion] | /ASTEMPDIROptional |
Specifies the directory for [!INCLUDE ssASnoversion] temporary files. Default values: For WOW mode on 64-bit: %Program Files(x86)%\Microsoft SQL Server\<INSTANCEDIR>\<ASInstanceID>\OLAP\TempFor all other installations: %Program Files%\Microsoft SQL Server\<INSTANCEDIR>\<ASInstanceID>\OLAP\Temp |
| [!INCLUDE ssASnoversion] | /ASPROVIDERMSOLAPOptional |
Specifies whether the MSOLAP provider can run in-process. Default value: - 1 = enabled |
| [!INCLUDE ssASnoversion] | /ASSERVERMODEOptional |
Specifies the server mode of the [!INCLUDE ssASnoversion] instance. Valid values in a cluster scenario are MULTIDIMENSIONAL or TABULAR. ASSERVERMODE is case-sensitive. All values must be expressed in uppercase. For more information about valid values, see Install Analysis Services in Tabular Mode. |
| [!INCLUDE ssDEnoversion] | /INSTALLSQLDATADIRRequired |
Specifies the data directory for [!INCLUDE ssNoVersion] data files. The data directory must be specified and on a shared cluster disk. |
| [!INCLUDE ssDEnoversion] | /SAPWDRequired, when /SECURITYMODE=SQL |
Specifies the password for the [!INCLUDE ssNoVersion] SA account. |
| [!INCLUDE ssDEnoversion] | /SECURITYMODEOptional |
Specifies the security mode for [!INCLUDE ssNoVersion]. If this parameter isn't supplied, then Windows-only authentication mode is supported. Supported value: SQL |
| [!INCLUDE ssDEnoversion] | /SQLBACKUPDIROptional |
Specifies the directory for backup files. Default value: <InstallSQLDataDir>\<SQLInstanceID>\MSSQL\Backup |
| [!INCLUDE ssDEnoversion] | /SQLCOLLATIONOptional |
Specifies the collation settings for [!INCLUDE ssNoVersion]. The default value is based on the locale of your Windows operating system. For more information, see Collation and Unicode support. |
| [!INCLUDE ssDEnoversion] | /SQLSVCACCOUNTRequired |
Specifies the startup account for the [!INCLUDE ssNoVersion] service. |
| [!INCLUDE ssDEnoversion] | /SQLSVCPASSWORDRequired |
Specifies the password for SQLSVCACCOUNT. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| [!INCLUDE ssDEnoversion] | /SQLSYSADMINACCOUNTSRequired |
Use this parameter to provision logins to be members of the sysadmin role. For [!INCLUDE ssNoVersion] editions other than [!INCLUDE ssExpress], /SQLSYSADMINACCOUNTS is required. For editions of [!INCLUDE ssExpress], use of /SQLSYSADMINACCOUNTS is optional, but either /SQLSYSADMINACCOUNTS or /ADDCURRENTUSERASSQLADMIN is required. |
| [!INCLUDE ssDEnoversion] | /SQLUSERDBDIROptional |
Specifies the directory for the data files for user databases. Default value: <InstallSQLDataDir>\<SQLInstanceID>\MSSQL\Data |
| [!INCLUDE ssDEnoversion] | /SQLTEMPDBDIROptional |
Specifies the directories for tempdb data files. When specifying more than one directory, separate the directories with a blank space. If multiple directories are specified, the tempdb data files are spread across the directories in a round-robin fashion.Default value: <InstallSQLDataDir>\<SQLInstanceID>\MSSQL\Data (System Data Directory)Note: This parameter is added to RebuildDatabase scenario as well. |
| [!INCLUDE ssDEnoversion] | /SQLTEMPDBLOGDIROptional |
Specifies the directory for tempdb log file.Default value: <InstallSQLDataDir>\<SQLInstanceID>\MSSQL\Data (System Data Directory)Note: This parameter is added to RebuildDatabase scenario as well. |
| [!INCLUDE ssDEnoversion] | /SQLTEMPDBFILECOUNTOptional |
Specifies the number of tempdb data files to be added by setup. This value can be increased up to the number of cores.Default value: 1 for [!INCLUDE ssExpress] 8 or the number of cores, whichever is lower for all other editions Important: The primary database file for tempdb is still tempdb.mdf. The additional tempdb files are named as tempdb_mssql_#.ndf where # represents a unique number for each additional tempdb database file created during setup. The purpose of this naming convention is to make them unique. Uninstalling an instance of [!INCLUDE ssNoVersion] deletes the files with naming convention tempdb_mssql_#.ndf. Don't use tempdb_mssql_\*.ndf naming convention for user database files.Warning: [!INCLUDE ssExpress] isn't supported for configuring this parameter. Setup installs only 1 tempdb data file. |
| [!INCLUDE ssDEnoversion] | /SQLTEMPDBFILESIZEApplies to: [!INCLUDE sssql16-md] and later versions Optional |
Specifies the initial size of each tempdb data file.Default = 4 MB for [!INCLUDE ssExpress], 8 MB for all other editions Min = 4 MB or 8 MB Max = 1024 MB |
| [!INCLUDE ssDEnoversion] | /SQLTEMPDBFILEGROWTHOptional |
Specifies the file growth increment of each tempdb data file in MB. A value of 0 indicates that automatic growth is off and no additional space is allowed. Setup allows the size up to 1024.Default value: 64. Allowed range: Min = 0, Max = 1024 |
| [!INCLUDE ssDEnoversion] | /SQLTEMPDBLOGFILESIZEApplies to: [!INCLUDE sssql16-md] and later versions Optional |
Specifies the initial size of the tempdb log file in MB. Setup allows the size up to 1024.Default value: 4 for [!INCLUDE ssExpress] 8 for all other editions Allowed range: Min = default value (4 or 8), Max = 1024 |
| [!INCLUDE ssDEnoversion] | /SQLTEMPDBLOGFILEGROWTHApplies to: [!INCLUDE sssql16-md] and later versions Optional |
Specifies the file growth increment of the tempdb log file in MB. A value of 0 indicates that automatic growth is off and no additional space is allowed. Setup allows the size up to 1024.Default value: 64. Allowed range: Min = 0, Max = 1024 |
| [!INCLUDE ssDEnoversion] | /SQLUSERDBLOGDIROptional |
Specifies the directory for the log files for user databases. Default value: <InstallSQLDataDir>\<SQLInstanceID>\MSSQL\Data |
| FILESTREAM | /FILESTREAMLEVELOptional |
Specifies the access level for the FILESTREAM feature. Supported values: - 0 = disable FILESTREAM support for this instance. (Default value)- 1 = enable FILESTREAM for [!INCLUDE tsql] access.- 2 = enable FILESTREAM for [!INCLUDE tsql] and file I/O streaming access. (Not valid for Cluster scenarios)- 3 = allow remote clients to have streaming access to FILESTREAM data. |
| FILESTREAM | /FILESTREAMSHARENAMEOptional Required when FILESTREAMLEVEL is greater than 1. |
Specifies the name of the Windows share in which the FILESTREAM data will be stored. |
| [!INCLUDE ssNoVersion] Full Text | /FTSVCACCOUNTOptional |
Specifies the account for Full-Text filter launcher service. This parameter is ignored in [!INCLUDE winserver2008] or higher. ServiceSID is used to help secure the communication between [!INCLUDE ssNoVersion] and Full-text Filter Daemon. If the values aren't provided, the Full-text Filter Launcher Service is disabled. You have to use [!INCLUDE ssNoVersion] Control Manager to change the service account and enable full-text functionality. Default value: Local Service Account |
| [!INCLUDE ssNoVersion] Full Text | /FTSVCPASSWORDOptional |
Specifies the password for the Full-Text filter launcher service. This parameter is ignored in [!INCLUDE winserver2008] or higher. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| [!INCLUDE ssISnoversion] | /ISSVCACCOUNTRequired |
Specifies the account for [!INCLUDE ssISnoversion]. Default value: NT AUTHORITY\NETWORK SERVICE |
| [!INCLUDE ssISnoversion] | /ISSVCPASSWORDRequired |
Specifies the [!INCLUDE ssISnoversion] password. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| [!INCLUDE ssISnoversion] | /ISSVCStartupTypeOptional |
Specifies the startup mode for the [!INCLUDE ssISnoversion] service. |
| [!INCLUDE ssRSnoversion] | /RSINSTALLMODEApplies to: [!INCLUDE sssql16-md] and earlier versions Optional Available only on FilesOnlyMode |
Specifies the Install mode for [!INCLUDE ssRSnoversion]. Supported values: - SharePointFilesOnlyMode- DefaultNativeMode- FilesOnlyModeNote: If the installation includes the [!INCLUDE ssNoVersion] [!INCLUDE ssDE], the default RSINSTALLMODE is DefaultNativeMode.If the installation doesn't include the [!INCLUDE ssNoVersion] [!INCLUDE ssDE], the default RSINSTALLMODE is FilesOnlyMode.If you choose DefaultNativeMode but the installation doesn't include the [!INCLUDE ssNoVersion] [!INCLUDE ssDE], the installation automatically changes the RSINSTALLMODE to FilesOnlyMode. |
| [!INCLUDE ssRSnoversion] | /RSSVCACCOUNTApplies to: [!INCLUDE sssql16-md] and earlier versions Required |
Specifies the startup account for the [!INCLUDE ssRSnoversion]. |
| [!INCLUDE ssRSnoversion] | /RSSVCPASSWORDApplies to: [!INCLUDE sssql16-md] and earlier versions Required |
Specifies the password for the startup account for the [!INCLUDE ssRSnoversion] service. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| [!INCLUDE ssRSnoversion] | /RSSVCStartupTypeApplies to: [!INCLUDE sssql16-md] and earlier versions Optional |
Specifies the startup mode for [!INCLUDE ssRSnoversion]. Supported values: - Automatic- Disabled- Manual |
We recommend that you use Service SID instead of domain groups.
The [!INCLUDE ssDE] and [!INCLUDE ssASnoversion] are the only components that are cluster-aware. Other features aren't cluster-aware and don't have high availability through failover.
To install a single-node [!INCLUDE ssDEnoversion] failover cluster instance with the [!INCLUDE ssDE] and [!INCLUDE ssASnoversion], default instance.
setup.exe /q /ACTION=InstallFailoverCluster /InstanceName=MSSQLSERVER /INDICATEPROGRESS /ASSYSADMINACCOUNTS="<DomainName\UserName>" /ASDATADIR=<Drive>:\OLAP\Data /ASLOGDIR=<Drive>:\OLAP\Log /ASBACKUPDIR=<Drive>:\OLAP\Backup /ASCONFIGDIR=<Drive>:\OLAP\Config /ASTEMPDIR=<Drive>:\OLAP\Temp /FAILOVERCLUSTERDISKS="<Cluster Disk Resource Name - for example, 'Disk S:'" /FAILOVERCLUSTERNETWORKNAME="<Insert Network Name>" /FAILOVERCLUSTERIPADDRESSES="IPv4;xx.xxx.xx.xx;Cluster Network;xxx.xxx.xxx.x" /FAILOVERCLUSTERGROUP="MSSQLSERVER" /Features=AS,SQL /ASSVCACCOUNT="<DomainName\UserName>" /ASSVCPASSWORD="xxxxxxxxxxx" /AGTSVCACCOUNT="<DomainName\UserName>" /AGTSVCPASSWORD="xxxxxxxxxxx" /INSTALLSQLDATADIR="<Drive>:\<Path>\MSSQLSERVER" /SQLCOLLATION="SQL_Latin1_General_CP1_CS_AS" /SQLSVCACCOUNT="<DomainName\UserName>" /SQLSVCPASSWORD="xxxxxxxxxxx" /SQLSYSADMINACCOUNTS="<DomainName\UserName> /IACCEPTSQLSERVERLICENSETERMSUse the parameters in the following table to develop command-line scripts for failover cluster prepare. This is the first step in advanced cluster installation, where you have to prepare the failover cluster instances on all the nodes of the failover cluster. For more information, see Always On failover cluster instances (SQL Server).
| [!INCLUDE ssDEnoversion] component | Parameter | Description |
|---|---|---|
| [!INCLUDE ssde-md] Setup Control | /ACTIONRequired |
Required to indicate the failover cluster prepare work flow. Supported value: PrepareFailoverCluster |
| [!INCLUDE ssde-md] Setup Control | /IACCEPTSQLSERVERLICENSETERMSRequired, when the /Q or /QS parameter is specified for unattended installations |
Required to acknowledge acceptance of the license terms. Beginning with [!INCLUDE sssql22-md], read the Microsoft [!INCLUDE ssNoVersion] Software License Terms at aka.ms/useterms. |
| [!INCLUDE ssde-md] Setup Control | /ENUOptional |
Use this parameter to install the English version of [!INCLUDE ssNoVersion] on a localized operating system when the installation media includes language packs for both English and the language corresponding to the operating system. |
| [!INCLUDE ssde-md] Setup Control | /UpdateEnabledOptional |
Specify whether [!INCLUDE ssNoVersion] Setup should discover and include product updates. The valid values are True and False or 1 and 0. By default, [!INCLUDE ssNoVersion] Setup includes updates that are found. |
| [!INCLUDE ssde-md] Setup Control | /UpdateSourceOptional |
Specify the location where [!INCLUDE ssNoVersion] Setup obtains product updates. The valid values are "MU" to search [!INCLUDE msCoName] Update, a valid folder path, a relative path such as .\MyUpdates, or a UNC share. By default, [!INCLUDE ssNoVersion] Setup searches [!INCLUDE msCoName] Update or a Windows Update Service through the Windows Server Update Services. |
| [!INCLUDE ssde-md] Setup Control | /CONFIGURATIONFILEOptional |
Specifies the configuration file to use. |
| [!INCLUDE ssde-md] Setup Control | /ERRORREPORTINGApplies to: [!INCLUDE sssql14-md] and earlier versions Optional |
To manage how error feedback is sent to Microsoft, see Configure usage and diagnostic data collection for SQL Server (CEIP). In older versions this specifies the error reporting for [!INCLUDE ssNoVersion]. For more information, see SQL Server privacy supplement. Supported values: - 1 = enabled- 0 = disabled |
| [!INCLUDE ssde-md] Setup Control | /FEATURESRequired |
Specifies components to install. |
| [!INCLUDE ssde-md] Setup Control | /HELP or ?Optional |
Displays usage options for the parameters. |
| [!INCLUDE ssde-md] Setup Control | /INDICATEPROGRESSOptional |
Specifies that the verbose Setup log file is piped to the console. |
| [!INCLUDE ssde-md] Setup Control | /INSTALLSHAREDDIROptional |
Specifies a nondefault installation directory for 64-bit shared components. Default is %Program Files%\Microsoft SQL ServerCan't be set to %Program Files(x86)%\Microsoft SQL Server |
| [!INCLUDE ssde-md] Setup Control | /INSTALLSHAREDWOWDIROptional |
Specifies a nondefault installation directory for 32-bit shared components. Supported only on a 64-bit system. Default is %Program Files(x86)%\Microsoft SQL ServerCan't be set to %Program Files%\Microsoft SQL Server |
| [!INCLUDE ssde-md] Setup Control | /INSTANCEDIROptional |
Specifies a nondefault installation directory for instance-specific components. |
| [!INCLUDE ssde-md] Setup Control | /INSTANCEIDOptional |
Specifies a nondefault value for an InstanceID. |
| [!INCLUDE ssde-md] Setup Control | /INSTANCENAMERequired |
Specifies a [!INCLUDE ssDEnoversion] instance name. For more information, see Installation Wizard help. |
| [!INCLUDE ssde-md] Setup Control | /PIDOptional |
Specifies the product key for the edition of [!INCLUDE ssNoVersion]. If this parameter isn't specified, Evaluation is used. Note: If you're installing [!INCLUDE ssExpress], [!INCLUDE ssExpress] with Advanced Services, [!INCLUDE ssExpress] with tools, [!INCLUDE ssdeveloper], or [!INCLUDE ssevaluation], the PID is predefined. |
| [!INCLUDE ssde-md] Setup Control | /Q or /QUIETOptional |
Specifies that Setup runs in a quiet mode without any user interface. This is used for unattended installations. The /Q parameter overrides the input of the /QS parameter. |
| [!INCLUDE ssde-md] Setup Control | /QS or /QUIETSIMPLEOptional |
Specifies that Setup runs and shows progress through the UI, but doesn't accept any input or show any error messages. |
| [!INCLUDE ssde-md] Setup Control | /SQMREPORTINGApplies to: [!INCLUDE sssql14-md] and earlier versions Optional |
To manage how error feedback is sent to Microsoft, see Configure usage and diagnostic data collection for SQL Server (CEIP). In older versions this specifies feature usage reporting for [!INCLUDE ssNoVersion]. Supported values: - 1 = enabled- 0 = disabled |
| [!INCLUDE ssde-md] Setup Control | /HIDECONSOLEOptional |
Specifies that the console window is hidden or closed. |
| [!INCLUDE ssNoVersion] Agent | /AGTSVCACCOUNTRequired |
Specifies the account for the [!INCLUDE ssNoVersion] Agent service. |
| [!INCLUDE ssNoVersion] Agent | /AGTSVCPASSWORDRequired |
Specifies the password for [!INCLUDE ssNoVersion] Agent service account. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| PolyBase Engine | /PBENGSVCACCOUNTOptional |
Specifies the account for the engine service. Default value: NT AUTHORITY\NETWORK SERVICE. |
| PolyBase Data Movement | /PBDMSSVCPASSWORDOptional |
Specifies the password for the data movement account. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| PolyBase Engine | /PBENGSVCSTARTUPTYPEOptional |
Specifies the startup mode for the PolyBase Engine service. Supported values: - Automatic (default)- Disabled- Manual |
| PolyBase | /PBPORTRANGEOptional |
Specifies a port range with at least six ports for PolyBase services. Example:/PBPORTRANGE=16450-16460 |
| PolyBase | /PBSCALEOUTOptional |
Specifies if the [!INCLUDE ssDEnoversion] instance is used as a part of PolyBase Scale-out computational group. Use this option if you're configuring a PolyBase Scale-out computational group including the head node. Supported values: True, False |
| [!INCLUDE ssASnoversion] | /ASSVCACCOUNTRequired |
Specifies the account for the [!INCLUDE ssASnoversion] service. |
| [!INCLUDE ssASnoversion] | /ASSVCPASSWORDRequired |
Specifies the password for the [!INCLUDE ssASnoversion] service. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| [!INCLUDE ssDEnoversion] | /SQLSVCACCOUNTRequired |
Specifies the startup account for the [!INCLUDE ssNoVersion] service. |
| [!INCLUDE ssDEnoversion] | /SQLSVCPASSWORDRequired |
Specifies the password for SQLSVCACCOUNT. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| FILESTREAM | /FILESTREAMLEVELOptional |
Specifies the access level for the FILESTREAM feature. Supported values: - 0 = disable FILESTREAM support for this instance. (Default value)- 1 = enable FILESTREAM for [!INCLUDE tsql] access.- 2 = enable FILESTREAM for [!INCLUDE tsql] and file I/O streaming access. (Not valid for Cluster scenarios)- 3 = allow remote clients to have streaming access to FILESTREAM data. |
| FILESTREAM | /FILESTREAMSHARENAMEOptional Required when FILESTREAMLEVEL is greater than 1. |
Specifies the name of the Windows share in which the FILESTREAM data will be stored. |
| [!INCLUDE ssNoVersion] Full Text | /FTSVCACCOUNTOptional |
Specifies the account for Full-Text filter launcher service. This parameter is ignored in [!INCLUDE winserver2008] or higher. ServiceSID is used to help secure the communication between [!INCLUDE ssNoVersion] and Full-text Filter Daemon. If the values aren't provided, the Full-text Filter Launcher Service is disabled. You have to use [!INCLUDE ssNoVersion] Control Manager to change the service account and enable full-text functionality. Default value: Local Service Account |
| [!INCLUDE ssNoVersion] Full Text | /FTSVCPASSWORDOptional |
Specifies the password for the Full-Text filter launcher service. This parameter is ignored in [!INCLUDE winserver2008] or higher. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| [!INCLUDE ssISnoversion] | /ISSVCACCOUNTRequired |
Specifies the account for [!INCLUDE ssISnoversion]. Default value: NT AUTHORITY\NETWORK SERVICE |
| [!INCLUDE ssISnoversion] | /ISSVCPASSWORDRequired |
Specifies the [!INCLUDE ssISnoversion] password. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| [!INCLUDE ssISnoversion] | /ISSVCStartupTypeOptional |
Specifies the startup mode for the [!INCLUDE ssISnoversion] service. |
| [!INCLUDE ssRSnoversion] | /RSINSTALLMODEApplies to: [!INCLUDE sssql16-md] and earlier versions Optional Available only on FilesOnlyMode |
Specifies the Install mode for [!INCLUDE ssRSnoversion]. Supported values: - SharePointFilesOnlyMode- DefaultNativeMode- FilesOnlyModeNote: If the installation includes the [!INCLUDE ssNoVersion] [!INCLUDE ssDE], the default RSINSTALLMODE is DefaultNativeMode.If the installation doesn't include the [!INCLUDE ssNoVersion] [!INCLUDE ssDE], the default RSINSTALLMODE is FilesOnlyMode.If you choose DefaultNativeMode but the installation doesn't include the [!INCLUDE ssNoVersion] [!INCLUDE ssDE], the installation automatically changes the RSINSTALLMODE to FilesOnlyMode. |
| [!INCLUDE ssRSnoversion] | /RSSVCACCOUNTApplies to: [!INCLUDE sssql16-md] and earlier versions Required |
Specifies the startup account for the [!INCLUDE ssRSnoversion]. |
| [!INCLUDE ssRSnoversion] | /RSSVCPASSWORDApplies to: [!INCLUDE sssql16-md] and earlier versions Required |
Specifies the password for the startup account for the [!INCLUDE ssRSnoversion] service. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| [!INCLUDE ssRSnoversion] | /RSSVCStartupTypeApplies to: [!INCLUDE sssql16-md] and earlier versions Optional |
Specifies the startup mode for [!INCLUDE ssRSnoversion]. Supported values: - Automatic- Disabled- Manual |
We recommend that you use Service SID instead of domain groups.
To perform the "Preparation" step of a failover cluster advanced installation scenario for the [!INCLUDE ssDE] and [!INCLUDE ssASnoversion].
Run the following command from the command prompt to prepare a default instance:
setup.exe /q /ACTION=PrepareFailoverCluster /InstanceName=MSSQLSERVER /Features=AS,SQL /INDICATEPROGRESS /ASSVCACCOUNT="<DomainName\UserName>" /ASSVCPASSWORD="xxxxxxxxxxx" /SQLSVCACCOUNT="<DomainName\UserName>" /SQLSVCPASSWORD="xxxxxxxxxxx" /AGTSVCACCOUNT="<DomainName\UserName>" /AGTSVCPASSWORD="xxxxxxxxxxx" /IACCEPTSQLSERVERLICENSETERMSRun the following command from the command prompt to prepare a named instance:
setup.exe /q /ACTION=PrepareFailoverCluster /InstanceName="<Insert Instance name>" /Features=AS,SQL /INDICATEPROGRESS /ASSVCACCOUNT="<DomainName\UserName>" /ASSVCPASSWORD="xxxxxxxxxxx" /SQLSVCACCOUNT="<DomainName\UserName>" /SQLSVCPASSWORD="xxxxxxxxxxx" /AGTSVCACCOUNT="<DomainName\UserName>" /AGTSVCPASSWORD="xxxxxxxxxxx" /IACCEPTSQLSERVERLICENSETERMS[!INCLUDE sql-eula-link]
Use the parameters in the following table to develop command-line scripts for failover cluster complete. This is the second step in the advanced failover cluster install option. After you have run prepare on all the failover cluster nodes, you run this command on the node that owns the shared disks. For more information, see Always On failover cluster instances (SQL Server).
| [!INCLUDE ssDEnoversion] component | Parameter | Description |
|---|---|---|
| [!INCLUDE ssde-md] Setup Control | /ACTIONRequired |
Required to indicate the failover cluster complete work flow. Supported value: CompleteFailoverCluster |
| [!INCLUDE ssde-md] Setup Control | /ENUOptional |
Use this parameter to install the English version of [!INCLUDE ssNoVersion] on a localized operating system when the installation media includes language packs for both English and the language corresponding to the operating system. |
| [!INCLUDE ssde-md] Setup Control | /FAILOVERCLUSTERGROUPOptional |
Specifies the name of the resource group to be used for the [!INCLUDE ssDEnoversion] failover cluster. It can be the name of an existing cluster group or the name of a new resource group. Default value: SQL Server (<InstanceName>) |
| [!INCLUDE ssde-md] Setup Control | /CONFIGURATIONFILEOptional |
Specifies the configuration file to use. |
| [!INCLUDE ssde-md] Setup Control | /ERRORREPORTINGApplies to: [!INCLUDE sssql14-md] and earlier versions Optional |
To manage how error feedback is sent to Microsoft, see Configure usage and diagnostic data collection for SQL Server (CEIP). In older versions this specifies the error reporting for [!INCLUDE ssNoVersion]. For more information, see SQL Server privacy supplement. Supported values: - 1 = enabled- 0 = disabled |
| [!INCLUDE ssde-md] Setup Control | /HELP or ?Optional |
Displays usage options for the parameters. |
| [!INCLUDE ssde-md] Setup Control | /INDICATEPROGRESSOptional |
Specifies that the verbose Setup log file is piped to the console. |
| [!INCLUDE ssde-md] Setup Control | /INSTANCENAMERequired |
Specifies a [!INCLUDE ssDEnoversion] instance name. For more information, see Installation Wizard help. |
| [!INCLUDE ssde-md] Setup Control | /PIDOptional |
Specifies the product key for the edition of [!INCLUDE ssNoVersion]. If this parameter isn't specified, Evaluation is used. Note: If you're installing [!INCLUDE ssExpress], [!INCLUDE ssExpress] with Advanced Services, [!INCLUDE ssExpress] with tools, [!INCLUDE ssdeveloper], or [!INCLUDE ssevaluation], the PID is predefined. |
| [!INCLUDE ssde-md] Setup Control | /Q or /QUIETOptional |
Specifies that Setup runs in a quiet mode without any user interface. This is used for unattended installations. The /Q parameter overrides the input of the /QS parameter. |
| [!INCLUDE ssde-md] Setup Control | /QS or /QUIETSIMPLEOptional |
Specifies that Setup runs and shows progress through the UI, but doesn't accept any input or show any error messages. |
| [!INCLUDE ssde-md] Setup Control | /SQMREPORTINGApplies to: [!INCLUDE sssql14-md] and earlier versions Optional |
To manage how error feedback is sent to Microsoft, see Configure usage and diagnostic data collection for SQL Server (CEIP). In older versions this specifies feature usage reporting for [!INCLUDE ssNoVersion]. Supported values: - 1 = enabled- 0 = disabled |
| [!INCLUDE ssde-md] Setup Control | /HIDECONSOLEOptional |
Specifies that the console window is hidden or closed. |
| [!INCLUDE ssde-md] Setup Control | /FAILOVERCLUSTERDISKSOptional |
Specifies the list of shared disks to be included in the [!INCLUDE ssDEnoversion] failover cluster resource group. Default value: The first drive is used as the default drive for all databases. |
| [!INCLUDE ssde-md] Setup Control | /FAILOVERCLUSTERIPADDRESSESRequired |
Specifies an encoded IP address. The encodings are semicolon-delimited (;) and follow the format <IP Type>;<address>;<network name>;<subnet mask>. Supported IP types include DHCP, IPv4, and IPv6. You can specify multiple failover cluster IP addresses with a space in between. See the following examples: FAILOVERCLUSTERIPADDRESSES=DEFAULTFAILOVERCLUSTERIPADDRESSES=IPv4;DHCP;ClusterNetwork1FAILOVERCLUSTERIPADDRESSES=IPv6;DHCP;ClusterNetwork1FAILOVERCLUSTERIPADDRESSES=IPv6;2041:0:1a0f::8a5b:131c |
| [!INCLUDE ssde-md] Setup Control | /FAILOVERCLUSTERNETWORKNAMERequired |
Specifies the network name for the new [!INCLUDE ssDEnoversion] failover cluster. This name is used to identify the new [!INCLUDE ssDEnoversion] failover cluster instance on the network. |
| [!INCLUDE ssde-md] Setup Control | /CONFIRMIPDEPENDENCYCHANGERequired |
Indicates the consent to set the IP address resource dependency from OR to AND for multi-subnet failover clusters. For more information, see Add or remove nodes in a failover cluster instance (Setup). Supported values: - 0 = False (default)- 1 = True |
| [!INCLUDE ssASnoversion] | /ASBACKUPDIROptional |
Specifies the directory for [!INCLUDE ssASnoversion] backup files. Default values: For WOW mode on 64-bit: %Program Files(x86)%\Microsoft SQL Server\<INSTANCEDIR>\<ASInstanceID>\OLAP\BackupFor all other installations: %Program Files%\Microsoft SQL Server\<INSTANCEDIR>\<ASInstanceID>\OLAP\Backup |
| [!INCLUDE ssASnoversion] | /ASCOLLATIONOptional |
Specifies the collation setting for [!INCLUDE ssASnoversion]. Default value: Latin1_General_CI_ASNote: Only Windows collation is supported. Using SQL collation can result in unexpected behavior. |
| [!INCLUDE ssASnoversion] | /ASCONFIGDIROptional |
Specifies the directory for [!INCLUDE ssASnoversion] configuration files. Default values: For WOW mode on 64-bit: %Program Files(x86)%\Microsoft SQL Server\<INSTANCEDIR>\<ASInstanceID>\OLAP\ConfigFor all other installations: %Program Files%\Microsoft SQL Server\<INSTANCEDIR>\<ASInstanceID>\OLAP\Config |
| [!INCLUDE ssASnoversion] | /ASDATADIROptional |
Specifies the directory for [!INCLUDE ssASnoversion] data files. Default values: For WOW mode on 64-bit: %Program Files(x86)%\Microsoft SQL Server\<INSTANCEDIR>\<ASInstanceID>\OLAP\DataFor all other installations: %Program Files%\Microsoft SQL Server\<INSTANCEDIR>\<ASInstanceID>\OLAP\Data |
| [!INCLUDE ssASnoversion] | /ASLOGDIROptional |
Specifies the directory for [!INCLUDE ssASnoversion] log files. Default values: For WOW mode on 64-bit: %Program Files(x86)%\Microsoft SQL Server\<INSTANCEDIR>\<ASInstanceID>\OLAP\LogFor all other installations: %Program Files%\Microsoft SQL Server\<INSTANCEDIR>\<ASInstanceID>\OLAP\Log |
| [!INCLUDE ssASnoversion] | /ASSERVERMODEOptional |
Specifies the server mode of the [!INCLUDE ssASnoversion] instance. Valid values in a cluster scenario are MULTIDIMENSIONAL or TABULAR. ASSERVERMODE is case-sensitive. All values must be expressed in uppercase. For more information about valid values, see Install Analysis Services in Tabular Mode. |
| [!INCLUDE ssASnoversion] | /ASSYSADMINACCOUNTSRequired |
Specifies the administrator credentials for [!INCLUDE ssASnoversion]. |
| [!INCLUDE ssASnoversion] | /ASTEMPDIROptional |
Specifies the directory for [!INCLUDE ssASnoversion] temporary files. Default values: For WOW mode on 64-bit: %Program Files(x86)%\Microsoft SQL Server\<INSTANCEDIR>\<ASInstanceID>\OLAP\TempFor all other installations: %Program Files%\Microsoft SQL Server\<INSTANCEDIR>\<ASInstanceID>\OLAP\Temp |
| [!INCLUDE ssASnoversion] | /ASPROVIDERMSOLAPOptional |
Specifies whether the MSOLAP provider can run in-process. Default value: - 1 = enabled |
| [!INCLUDE ssDEnoversion] | /INSTALLSQLDATADIRRequired |
Specifies the data directory for [!INCLUDE ssNoVersion] data files. The data directory must be specified and on a shared cluster disk. |
| [!INCLUDE ssDEnoversion] | /SAPWDRequired, when /SECURITYMODE=SQL |
Specifies the password for the [!INCLUDE ssNoVersion] SA account. |
| [!INCLUDE ssDEnoversion] | /SECURITYMODEOptional |
Specifies the security mode for [!INCLUDE ssNoVersion]. If this parameter isn't supplied, then Windows-only authentication mode is supported. Supported value: SQL |
| [!INCLUDE ssDEnoversion] | /SQLBACKUPDIROptional |
Specifies the directory for backup files. Default value: <InstallSQLDataDir>\<SQLInstanceID>\MSSQL\Backup |
| [!INCLUDE ssDEnoversion] | /SQLCOLLATIONOptional |
Specifies the collation settings for [!INCLUDE ssNoVersion]. The default value is based on the locale of your Windows operating system. For more information, see Collation and Unicode support. |
| [!INCLUDE ssDEnoversion] | /SQLSYSADMINACCOUNTSRequired |
Use this parameter to provision logins to be members of the sysadmin role. For [!INCLUDE ssNoVersion] editions other than [!INCLUDE ssExpress], /SQLSYSADMINACCOUNTS is required. For editions of [!INCLUDE ssExpress], use of /SQLSYSADMINACCOUNTS is optional, but either /SQLSYSADMINACCOUNTS or /ADDCURRENTUSERASSQLADMIN is required. |
| [!INCLUDE ssDEnoversion] | /SQLUSERDBDIROptional |
Specifies the directory for the data files for user databases. Default value: <InstallSQLDataDir>\<SQLInstanceID>\MSSQL\Data |
| [!INCLUDE ssDEnoversion] | /SQLUSERDBLOGDIROptional |
Specifies the directory for the log files for user databases. Default value: <InstallSQLDataDir>\<SQLInstanceID>\MSSQL\Data |
| [!INCLUDE ssRSnoversion] | /RSINSTALLMODEApplies to: [!INCLUDE sssql16-md] and earlier versions Optional Available only on FilesOnlyMode |
Specifies the Install mode for [!INCLUDE ssRSnoversion]. Supported values: - SharePointFilesOnlyMode- DefaultNativeMode- FilesOnlyModeNote: If the installation includes the [!INCLUDE ssNoVersion] [!INCLUDE ssDE], the default RSINSTALLMODE is DefaultNativeMode.If the installation doesn't include the [!INCLUDE ssNoVersion] [!INCLUDE ssDE], the default RSINSTALLMODE is FilesOnlyMode.If you choose DefaultNativeMode but the installation doesn't include the [!INCLUDE ssNoVersion] [!INCLUDE ssDE], the installation automatically changes the RSINSTALLMODE to FilesOnlyMode. |
| [!INCLUDE ssDEnoversion] | /SQLTEMPDBDIROptional |
Specifies the directories for tempdb data files. When specifying more than one directory, separate the directories with a blank space. If multiple directories are specified, the tempdb data files are spread across the directories in a round-robin fashion.Default value: <InstallSQLDataDir>\<SQLInstanceID>\MSSQL\Data (System Data Directory)Note: This parameter is added to RebuildDatabase scenario as well. |
| [!INCLUDE ssDEnoversion] | /SQLTEMPDBLOGDIROptional |
Specifies the directory for tempdb log file.Default value: <InstallSQLDataDir>\<SQLInstanceID>\MSSQL\Data (System Data Directory)Note: This parameter is added to RebuildDatabase scenario as well. |
| [!INCLUDE ssDEnoversion] | /SQLTEMPDBFILECOUNTOptional |
Specifies the number of tempdb data files to be added by setup. This value can be increased up to the number of cores.Default value: 1 for [!INCLUDE ssExpress] 8 or the number of cores, whichever is lower for all other editions Important: The primary database file for tempdb is still tempdb.mdf. The additional tempdb files are named as tempdb_mssql_#.ndf where # represents a unique number for each additional tempdb database file created during setup. The purpose of this naming convention is to make them unique. Uninstalling an instance of [!INCLUDE ssNoVersion] deletes the files with naming convention tempdb_mssql_#.ndf. Don't use tempdb_mssql_\*.ndf naming convention for user database files.Warning: [!INCLUDE ssExpress] isn't supported for configuring this parameter. Setup installs only 1 tempdb data file. |
| [!INCLUDE ssDEnoversion] | /SQLTEMPDBFILESIZEApplies to: [!INCLUDE sssql16-md] and later versions Optional |
Specifies the initial size of each tempdb data file.Default = 4 MB for [!INCLUDE ssExpress], 8 MB for all other editions Min = 4 MB or 8 MB Max = 1024 MB |
| [!INCLUDE ssDEnoversion] | /SQLTEMPDBFILEGROWTHOptional |
Specifies the file growth increment of each tempdb data file in MB. A value of 0 indicates that automatic growth is off and no additional space is allowed. Setup allows the size up to 1024.Default value: 64. Allowed range: Min = 0, Max = 1024 |
| [!INCLUDE ssDEnoversion] | /SQLTEMPDBLOGFILESIZEApplies to: [!INCLUDE sssql16-md] and later versions Optional |
Specifies the initial size of the tempdb log file in MB. Setup allows the size up to 1024.Default value: 4 for [!INCLUDE ssExpress] 8 for all other editions Allowed range: Min = default value (4 or 8), Max = 1024 |
| [!INCLUDE ssDEnoversion] | /SQLTEMPDBLOGFILEGROWTHApplies to: [!INCLUDE sssql16-md] and later versions Optional |
Specifies the file growth increment of the tempdb log file in MB. A value of 0 indicates that automatic growth is off and no additional space is allowed. Setup allows the size up to 1024.Default value: 64. Allowed range: Min = 0, Max = 1024 |
To perform the "Completion" step of a failover cluster advanced installation scenario for the [!INCLUDE ssDE] and [!INCLUDE ssASnoversion]. Run the following command on the computer that is the active node in the failover cluster to make it usable. You must run the "CompleteFailoverCluster" action on the node that owns the shared disk in the [!INCLUDE ssASnoversion] failover cluster.
Run the following command from the command prompt to complete failover cluster installation for a default instance:
setup.exe /q /ACTION=CompleteFailoverCluster /InstanceName=MSSQLSERVER /INDICATEPROGRESS /ASSYSADMINACCOUNTS="<DomainName\Username>" /ASDATADIR=<Drive>:\OLAP\Data /ASLOGDIR=<Drive>:\OLAP\Log /ASBACKUPDIR=<Drive>:\OLAP\Backup /ASCONFIGDIR=<Drive>:\OLAP\Config /ASTEMPDIR=<Drive>:\OLAP\Temp /FAILOVERCLUSTERDISKS="<Cluster Disk Resource Name - for example, 'Disk S:'>:" /FAILOVERCLUSTERNETWORKNAME="<Insert FOI Network Name>" /FAILOVERCLUSTERIPADDRESSES="IPv4;xx.xxx.xx.xx;Cluster Network;xxx.xxx.xxx.x" /FAILOVERCLUSTERGROUP="MSSQLSERVER" /INSTALLSQLDATADIR="<Drive>:\<Path>\MSSQLSERVER" /SQLCOLLATION="SQL_Latin1_General_CP1_CS_AS" /SQLSYSADMINACCOUNTS="<DomainName\UserName>"Run the following command from the command prompt to complete failover cluster installation for a named instance:
setup.exe /q /ACTION=CompleteFailoverCluster /InstanceName="<Insert Instance Name>" /INDICATEPROGRESS /ASSYSADMINACCOUNTS="<DomainName\UserName>" /ASDATADIR=<Drive>:\INSTANCE\Data /ASLOGDIR=<drive>:\INSTANCE\Log /ASBACKUPDIR=<Drive>:\INSTANCE\Backup /ASCONFIGDIR=<Drive>:\INSTANCE\Config /ASTEMPDIR=<Drive>:\INSTANCE\Temp /FAILOVERCLUSTERDISKS="<Cluster Disk Resource Name - for example, 'Disk S:'>" /FAILOVERCLUSTERNETWORKNAME="CompNamedFOI" /FAILOVERCLUSTERIPADDRESSES="IPv4;xx.xxx.xx.xx;ClusterNetwork1;xxx.xxx.xxx.x" /FAILOVERCLUSTERGROUP="<Insert New Group Name>" /INSTALLSQLDATADIR="<Drive>:\<Path>\MSSQLSERVER_INSTANCE" /SQLCOLLATION="SQL_Latin1_General_CP1_CS_AS" /SQLSYSADMINACCOUNTS="<DomainName\Username>"Use the parameters in the following table to develop command-line scripts for failover cluster upgrade. For more information, see [Upgrade a [!INCLUDE ssDEnoversion] failover Cluster Instance (Setup)](../../sql-server/failover-clusters/windows/upgrade-a-sql-server-failover-cluster-instance-setup.md) and Always On failover cluster instances (SQL Server).
| [!INCLUDE ssDEnoversion] component | Parameter | Description |
|---|---|---|
| [!INCLUDE ssde-md] Setup Control | /ACTIONRequired |
Required to indicate the installation workflow. Supported value: Upgrade |
| [!INCLUDE ssde-md] Setup Control | /IACCEPTSQLSERVERLICENSETERMSRequired, when the /Q or /QS parameter is specified for unattended installations |
Required to acknowledge acceptance of the license terms. Beginning with [!INCLUDE sssql22-md], read the Microsoft [!INCLUDE ssNoVersion] Software License Terms at aka.ms/useterms. |
| [!INCLUDE ssde-md] Setup Control | /ENUOptional |
Use this parameter to install the English version of [!INCLUDE ssNoVersion] on a localized operating system when the installation media includes language packs for both English and the language corresponding to the operating system. |
| [!INCLUDE ssde-md] Setup Control | /UpdateEnabledOptional |
Specify whether [!INCLUDE ssNoVersion] Setup should discover and include product updates. The valid values are True and False or 1 and 0. By default, [!INCLUDE ssNoVersion] Setup includes updates that are found. |
| [!INCLUDE ssde-md] Setup Control | /UpdateSourceOptional |
Specify the location where [!INCLUDE ssNoVersion] Setup obtains product updates. The valid values are "MU" to search [!INCLUDE msCoName] Update, a valid folder path, a relative path such as .\MyUpdates, or a UNC share. By default, [!INCLUDE ssNoVersion] Setup searches [!INCLUDE msCoName] Update or a Windows Update Service through the Windows Server Update Services. |
| [!INCLUDE ssde-md] Setup Control | /CONFIGURATIONFILEOptional |
Specifies the configuration file to use. |
| [!INCLUDE ssde-md] Setup Control | /ERRORREPORTINGApplies to: [!INCLUDE sssql14-md] and earlier versions Optional |
To manage how error feedback is sent to Microsoft, see Configure usage and diagnostic data collection for SQL Server (CEIP). In older versions this specifies the error reporting for [!INCLUDE ssNoVersion]. For more information, see SQL Server privacy supplement. Supported values: - 1 = enabled- 0 = disabled |
| [!INCLUDE ssde-md] Setup Control | /HELP or ?Optional |
Displays usage options for the parameters. |
| [!INCLUDE ssde-md] Setup Control | /INDICATEPROGRESSOptional |
Specifies that the verbose Setup log file is piped to the console. |
| [!INCLUDE ssde-md] Setup Control | / INSTANCEDIROptional |
Specifies a nondefault installation directory for shared components. |
| [!INCLUDE ssde-md] Setup Control | /INSTANCEIDRequired, when you upgrade from [!INCLUDE sql2008-md] or later versions. Optional, when you upgrade from [!INCLUDE ssVersion2005]. |
Specifies a nondefault value for an InstanceID. |
| [!INCLUDE ssde-md] Setup Control | /INSTANCENAMERequired |
Specifies a [!INCLUDE ssDEnoversion] instance name. For more information, see Installation Wizard help. |
| [!INCLUDE ssde-md] Setup Control | /PIDOptional |
Specifies the product key for the edition of [!INCLUDE ssNoVersion]. If this parameter isn't specified, Evaluation is used. Note: If you're installing [!INCLUDE ssExpress], [!INCLUDE ssExpress] with Advanced Services, [!INCLUDE ssExpress] with tools, [!INCLUDE ssdeveloper], or [!INCLUDE ssevaluation], the PID is predefined. |
| [!INCLUDE ssde-md] Setup Control | /Q or /QUIETOptional |
Specifies that Setup runs in a quiet mode without any user interface. This is used for unattended installations. The /Q parameter overrides the input of the /QS parameter. |
| [!INCLUDE ssde-md] Setup Control | /SQMREPORTINGApplies to: [!INCLUDE sssql14-md] and earlier versions Optional |
To manage how error feedback is sent to Microsoft, see Configure usage and diagnostic data collection for SQL Server (CEIP). In older versions this specifies feature usage reporting for [!INCLUDE ssNoVersion]. Supported values: - 1 = enabled- 0 = disabled |
| [!INCLUDE ssde-md] Setup Control | /HIDECONSOLEOptional |
Specifies that the console window is hidden or closed. |
| [!INCLUDE ssde-md] Setup Control | /FAILOVERCLUSTERROLLOWNERSHIPRequired |
Specifies the failover behavior during upgrade. |
| [!INCLUDE ssNoVersion] Browser | /BROWSERSVCSTARTUPTYPEOptional |
Specifies the startup mode for [!INCLUDE ssNoVersion] Browser service. Supported values: - Automatic- Disabled- Manual |
| [!INCLUDE ssNoVersion] Full-Text | /FTUPGRADEOPTIONOptional |
Specifies the Full-Text catalog upgrade option. Supported values: - REBUILD- RESET- IMPORT |
| [!INCLUDE ssISnoversion] | /ISSVCACCOUNTRequired |
Specifies the account for [!INCLUDE ssISnoversion]. Default value: NT AUTHORITY\NETWORK SERVICE |
| [!INCLUDE ssISnoversion] | /ISSVCPASSWORDRequired |
Specifies the [!INCLUDE ssISnoversion] password. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| [!INCLUDE ssISnoversion] | /ISSVCStartupTypeOptional |
Specifies the startup mode for the [!INCLUDE ssISnoversion] service. |
| [!INCLUDE ssRSnoversion] | /RSUPGRADEDATABASEACCOUNTOptional |
The property is only used when upgrading a SharePoint mode Report Server that is version 2008 R2 or earlier. Additional upgrade operations are performed for report servers that use the older SharePoint mode architecture, which was changed in [!INCLUDE ssSQL11] [!INCLUDE ssRSnoversion]. If this option isn't included with the command-line installation, the default service account for the old report server instance is used. If this property is used, supply the password for the account using the /RSUPGRADEPASSWORD property. |
| [!INCLUDE ssRSnoversion] | /RSUPGRADEPASSWORDOptional |
Password of the existing Report Server service account. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
Use the parameters in the following table to develop command-line scripts for AddNode.
| [!INCLUDE ssDEnoversion] component | Parameter | Description |
|---|---|---|
| [!INCLUDE ssde-md] Setup Control | /ACTIONRequired |
Required to indicate AddNode work flow. Supported value: AddNode |
| [!INCLUDE ssde-md] Setup Control | /IACCEPTSQLSERVERLICENSETERMSRequired, when the /Q or /QS parameter is specified for unattended installations |
Required to acknowledge acceptance of the license terms. Beginning with [!INCLUDE sssql22-md], read the Microsoft [!INCLUDE ssNoVersion] Software License Terms at aka.ms/useterms. |
| [!INCLUDE ssde-md] Setup Control | /ENUOptional |
Use this parameter to install the English version of [!INCLUDE ssNoVersion] on a localized operating system when the installation media includes language packs for both English and the language corresponding to the operating system. |
| [!INCLUDE ssde-md] Setup Control | /UpdateEnabledOptional |
Specify whether [!INCLUDE ssNoVersion] Setup should discover and include product updates. The valid values are True and False or 1 and 0. By default, [!INCLUDE ssNoVersion] Setup includes updates that are found. |
| [!INCLUDE ssde-md] Setup Control | /UpdateSourceOptional |
Specify the location where [!INCLUDE ssNoVersion] Setup obtains product updates. The valid values are "MU" to search [!INCLUDE msCoName] Update, a valid folder path, a relative path such as .\MyUpdates, or a UNC share. By default, [!INCLUDE ssNoVersion] Setup searches [!INCLUDE msCoName] Update or a Windows Update Service through the Windows Server Update Services. |
| [!INCLUDE ssde-md] Setup Control | /CONFIGURATIONFILEOptional |
Specifies the configuration file to use. |
| [!INCLUDE ssde-md] Setup Control | /HELP or ?Optional |
Displays usage options for the parameters. |
| [!INCLUDE ssde-md] Setup Control | /INDICATEPROGRESSOptional |
Specifies that the verbose Setup log file is piped to the console. |
| [!INCLUDE ssde-md] Setup Control | /INSTANCENAMERequired |
Specifies a [!INCLUDE ssDEnoversion] instance name. For more information, see Installation Wizard help. |
| [!INCLUDE ssde-md] Setup Control | /PIDOptional |
Specifies the product key for the edition of [!INCLUDE ssNoVersion]. If this parameter isn't specified, Evaluation is used. Note: If you're installing [!INCLUDE ssExpress], [!INCLUDE ssExpress] with Advanced Services, [!INCLUDE ssExpress] with tools, [!INCLUDE ssdeveloper], or [!INCLUDE ssevaluation], the PID is predefined. |
| [!INCLUDE ssde-md] Setup Control | /Q or /QUIETOptional |
Specifies that Setup runs in a quiet mode without any user interface. This is used for unattended installations. The /Q parameter overrides the input of the /QS parameter. |
| [!INCLUDE ssde-md] Setup Control | /QS or /QUIETSIMPLEOptional |
Specifies that Setup runs and shows progress through the UI, but doesn't accept any input or show any error messages. |
| [!INCLUDE ssde-md] Setup Control | /HIDECONSOLEOptional |
Specifies that the console window is hidden or closed. |
| [!INCLUDE ssde-md] Setup Control | /FAILOVERCLUSTERIPADDRESSESRequired |
Specifies an encoded IP address. The encodings are semicolon-delimited (;) and follow the format <IP Type>;<address>;<network name>;<subnet mask>. Supported IP types include DHCP, IPv4, and IPv6. You can specify multiple failover cluster IP addresses with a space in between. See the following examples: FAILOVERCLUSTERIPADDRESSES=DEFAULTFAILOVERCLUSTERIPADDRESSES=IPv4;DHCP;ClusterNetwork1FAILOVERCLUSTERIPADDRESSES=IPv6;DHCP;ClusterNetwork1FAILOVERCLUSTERIPADDRESSES=IPv6;2041:0:1a0f::8a5b:131cFor more information, see Add or remove nodes in a failover cluster instance (Setup). |
| [!INCLUDE ssde-md] Setup Control | /CONFIRMIPDEPENDENCYCHANGERequired |
Indicates the consent to set the IP address resource dependency from OR to AND for multi-subnet failover clusters. For more information, see Add or remove nodes in a failover cluster instance (Setup). Supported values: - 0 = False (default)- 1 = True |
| [!INCLUDE ssNoVersion] Agent | /AGTSVCACCOUNTRequired |
Specifies the account for the [!INCLUDE ssNoVersion] Agent service. |
| [!INCLUDE ssNoVersion] Agent | /AGTSVCPASSWORDRequired |
Specifies the password for [!INCLUDE ssNoVersion] Agent service account. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| PolyBase Engine | /PBENGSVCACCOUNTOptional |
Specifies the account for the engine service. Default value: NT AUTHORITY\NETWORK SERVICE. |
| PolyBase Data Movement | /PBDMSSVCPASSWORDOptional |
Specifies the password for the data movement account. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| PolyBase Engine | /PBENGSVCSTARTUPTYPEOptional |
Specifies the startup mode for the PolyBase Engine service. Supported values: - Automatic (default)- Disabled- Manual |
| PolyBase | /PBPORTRANGEOptional |
Specifies a port range with at least six ports for PolyBase services. Example:/PBPORTRANGE=16450-16460 |
| PolyBase | /PBSCALEOUTOptional |
Specifies if the [!INCLUDE ssDEnoversion] instance is used as a part of PolyBase Scale-out computational group. Use this option if you're configuring a PolyBase Scale-out computational group including the head node. Supported values: True, False |
| [!INCLUDE ssASnoversion] | /ASSVCACCOUNTRequired |
Specifies the account for the [!INCLUDE ssASnoversion] service. |
| [!INCLUDE ssASnoversion] | /ASSVCPASSWORDRequired |
Specifies the password for the [!INCLUDE ssASnoversion] service. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| [!INCLUDE ssDEnoversion] | /SQLSVCACCOUNTRequired |
Specifies the startup account for the [!INCLUDE ssNoVersion] service. |
| [!INCLUDE ssDEnoversion] | /SQLSVCPASSWORDRequired |
Specifies the password for SQLSVCACCOUNT. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| [!INCLUDE ssISnoversion] | /ISSVCPASSWORDRequired |
Specifies the [!INCLUDE ssISnoversion] password. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| [!INCLUDE ssRSnoversion] | /RSINSTALLMODEApplies to: [!INCLUDE sssql16-md] and earlier versions Optional Available only on FilesOnlyMode |
Specifies the Install mode for [!INCLUDE ssRSnoversion]. Supported values: - SharePointFilesOnlyMode- DefaultNativeMode- FilesOnlyModeNote: If the installation includes the [!INCLUDE ssNoVersion] [!INCLUDE ssDE], the default RSINSTALLMODE is DefaultNativeMode.If the installation doesn't include the [!INCLUDE ssNoVersion] [!INCLUDE ssDE], the default RSINSTALLMODE is FilesOnlyMode.If you choose DefaultNativeMode but the installation doesn't include the [!INCLUDE ssNoVersion] [!INCLUDE ssDE], the installation automatically changes the RSINSTALLMODE to FilesOnlyMode. |
| [!INCLUDE ssRSnoversion] | /RSSVCPASSWORDApplies to: [!INCLUDE sssql16-md] and earlier versions Required |
Specifies the password for the startup account for the [!INCLUDE ssRSnoversion] service. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
The [!INCLUDE ssDE] and [!INCLUDE ssASnoversion] are the only components that are cluster-aware. Other features aren't cluster-aware and don't have high availability through failover.
To add a node to an existing failover cluster instance with the [!INCLUDE ssDE] and [!INCLUDE ssASnoversion].
setup.exe /q /ACTION=AddNode /INSTANCENAME="<Insert Instance Name>" /SQLSVCACCOUNT="<SQL account that is used on other nodes>" /SQLSVCPASSWORD="<password for SQL account>" /AGTSVCACCOUNT="<SQL Server Agent account that is used on other nodes>", /AGTSVCPASSWORD="<SQL Server Agent account password>" /ASSVCACCOUNT="<AS account that is used on other nodes>" /ASSVCPASSWORD="<password for AS account>" /INDICATEPROGRESS /IACCEPTSQLSERVERLICENSETERMS /FAILOVERCLUSTERIPADDRESSES="IPv4;xx.xxx.xx.xx;ClusterNetwork1;xxx.xxx.xxx.x" /CONFIRMIPDEPENDENCYCHANGE=0Use the parameters in the following table to develop command-line scripts for RemoveNode. To uninstall a failover cluster, you must run RemoveNode on each failover cluster node. For more information, see Always On failover cluster instances (SQL Server).
| [!INCLUDE ssDEnoversion] component | Parameter | Description |
|---|---|---|
| [!INCLUDE ssde-md] Setup Control | /ACTIONRequired |
Required to indicate RemoveNode work flow. Supported value: RemoveNode |
| [!INCLUDE ssde-md] Setup Control | /CONFIGURATIONFILEOptional |
Specifies the configuration file to use. |
| [!INCLUDE ssde-md] Setup Control | /HELP or ?Optional |
Displays usage options for the parameters. |
| [!INCLUDE ssde-md] Setup Control | /INDICATEPROGRESSOptional |
Specifies that the verbose Setup log file is piped to the console. |
| [!INCLUDE ssde-md] Setup Control | /INSTANCENAMERequired |
Specifies a [!INCLUDE ssDEnoversion] instance name. For more information, see Installation Wizard help. |
| [!INCLUDE ssde-md] Setup Control | /Q or /QUIETOptional |
Specifies that Setup runs in a quiet mode without any user interface. This is used for unattended installations. The /Q parameter overrides the input of the /QS parameter. |
| [!INCLUDE ssde-md] Setup Control | /QS or /QUIETSIMPLEOptional |
Specifies that Setup runs and shows progress through the UI, but doesn't accept any input or show any error messages. |
| [!INCLUDE ssde-md] Setup Control | /HIDECONSOLEOptional |
Specifies that the console window is hidden or closed. |
| [!INCLUDE ssde-md] Setup Control | /CONFIRMIPDEPENDENCYCHANGERequired |
Indicates the consent to set the IP address resource dependency from OR to AND for multi-subnet failover clusters. For more information, see Add or remove nodes in a failover cluster instance (Setup). Supported values: - 0 = False (default)- 1 = True |
To remove a node from an existing failover cluster instance with the [!INCLUDE ssDE] and [!INCLUDE ssASnoversion].
setup.exe /q /ACTION=RemoveNode /INSTANCENAME="<Insert Instance Name>" [/INDICATEPROGRESS] /CONFIRMIPDEPENDENCYCHANGE=0You can configure the [!INCLUDE ssNoVersion] services by using a built-in account, local account, or domain account.
Note
When you use a managed service account, virtual account, or a built-in account, you shouldn't specify the corresponding password parameters. For more information about these service accounts, see Managed service accounts, group-managed service accounts, and virtual accounts.
For more information about service account configuration, see Configure Windows service accounts and permissions.
| [!INCLUDE ssDEnoversion] component | Account parameter | Password parameter | Startup type |
|---|---|---|---|
| [!INCLUDE ssNoVersion] Agent | /AGTSVCACCOUNT |
/AGTSVCPASSWORD |
/AGTSVCSTARTUPTYPE |
| [!INCLUDE ssASnoversion] | /ASSVCACCOUNT |
/ASSVCPASSWORD |
/ASSVCSTARTUPTYPE |
| [!INCLUDE ssDEnoversion] | /SQLSVCACCOUNT |
/SQLSVCPASSWORD |
/SQLSVCSTARTUPTYPE |
| [!INCLUDE ssISnoversion] | /ISSVCACCOUNT |
/ISSVCPASSWORD |
/ISSVCSTARTUPTYPE |
| [!INCLUDE ssRSnoversion] | /RSSVCACCOUNT |
/RSSVCPASSWORD |
/RSSVCSTARTUPTYPE |
Note
[!INCLUDE ssRSnoversion] features were removed from [!INCLUDE sssql17-md]. The account parameters for [!INCLUDE ssNoVersion] [!INCLUDE ssRSnoversion] are only applicable to versions prior to [!INCLUDE sssql17-md].
To install specific features, use the /FEATURES parameter and specify the parent feature or feature values in the following table.
[!INCLUDE editions-supported-features-windows]
| Parent feature parameter | Feature parameter | Description |
|---|---|---|
| SQL | Installs the [!INCLUDE ssDEnoversion], Replication, Fulltext, and [!INCLUDE ssDQSServer]. | |
| SQLEngine | Installs just the [!INCLUDE ssDEnoversion]. | |
| Replication | Installs the Replication component along with [!INCLUDE ssDEnoversion]. | |
| FullText | Installs the FullText component along with [!INCLUDE ssDEnoversion]. | |
| DQ | Copies the files required for completing the [!INCLUDE ssDQSServer] installation. After completing [!INCLUDE ssNoVersion] installation, you must run the DQSInstaller.exe file to complete the [!INCLUDE ssDQSServer] installation. For more information, see Run DQSInstaller.exe to Complete Data Quality Server Installation. This also installs [!INCLUDE ssDEnoversion]. | |
| PolyBase | Installs PolyBase components. | |
| PolyBaseCore | Pair with PolyBase to install PolyBase technology that enables truly integrated querying across Oracle, Teradata, [!INCLUDE ssNoVersion] and other relational and non-relational data using standard T-SQL statements.Applies to: [!INCLUDE sql-server-2019] and later versions |
|
| PolyBaseJava | In [!INCLUDE sssql19-md] only, pair with PolyBase to install PolyBase Java Connector that enables truly integrated querying across HDFS data using standard T-SQL statements. |
|
| AdvancedAnalytics | Installs SQL Server Machine Learning Services or SQL Server 2016 R Services. | |
| SQL_INST_MR | Pair with AdvancedAnalytics to install R Open and proprietary R packages.Applies to: SQL Server Machine Learning Services (2017 and 2019) and SQL Server 2016 R Services |
|
| SQL_INST_MPY | Pair with AdvancedAnalytics to install Anaconda and proprietary Python packages.Applies to: SQL Server Machine Learning Services (2017 and 2019) |
|
| SQL_INST_JAVA | Pair with AdvancedAnalytics to install extensions that enable integration with Java using standard T-SQL statements.Applies to: SQL Server Java Language Extension (2019 only) |
|
| AS | Installs all [!INCLUDE ssASnoversion] components. | |
| RS | Installs all [!INCLUDE ssRSnoversion] components. Applies to: [!INCLUDE sssql16-md] and earlier versions |
|
| RS_SHP | Installs [!INCLUDE ssRSnoversion] components for SharePoint. Applies to: [!INCLUDE sssql16-md] and earlier versions |
|
| RS_SHPWFE | Installs [!INCLUDE ssRSnoversion] Add-In for SharePoint products. Applies to: [!INCLUDE sssql16-md] and earlier versions |
|
| DQC | Installs [!INCLUDE ssDQSClient]. | |
| IS | Installs all [!INCLUDE ssISnoversion] components. | |
| IS_Master | Includes Scale Out Master for Integration Services Scale Out. | |
| IS_Worker | Includes Scale Out Worker for Integration Services Scale Out. | |
| MDS | Installs [!INCLUDE ssMDSshort]. | |
| SQL_SHARED_MPY | Installs Python packages for Machine Learning Server (Standalone) or R Server (Standalone) | |
| SQL_SHARED_MR | Installs R packages for Machine Learning Server (Standalone) or R Server (Standalone) or Machine Learning Server (Standalone) or R Server (Standalone) | |
| Tools 1 | Installs client tools and [!INCLUDE ssNoVersion] Books Online components. Applies to: [!INCLUDE sssql19-md] and earlier versions |
|
| BC | Installs backward compatibility components. Applies to: [!INCLUDE sssql19-md] and earlier versions |
|
| Conn | Installs connectivity components. Applies to: [!INCLUDE sssql19-md] and earlier versions |
|
| DREPLAY_CTLR | Installs Distributed Replay controller. Applies to: [!INCLUDE sssql19-md] and earlier versions |
|
| DREPLAY_CLT | Installs Distributed Replay client. Applies to: [!INCLUDE sssql19-md] and earlier versions |
|
| SNAC_SDK | Installs SDK for [!INCLUDE ssNoVersion] Native Client. Applies to: [!INCLUDE sssql19-md] and earlier versions |
|
| SDK | Installs the software development kit. Applies to: [!INCLUDE sssql19-md] and earlier versions |
|
| LocalDB** | Installs LocalDB, an execution mode of [!INCLUDE ssExpress] targeted to program developers. |
1 [!INCLUDE ssManStudioFull] (SSMS) is now in a standalone installer that is separate from the [!INCLUDE ssnoversion] installer. For details, see Install SQL Server Management Studio.
| Parameter and values | Description |
|---|---|
/FEATURES=SQLEngine |
Installs the [!INCLUDE ssDE] without replication and full-text. |
/FEATURES=SQLEngine,FullText |
Installs the [!INCLUDE ssDE] and full-text. |
/FEATURES=SQL |
Installs the [!INCLUDE ssDE], replication, and full-text. |
/FEATURES=SQLEngine,PolyBase |
Installs the [!INCLUDE ssDE] and the PolyBase engine. |
The setup role or /ROLE parameter is used to install a preconfigured selection of features. The SSAS roles install an SSAS instance in either an existing SharePoint farm, or a new unconfigured farm. Two setup roles are provided to support each scenario. You can only choose one setup role to install at a time. If you choose a setup role, Setup installs the features and components that belong to the role. You can't vary the features and components that are designated for that role. For more information about how to use the feature role parameter, see Install Power Pivot from the Command Prompt.
The AllFeatures_WithDefaults role is the default behavior for editions of [!INCLUDE ssExpress] and reduces the number of dialog boxes presented to the user. It can be specified from the command prompt when installing a [!INCLUDE ssNoVersion] edition that isn't [!INCLUDE ssExpress].
| Role | Description | Installs... |
|---|---|---|
SPI_AS_ExistingFarm |
Installs [!INCLUDE ssASnoversion] as a [!INCLUDE power-pivot-md] named instance on an existing [!INCLUDE SPS2010] farm or standalone server. | [!INCLUDE ssASnoversion] calculation engine, preconfigured for in-memory data storage and processing. [!INCLUDE power-pivot-md] solution packages Installer program for the [!INCLUDE power-pivot-excel-md] [!INCLUDE ssNoVersion] Books Online |
SPI_AS_NewFarm |
Installs [!INCLUDE ssASnoversion] and [!INCLUDE ssDE] as a [!INCLUDE power-pivot-md] named instance on a new, unconfigured Office [!INCLUDE SPS2010] farm or standalone server. [!INCLUDE ssNoVersion] Setup configures the farm during feature role installation. | [!INCLUDE ssASnoversion] calculation engine, preconfigured for in-memory data storage and processing. [!INCLUDE power-pivot-md] solution packages [!INCLUDE ssNoVersion] Books Online [!INCLUDE ssDE] Configuration Tools [!INCLUDE ssManStudioFull] |
AllFeatures_WithDefaults |
Installs all features that are available with the current edition. Adds the current user to the [!INCLUDE ssNoVersion] sysadmin fixed server role. On [!INCLUDE winserver2008] or higher and when the operating system isn't a domain controller, the [!INCLUDE ssDE], and [!INCLUDE ssRSnoversion] are defaulted to use the NT AUTHORITY\NETWORK SERVICE account, and [!INCLUDE ssISnoversion] is defaulted to use the NT AUTHORITY\NETWORK SERVICE account.This role is enabled by default in editions of [!INCLUDE ssExpress]. For all other editions, this role isn't enabled but can be specified through the UI or with command-line parameters. |
For editions of [!INCLUDE ssExpress], installs only those features available in the edition. For other editions, installs all [!INCLUDE ssNoVersion] features. The AllFeatures_WithDefaults parameter can be combined with other parameters that override the AllFeatures_WithDefaults parameter settings. For example, using the AllFeatures_WithDefaults parameter and the /Features=RS parameter overrides the command to install all features and only installs [!INCLUDE ssRSnoversion], but honors the AllFeatures_WithDefaults parameter to use the default service account for [!INCLUDE ssRSnoversion].When using the AllFeatures_WithDefaults parameter along with the /ADDCURRENTUSERASSQLADMIN=FALSE the provisioning dialog isn't auto populated with the current user. Add /AGTSVCACCOUNT and /AGTSVCPASSWORD to specify a service account and password for the [!INCLUDE ssNoVersion] Agent. |
To upgrade a [!INCLUDE ssDEnoversion] failover cluster, you must run the Setup on one failover cluster node at a time, starting with the passive nodes. Setup determines when to fail over to the upgraded node, depending on the total number of nodes in the failover cluster instance, and the number of nodes that have already been upgraded. When half of the nodes or more have already been upgraded, Setup by default causes a failover to an upgraded node.
To control the failover behavior of cluster nodes during the upgrade process, run the upgrade operation from the command prompt and use the /FAILOVERCLUSTERROLLOWNERSHIP parameter to control the failover behavior before the upgrade operation takes the node offline. Use of this parameter is as follows:
-
/FAILOVERCLUSTERROLLOWNERSHIP=0doesn't roll cluster ownership (move group) to upgraded nodes, and doesn't add this node to the list of possible owners of the [!INCLUDE ssNoVersion] cluster at the end of upgrade. -
/FAILOVERCLUSTERROLLOWNERSHIP=1rolls cluster ownership (move group) to upgraded nodes, and adds this node to the list of possible owners of the [!INCLUDE ssNoVersion] cluster at the end of upgrade. -
/FAILOVERCLUSTERROLLOWNERSHIP=2is the default setting. It's used if this parameter isn't specified. This setting indicates that [!INCLUDE ssNoVersion] Setup manages cluster ownership (move group) as needed.
The Instance ID or /InstanceID parameter is used for specifying where you can install the instance components and the registry path of the instance. The value of INSTANCEID is a string and should be unique.
- SQL Instance ID:
MSSQLxx.<INSTANCEID> - AS Instance ID:
MSASxx.<INSTANCEID> - RS Instance ID:
MSRSxx.<INSTANCEID>
The instance-aware components are installed to the following locations:
%Program Files%\Microsoft SQL Server\<SQLInstanceID>%Program Files%\Microsoft SQL Server\<ASInstanceID>%Program Files%\Microsoft SQL Server\<RSInstanceID>
Note
If INSTANCEID isn't specified on the command line, then by default Setup substitutes <INSTANCEID> with the <INSTANCENAME>.