| title | SQL Server installation - Command Prompt parameters | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| description | This article describes command parameters for SQL Server installation. You can specify features to install and configure. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ms.prod | sql | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ms.technology | install | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ms.topic | conceptual | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| helpviewer_keywords |
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ms.assetid | df40c888-691c-4962-a420-78a57852364d | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| author | cawrites | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ms.author | chadam | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ms.reviewer | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ms.custom | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ms.date | 01/07/2020 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| monikerRange | >=sql-server-2016 |
[!INCLUDE SQL Server -Windows Only]
Before you run SQL Server Setup, review Planning a SQL Server Installation.
Installing a new instance of SQL Server at 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 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\SQLServer2019> setup.exe /[Option] /[Option] = {value}
The following example installs the SQL Server database engine, SQL Server Analysis Services, SQL Server Integration Services, and SQL Server tools in quiet mode:
C:\SQLMedia\SQLServer2019> setup.exe /Q /IACCEPTSQLSERVERLICENSETERMS /ACTION="/proxy/https/github.com/MicrosoftDocs/sql-docs/blob/803f1bfe4dac93e8a59dfb58205da9f3be47314e/docs/database-engine/install-windows/install" /PID="AAAAA-BBBBB-CCCCC-DDDDD-EEEEE" /FEATURES=SQL,AS,IS,Tools
/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\SQLServer2019> setup.exe /helpThe rest of the article provides a detailed description of the available parameters.
Note
When installing through the command prompt, [!INCLUDEssNoVersion] supports full quiet mode by using the /Q parameter, or Quiet Simple mode by using the /QS parameter. The /QS switch only shows progress, does not accept any input, and displays no error messages if encountered. The /QS parameter is only supported when /Action=/proxy/https/github.com/MicrosoftDocs/sql-docs/blob/803f1bfe4dac93e8a59dfb58205da9f3be47314e/docs/database-engine/install-windows/install is specified.
Regardless of the installation method, you are 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.
Note
Depending on how you received the software (for example, through Microsoft volume licensing), your use of the software may be subject to additional terms and conditions.
Command prompt installation is supported in the following scenarios:
- Installing, upgrading, or removing an instance and shared components of SQL Server on a local computer by using syntax and parameters specified at the command prompt.
- Installing, upgrading, or removing a failover cluster instance.
- Upgrading from one [!INCLUDEssNoVersion] edition to another edition of [!INCLUDEssNoVersion].
- Installing an instance of [!INCLUDEssNoVersion] 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 [!INCLUDEssNoVersion] 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:
/INDICATEPROGRESS) - /PARAMETER=true/false (Example:
/SQLSVCINSTANTFILEINIT=True) - /PARAMETER=1/0 for Boolean types (Example:
/TCPENABLED=1) - /PARAMETER="value" for all single-value parameters. (Example:
/PID="PID" /SQLSVCSTARTUPTYPE="Automatic")- For a parameter that requires a path:
/INSTANCEDIR=c:\Pathor/INSTANCEDIR="c:\Path"is supported.
- For a parameter that requires a path:
- /PARAMETER="value1" "value2" "value3" for all multiple-value parameters. (Example:
/SQLSYSADMINACCOUNTS="Contoso\John" "Contoso\Mary")- Exception:
/FEATURES, which is a multivalued parameter, but its format is/FEATURES=AS,RS,ISwithout a space, comma-delimited.
- Exception:
Important
When installing [!INCLUDEssNoVersion], if you specify the same directory path for INSTANCEDIR and SQLUSERDBDIR, SQL Server Agent and Full Text Search do not 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 that are listed for a [!INCLUDEssDEnoversion] component are specific to that component. SQL Server Agent and SQL Server Browser parameters are applicable when you install the [!INCLUDEssDEnoversion].
Use the parameters in the following table to develop command-line scripts for installation.
| [!INCLUDEssDEnoversion] component | Parameter | Description |
|---|---|---|
| [!INCLUDEssNoVersion] Setup Control | /ACTION Required |
Required to indicate the installation workflow. Supported values: Install. |
| [!INCLUDEssDEnoversion] Setup Control | /SUPPRESSPRIVACYSTATEMENTNOTICE Required only when the /Q or /QS parameter is specified for unattended installations. |
Suppresses the privacy notice statement. By using this flag, you are agreeing with the privacy notice. |
| [!INCLUDEssDEnoversion] Setup Control | /IACCEPTSQLSERVERLICENSETERMS Required only when the /Q or /QS parameter is specified for unattended installations. |
Required to acknowledge acceptance of the license terms. |
| [!INCLUDEssNoVersion] Python Setup Control | /IACCEPTPYTHONLICENSETERMS Required only 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. |
| [!INCLUDEssNoVersion] R Setup Control | /IACCEPTROPENLICENSETERMS Required only 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. |
| [!INCLUDEssNoVersion] Setup Control | /ENU Optional |
Use this parameter to install the English version of [!INCLUDEssNoVersion] on a localized operating system when the installation media includes language packs for both English and the language corresponding to the operating system. |
| [!INCLUDEssNoVersion] Setup Control | /UpdateEnabled Optional |
Specify whether [!INCLUDEssNoVersion] setup should discover and include product updates. The valid values are True and False or 1 and 0. By default, [!INCLUDEssNoVersion] setup will include updates that are found. |
| [!INCLUDEssNoVersion] Setup Control | /UpdateSource Optional |
Specify the location where [!INCLUDEssNoVersion] setup will obtain product updates. The valid values are "MU" to search [!INCLUDEmsCoName] Update, a valid folder path, a relative path such as .\MyUpdates or a UNC share. By default, [!INCLUDEssNoVersion] setup will search [!INCLUDEmsCoName] Update or a Windows Update Service through the Windows Server Update Services. |
| [!INCLUDEssNoVersion] Setup Control | /CONFIGURATIONFILE Optional |
Specifies the ConfigurationFile to use. |
| [!INCLUDEssNoVersion] Setup Control | /ERRORREPORTING Optional |
Has no effect in [!INCLUDEsssql16-md] and newer. To manage how error feedback is sent to Microsoft, see How to configure SQL Server 2016 and newer to send feedback to Microsoft. In older versions this specifies the error reporting for SQL Server. For more information, see Privacy Statement for the Microsoft Error Reporting Service. Supported values: 0=disabled 1=enabled |
| [!INCLUDEssNoVersion] Setup Control | /FEATURES - Or - /ROLE Required |
Specifies the components to install. Choose /FEATURES to specify individual [!INCLUDEssNoVersion] components to install. For more information, see Feature Parameters below. Choose /ROLE to specify a setup role. Setup roles install [!INCLUDEssNoVersion] in a predetermined configuration. |
| [!INCLUDEssNoVersion] Setup Control | /HELP, ? Optional |
Displays the usage options for installation parameters. |
| [!INCLUDEssNoVersion] Setup Control | /INDICATEPROGRESS Optional |
Specifies that the verbose Setup log file is piped to the console. |
| [!INCLUDEssNoVersion] Setup Control | /INSTALLSHAREDDIR Optional |
Specifies a nondefault installation directory for 64-bit shared components. Default is %Program Files%\Microsoft SQL ServerCannot be set to %Program Files(x86)%\Microsoft SQL Server |
| [!INCLUDEssNoVersion] Setup Control | /INSTALLSHAREDWOWDIR Optional |
Specifies a nondefault installation directory for 32-bit shared components. Supported only on a 64-bit system. Default is %Program Files(x86)%\Microsoft SQL ServerCannot be set to %Program Files%\Microsoft SQL Server |
| [!INCLUDEssNoVersion] Setup Control | /INSTANCEDIR Optional |
Specifies a nondefault installation directory for instance-specific components. |
| [!INCLUDEssNoVersion] Setup Control | /INSTANCEID Optional |
Specifies a nondefault value for an InstanceID. |
| [!INCLUDEssNoVersion] Setup Control | /INSTANCENAME Required |
Specifies a [!INCLUDEssNoVersion] instance name. For more information, see Instance Configuration. |
| PolyBase | /PBENGSVCACCOUNT Optional |
Specifies the account for the engine service. The default is NT Authority\NETWORK SERVICE. |
| PolyBase | /PBDMSSVCPASSWORD Optional |
Specifies the password for the engine service account. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| PolyBase | /PBENGSVCSTARTUPTYPE Optional |
Specifies the startup mode for the PolyBase engine service: Automatic (default), Disabled, and Manual. |
| PolyBase | /PBPORTRANGE Optional |
Specifies a port range with at least 6 ports for PolyBase services. Example:/PBPORTRANGE=16450-16460 |
| PolyBase | /PBSCALEOUT Optional |
Specifies if the [!INCLUDEssDEnoversion] instance will be used as a part of PolyBase Scale-out computational group. Use this option if you are configuring a PolyBase Scale-out computational group including the head node. Supported values: True, False |
| [!INCLUDEssNoVersion] Setup Control | /PID Optional |
Specifies the product key for the edition of SQL Server. If this parameter is not specified, Evaluation is used. |
| [!INCLUDEssNoVersion] Setup Control | /Q or /QUIET Optional |
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. |
| [!INCLUDEssNoVersion] Setup Control | /QS or /QUIETSIMPLE Optional |
Specifies that Setup runs and shows progress through the UI, but does not accept any input or show any error messages. |
| [!INCLUDEssNoVersion] Setup Control | /UIMODE Optional |
Specifies whether to present only the minimum number of dialog boxes during setup. /UIMode can only be used with the /ACTION=/proxy/https/github.com/MicrosoftDocs/sql-docs/blob/803f1bfe4dac93e8a59dfb58205da9f3be47314e/docs/database-engine/install-windows/INSTALL%3C/strong> 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. Note that when combined with other parameters, UIMODE is overridden. For example, when /UIMODE=AutoAdvance and /ADDCURRENTUSERASSQLADMIN=FALSE are both provided, the provisioning dialog box is not auto populated with the current user. The UIMode setting cannot be used with the /Q or /QS parameters. |
| [!INCLUDEssNoVersion] Setup Control | /SQMREPORTING Optional |
Has no effect in [!INCLUDEsssql16-md]. To manage how error feedback is sent to Microsoft, see [How to configure [!INCLUDEsssql16-md] to send feedback to Microsoft](https://support.microsoft.com/kb/3153756). In older versions this specifies feature usage reporting for SQL Server. Supported values: 0=disabled 1=enabled |
| [!INCLUDEssNoVersion] Setup Control | /HIDECONSOLE Optional |
Specifies that the console window is hidden or closed. |
| [!INCLUDEssNoVersion] Agent | /AGTSVCACCOUNT Required |
Specifies the account for the SQL Server Agent service. |
| [!INCLUDEssNoVersion] Agent | /AGTSVCPASSWORD Required |
Specifies the password for SQL Server Agent service account. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| [!INCLUDEssNoVersion] Agent | /AGTSVCSTARTUPTYPE Optional |
Specifies the startup mode for the SQL Server Agent service. Supported values: Automatic Disabled Manual |
| [!INCLUDEssASnoversion] | /ASBACKUPDIR Optional |
Specifies the directory for [!INCLUDEssASnoversion] 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 |
| [!INCLUDEssASnoversion] | /ASCOLLATION Optional |
Specifies the collation setting for [!INCLUDEssASnoversion]. Default value: Latin1_General_CI_AS |
| [!INCLUDEssASnoversion] | /ASCONFIGDIR Optional |
Specifies the directory for [!INCLUDEssASnoversion] 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 |
| [!INCLUDEssASnoversion] | /ASDATADIR Optional |
Specifies the directory for [!INCLUDEssASnoversion] 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 |
| [!INCLUDEssASnoversion] | /ASLOGDIR Optional |
Specifies the directory for [!INCLUDEssASnoversion] 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 |
| [!INCLUDEssASnoversion] | /ASSERVERMODE Optional |
Specifies the server mode of the [!INCLUDEssASnoversion] instance. Valid values are MULTIDIMENSIONAL, POWERPIVOT, or TABULAR. ASSERVERMODE is case-sensitive. All values must be expressed in upper case. For more information about valid values, see Install Analysis Services. |
| [!INCLUDEssASnoversion] | /ASSVCACCOUNT Required |
Specifies the account for the [!INCLUDEssASnoversion] service. |
| [!INCLUDEssASnoversion] | /ASSVCPASSWORD Required |
Specifies the password for the [!INCLUDEssASnoversion] service. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| [!INCLUDEssASnoversion] | /ASSVCSTARTUPTYPE Optional |
Specifies the startup mode for the [!INCLUDEssASnoversion] service. Supported values: Automatic Disabled Manual |
| [!INCLUDEssASnoversion] | /ASSYSADMINACCOUNTS Required |
Specifies the administrator credentials for [!INCLUDEssASnoversion]. |
| [!INCLUDEssASnoversion] | /ASTEMPDIR Optional |
Specifies the directory for [!INCLUDEssASnoversion] 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 |
| [!INCLUDEssASnoversion] | /ASPROVIDERMSOLAP Optional |
Specifies whether the MSOLAP provider can run in-process. Default value: 1=enabled |
| [!INCLUDEssASnoversion] | /FARMACCOUNT Required 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 [!INCLUDEssASnoversion] instances that are installed through /ROLE = SPI_AS_NEWFARM. |
| [!INCLUDEssASnoversion] | /FARMPASSWORD Required 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. |
| [!INCLUDEssASnoversion] | /PASSPHRASE Required 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 [!INCLUDEssASnoversion] instances that are installed through /ROLE = SPI_AS_NEWFARM. |
| [!INCLUDEssASnoversion] | /FARMADMINIPORT Required for SPI_AS_NewFarm |
Specifies a port used to connect to the SharePoint Central Administration web application. This parameter is used only for [!INCLUDEssASnoversion] instances that are installed through /ROLE = SPI_AS_NEWFARM. |
| SQL Server Browser | /BROWSERSVCSTARTUPTYPE Optional |
Specifies the startup mode for SQL Server Browser service. Supported values: Automatic Disabled Manual |
| [!INCLUDEssDEnoversion] | /ENABLERANU Optional |
Enables run-as credentials for [!INCLUDEssExpress] installations. |
| [!INCLUDEssDEnoversion] | /INSTALLSQLDATADIR Optional |
Specifies the data directory for [!INCLUDEssNoVersion] 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\ |
| [!INCLUDEssDEnoversion] | /SAPWD Required when /SECURITYMODE=SQL |
Specifies the password for the [!INCLUDEssNoVersion] SA account. |
| [!INCLUDEssDEnoversion] | /SECURITYMODE Optional |
Specifies the security mode for [!INCLUDEssNoVersion]. If this parameter is not supplied, then Windows-only authentication mode is supported. Supported value: SQL |
| [!INCLUDEssDEnoversion] | /SQLBACKUPDIR Optional |
Specifies the directory for backup files. Default value: <InstallSQLDataDir>\<SQLInstanceID>\MSSQL\Backup |
| [!INCLUDEssDEnoversion] | /SQLCOLLATION Optional |
Specifies the collation settings for [!INCLUDEssNoVersion]. 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 backwards compatibility reasons. Therefore, this is not always the recommended collation. To take full advantage of [!INCLUDEssNoVersion] 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 Collations and Unicode support. |
| [!INCLUDEssDEnoversion] | /ADDCURRENTUSERASSQLADMIN Optional |
Adds the current user to the [!INCLUDEssNoVersion] 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 below. Use of /ADDCURRENTUSERASSQLADMIN is optional, but either /ADDCURRENTUSERASSQLADMIN or /SQLSYSADMINACCOUNTS is required. Default values: True for editions of [!INCLUDEssExpress] False for all other editions |
| [!INCLUDEssDEnoversion] | /SQLSVCACCOUNT Required |
Specifies the startup account for the [!INCLUDEssNoVersion] service. |
| [!INCLUDEssDEnoversion] | /SQLSVCPASSWORD Required |
Specifies the password for SQLSVCACCOUNT. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| [!INCLUDEssDEnoversion] | /SQLSVCSTARTUPTYPE Optional |
Specifies the startup mode for the [!INCLUDEssNoVersion] service. Supported values: Automatic Disabled Manual |
| [!INCLUDEssDEnoversion] | /SQLSYSADMINACCOUNTS Required |
Use this parameter to provision logins to be members of the sysadmin role. For [!INCLUDEssNoVersion] editions other than [!INCLUDEssExpress], /SQLSYSADMINACCOUNTS is required. For editions of [!INCLUDEssExpress], use of /SQLSYSADMINACCOUNTS is optional, but either /SQLSYSADMINACCOUNTS or /ADDCURRENTUSERASSQLADMIN is required. |
| [!INCLUDEssDEnoversion] | /SQLTEMPDBDIR Optional |
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 will be 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. |
| [!INCLUDEssDEnoversion] | /SQLTEMPDBLOGDIR Optional |
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. |
| [!INCLUDEssDEnoversion] | /SQLTEMPDBFILECOUNT Optional |
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 [!INCLUDEssExpress] 8 or the number of cores, whichever is lower for all other editions Important The primary database file for tempdb will still be 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 SQL Server deletes the files with naming convention tempdb_mssql_#.ndf. Do not use tempdb_mssql_*.ndf naming convention for user database files. |
| [!INCLUDEssDEnoversion] | /SQLTEMPDBFILESIZE Optional |
Introduced in [!INCLUDEsssql16-md]. Specifies the initial size of each tempdb data file. Default = 4 MB for [!INCLUDEssExpress], 8 MB for all other editions. Min = (4 MB or 8 MB). Max = 1024 MB (262,144 MB for [!INCLUDEssSQL14] |
| [!INCLUDEssDEnoversion] | /SQLTEMPDBFILEGROWTH Optional |
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 |
| [!INCLUDEssDEnoversion] | /SQLTEMPDBLOGFILESIZE Optional |
Introduced in [!INCLUDEsssql16-md]. Specifies the initial size of each tempdb log file. Default = 4 MB for [!INCLUDEssExpress], 8 MB for all other editions. Min = (4 MB or 8 MB). Max = 1024 MB (262,144 MB for [!INCLUDEssSQL14] |
| [!INCLUDEssDEnoversion] | /SQLTEMPDBLOGFILEGROWTH Optional |
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 |
| [!INCLUDEssDEnoversion] | /SQLUSERDBDIR Optional |
Specifies the directory for the data files for user databases. Default value: <InstallSQLDataDir>\<SQLInstanceID>\MSSQL\Data |
| [!INCLUDEssDEnoversion] | /SQLSVCINSTANTFILEINIT Optional |
Enables instant file initialization for [!INCLUDEssNoVersion] service account. For security and performance considerations, see Database Instant File Initialization. Default value: "False" Optional value: "True" |
| [!INCLUDEssDEnoversion] | /SQLUSERDBLOGDIR Optional |
Specifies the directory for the log files for user databases. Default value: <InstallSQLDataDir>\<SQLInstanceID>\MSSQL\Data |
| [!INCLUDEssDEnoversion] | /SQLMAXDOP=parameter Optional If omitted on unattended (silent) installs, MAXDOP will align 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. Only available starting with [!INCLUDEsql-server-2019]. Default value will align with the max degree of parallelism guidelines |
| [!INCLUDEssDEnoversion] | /USESQLRECOMMENDEDMEMORYLIMITS Optional If /USESQLRECOMMENDEDMEMORYLIMITS, /SQLMINMEMORY, and /SQLMAXMEMORY are omitted on unattended (silent) installs, the [!INCLUDEssDEnoversion] will use the default [!INCLUDEssNoVersion] memory configuration. |
Specifies that the [!INCLUDEssDEnoversion] will use calculated recommended values that align with the server memory configuration guidelines for a standalone [!INCLUDEssNoVersion] instance. Only available starting with [!INCLUDEsql-server-2019]. Note: This parameter cannot be used with /SQLMINMEMORY and /SQLMAXMEMORY. |
| [!INCLUDEssDEnoversion] | /SQLMINMEMORY Optional If /USESQLRECOMMENDEDMEMORYLIMITS, /SQLMINMEMORY, and /SQLMAXMEMORY are omitted on unattended (silent) installs, the [!INCLUDEssDEnoversion] will use the default [!INCLUDEssNoVersion] memory configuration. |
Specifies the Min Server Memory configuration in MB. Only available starting with [!INCLUDEsql-server-2019]. Default value: 0. Note: This parameter cannot be used with /USESQLRECOMMENDEDMEMORYLIMITS. |
| [!INCLUDEssDEnoversion] | /SQLMAXMEMORY Optional If /USESQLRECOMMENDEDMEMORYLIMITS, /SQLMINMEMORY, and /SQLMAXMEMORY are omitted on unattended (silent) installs, the [!INCLUDEssDEnoversion] will use the default [!INCLUDEssNoVersion] memory configuration. |
Specifies the Max Server Memory configuration in MB. Only available starting with [!INCLUDEsql-server-2019]. Default value: calculated recommended value that aligns with the server memory configuration guidelines for a standalone [!INCLUDEssNoVersion] instance. Note: This parameter cannot be used with /USESQLRECOMMENDEDMEMORYLIMITS. |
| FILESTREAM | /FILESTREAMLEVEL Optional |
Specifies the access level for the FILESTREAM feature. Supported values: 0 =Disable FILESTREAM support for this instance. (Default value) 1=Enable FILESTREAM for [!INCLUDEtsql] access. 2=Enable FILESTREAM for [!INCLUDEtsql] and file I/O streaming access. (Not valid for cluster scenarios) 3=Allow remote clients to have streaming access to FILESTREAM data. |
| FILESTREAM | /FILESTREAMSHARENAME Optional Required when FILESTREAMLEVEL is greater than 1. |
Specifies the name of the windows share in which the FILESTREAM data will be stored. |
| SQL Server Full Text | /FTSVCACCOUNT Optional |
Specifies the account for Full-Text filter launcher service. This parameter is ignored in [!INCLUDEfirstref_longhorn] or higher. ServiceSID is used to help secure the communication between SQL Server and Full-text Filter Daemon. If the values are not provided, the Full-text Filter Launcher Service is disabled. You have to use SQL Server Control Manager to change the service account and enable full-text functionality. Default value: Local Service Account |
| SQL Server Full Text | /FTSVCPASSWORD Optional |
Specifies the password for the Full-Text filter launcher service. This parameter is ignored in [!INCLUDEfirstref_longhorn] or higher. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| [!INCLUDEssISnoversion] | /ISSVCACCOUNT Required |
Specifies the account for [!INCLUDEssISnoversion]. Default value: NT AUTHORITY\NETWORK SERVICE |
| [!INCLUDEssISnoversion] | /ISSVCPASSWORD Required |
Specifies the [!INCLUDEssISnoversion] password. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| [!INCLUDEssISnoversion] | /ISSVCStartupType Optional |
Specifies the startup mode for the [!INCLUDEssISnoversion] service. |
| SQL Server Network Configuration | /NPENABLED Optional |
Specifies the state of the Named Pipes protocol for the SQL Server service. Supported values: 0=disable the Named Pipes protocol 1=enable the Named Pipes protocol |
| SQL Server Network Configuration | /TCPENABLED Optional |
Specifies the state of the TCP protocol for the SQL Server service. Supported values: 0=disable the TCP protocol 1=enable the TCP protocol |
| [!INCLUDEssRSnoversion] | /RSINSTALLMODE Optional |
No longer applicable starting with SQL Server 2017. Specifies the Install mode for [!INCLUDEssRSnoversion]. Supported Values: SharePointFilesOnlyMode DefaultNativeMode FilesOnlyMode Note: If the installation includes the SQL Server[!INCLUDEssDE], the default RSINSTALLMODE is DefaultNativeMode. If the installation does not include the SQL Server[!INCLUDEssDE], the default RSINSTALLMODE is FilesOnlyMode. If you choose DefaultNativeMode but the installation does not include the SQL Server[!INCLUDEssDE], the installation will automatically change the RSINSTALLMODE to FilesOnlyMode. |
| [!INCLUDEssRSnoversion] | /RSSVCACCOUNT Required |
No longer applicable starting with SQL Server 2017. Specifies the startup account for [!INCLUDEssRSnoversion]. |
| [!INCLUDEssRSnoversion] | /RSSVCPASSWORD Required |
No longer applicable starting with SQL Server 2017. Specifies the password for the startup account for the [!INCLUDEssRSnoversion] service. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| [!INCLUDEssRSnoversion] | /RSSVCStartupType Optional |
No longer applicable starting with SQL Server 2017. Specifies the startup mode for [!INCLUDEssRSnoversion]. Supported values: Automatic Disabled Manual |
| Python/Machine Learning Services (In-Database) | /MPYCACHEDIRECTORY | Reserved for future use. Use %TEMP% to store Python .CAB files for installation on a computer that does not have an internet connection. |
| R/Machine Learning Services (In-Database) | /MRCACHEDIRECTORY | Use this parameter to specify the Cache directory for Microsoft R Open, SQL Server 2016 R Services, SQL Server 2016 R Server (Standalone), or R feature support in SQL Server Machine Learning Services or Machine Learning Server (Standalone). This setting is typically used when installing R components from the command line on a computer without Internet access. |
| Java/Language Extensions | /SQL_INST_JAVA, /SQLJAVADIR = "path" Optional |
Starting with SQL Server 2019, 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. |
To install a new, stand-alone instance with the [!INCLUDEssDEnoversion], Replication, and Full-Text Search components and enable instant file initialization for [!INCLUDEssDEnoversion].
setup.exe /q /ACTION=/proxy/https/github.com/MicrosoftDocs/sql-docs/blob/803f1bfe4dac93e8a59dfb58205da9f3be47314e/docs/database-engine/install-windows/Install /FEATURES=SQL /INSTANCENAME=MSSQLSERVER /SQLSVCACCOUNT="<DomainName\UserName>" /SQLSVCPASSWORD="<StrongPassword>" /SQLSYSADMINACCOUNTS="<DomainName\UserName>" /AGTSVCACCOUNT="NT AUTHORITY\Network Service" /SQLSVCINSTANTFILEINIT="True" /IACCEPTSQLSERVERLICENSETERMS
For more information about [!INCLUDEssNoVersion] SysPrep, see
[Install [!INCLUDEsssql16-md] Using SysPrep](../../database-engine/install-windows/install-sql-server-using-sysprep.md).
Use the parameters in the following table to develop command-line scripts for preparing an instance of SQL Server without configuring it.
| [!INCLUDEssDEnoversion] component | Parameter | Description |
|---|---|---|
| [!INCLUDEssNoVersion] Setup Control | /ACTION Required |
Required to indicate the installation workflow. Supported values: PrepareImage |
| [!INCLUDEssNoVersion] Setup Control | /IACCEPTSQLSERVERLICENSETERMS Required only when the /Q or /QS parameter is specified for unattended installations. |
Required to acknowledge acceptance of the license terms. |
| [!INCLUDEssNoVersion] Setup Control | /ENU Optional |
Use this parameter to install the English version of SQL Server on a localized operating system when the installation media includes language packs for both English and the language corresponding to the operating system. |
| [!INCLUDEssNoVersion] Setup Control | /UpdateEnabled Optional |
Specify whether [!INCLUDEssNoVersion] setup should discover and include product updates. The valid values are True and False or 1 and 0. By default, SQL Server setup will include updates that are found. |
| [!INCLUDEssNoVersion] Setup Control | /UpdateSource Optional |
Specify the location where [!INCLUDEssNoVersion] setup will obtain product updates. The valid values are "MU" to search [!INCLUDEmsCoName] Update, a valid folder path, a relative path such as .\MyUpdates or a UNC share. By default, [!INCLUDEssNoVersion] setup will search [!INCLUDEmsCoName] Update or a Windows Update Service through the Windows Server Update Services. |
| [!INCLUDEssNoVersion] Setup Control | /CONFIGURATIONFILE Optional |
Specifies the ConfigurationFile to use. |
| [!INCLUDEssNoVersion] Setup Control | /FEATURES Required |
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 |
| [!INCLUDEssNoVersion] Setup Control | /HELP, ? Optional |
Displays the usage options for installation parameters. |
| [!INCLUDEssNoVersion] Setup Control | /HIDECONSOLE Optional |
Specifies that the console window is hidden or closed. |
| [!INCLUDEssNoVersion] Setup Control | /INDICATEPROGRESS Optional |
Specifies that the verbose Setup log file is piped to the console. |
| [!INCLUDEssNoVersion] Setup Control | /INSTALLSHAREDDIR Optional |
Specifies a nondefault installation directory for 64-bit shared components. Default is %Program Files%\Microsoft SQL ServerCannot be set to %Program Files(x86)%\Microsoft SQL Server |
| [!INCLUDEssNoVersion] Setup Control | /INSTANCEDIR Optional |
Specifies a nondefault installation directory for instance-specific components. |
| [!INCLUDEssNoVersion] Setup Control | /INSTANCEID Prior to [!INCLUDEssSQL11] SP1 CU2 (January 2013) Required Beginning with [!INCLUDEssSQL11] SP1 CU2 Required for instance features. |
Specifies an InstanceID for the instance that is being prepared. |
| PolyBase | /PBENGSVCACCOUNT Optional |
Specifies the account for the engine service. The default is NT Authority\NETWORK SERVICE. |
| PolyBase | /PBDMSSVCPASSWORD Optional |
Specifies the password for the engine service account. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| PolyBase | /PBENGSVCSTARTUPTYPE Optional |
Specifies the startup mode for the PolyBase engine service: Automatic (default), Disabled, and Manual. |
| PolyBase | /PBPORTRANGE Optional |
Specifies a port range with at least 6 ports for PolyBase services. Example:/PBPORTRANGE=16450-16460 |
| PolyBase | /PBSCALEOUT Optional |
Specifies if the [!INCLUDEssDEnoversion] instance will be used as a part of PolyBase Scale-out computational group. Supported values: True, False |
| [!INCLUDEssNoVersion] Setup Control | /Q or /QUIET Optional |
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. |
| [!INCLUDEssNoVersion] Setup Control | /QS or /QUIETSIMPLE Optional |
Specifies that Setup runs and shows progress through the UI, but does not accept any input or show any error messages. |
To prepare a new, stand-alone instance with the [!INCLUDEssDEnoversion], Replication, and Full-Text Search components, and [!INCLUDEssRSnoversion].
setup.exe /q /ACTION=/proxy/https/github.com/MicrosoftDocs/sql-docs/blob/803f1bfe4dac93e8a59dfb58205da9f3be47314e/docs/database-engine/install-windows/PrepareImage /FEATURES=SQL,RS /InstanceID =<MYINST> /IACCEPTSQLSERVERLICENSETERMS
Use the parameters in the following table to develop command-line scripts for completing and configuring a prepared instance of SQL Server.
| [!INCLUDEssNoVersion] component | Parameter | Description |
|---|---|---|
| [!INCLUDEssNoVersion] Setup Control | /ACTION Required |
Required to indicate the installation workflow. Supported values: CompleteImage |
| [!INCLUDEssNoVersion] Setup Control | /IACCEPTSQLSERVERLICENSETERMS Required only when the /Q or /QS parameter is specified for unattended installations. |
Required to acknowledge acceptance of the license terms. |
| [!INCLUDEssNoVersion] Setup Control | /ENU Optional |
Use this parameter to install the English version of SQL Server on a localized operating system when the installation media includes language packs for both English and the language corresponding to the operating system. |
| [!INCLUDEssNoVersion] Setup Control | /CONFIGURATIONFILE Optional |
Specifies the ConfigurationFile to use. |
| [!INCLUDEssNoVersion] Setup Control | /ERRORREPORTING Optional |
Has no effect in [!INCLUDEsssql16-md]. To manage how error feedback is sent to Microsoft, see [How to configure [!INCLUDEsssql16-md] to send feedback to Microsoft](https://support.microsoft.com/kb/3153756). In older versions this specifies the error reporting for SQL Server. For more information, see Privacy Statement for the Microsoft Error Reporting Service. Supported values: 1=enabled 0=disabled |
| [!INCLUDEssNoVersion] Setup Control | /HELP, ? Optional |
Displays the usage options for installation parameters. |
| [!INCLUDEssNoVersion] Setup Control | /INDICATEPROGRESS Optional |
Specifies that the verbose Setup log file is piped to the console. |
| [!INCLUDEssNoVersion] Setup Control | /INSTANCEID Prior to [!INCLUDEssSQL11] SP1 CU2 (January 2013) Required Beginning with [!INCLUDEssSQL11] SP1 CU2 Optional |
Use the Instance ID specified during the prepare image step. Supported Values: InstanceID of a Prepared Instance. |
| [!INCLUDEssNoVersion] Setup Control | /INSTANCENAME Prior to [!INCLUDEssSQL11] SP1 CU2 (January 2013) Required Beginning with [!INCLUDEssSQL11] SP1 CU2 Optional |
Specifies a [!INCLUDEssNoVersion] instance name for the instance that is being completed. For more information, see Instance Configuration. |
| PolyBase | /PBENGSVCACCOUNT Optional |
Specifies the account for the engine service. The default is NT Authority\NETWORK SERVICE. |
| PolyBase | /PBDMSSVCPASSWORD Optional |
Specifies the password for the engine service account. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| PolyBase | /PBENGSVCSTARTUPTYPE Optional |
Specifies the startup mode for the PolyBase engine service: Automatic (default) , Disabled, and Manual. |
| PolyBase | /PBPORTRANGE Optional |
Specifies a port range with at least 6 ports for PolyBase services. Example:/PBPORTRANGE=16450-16460 |
| PolyBase | /PBSCALEOUT Optional |
Specifies if the [!INCLUDEssDEnoversion] instance will be used as a part of PolyBase Scale-out computational group. Supported values: True, False |
| [!INCLUDEssNoVersion] Setup Control | /PID Optional |
Specifies the product key for the edition of [!INCLUDEssNoVersion]. If this parameter is not specified, Evaluation is used. Note: If you are installing [!INCLUDEssExpress], [!INCLUDEssExpress] with tools, or [!INCLUDEssExpress] with Advanced Services, the PID is predefined. |
| [!INCLUDEssNoVersion] Setup Control | /Q or /QUIET Optional |
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. |
| [!INCLUDEssDEnoversion] Setup Control | /QS or /QUIETSIMPLE Optional |
Specifies that Setup runs and shows progress through the UI, but does not accept any input or show any error messages. |
| [!INCLUDEssNoVersion] Setup Control | /SQMREPORTING Optional |
Has no effect in [!INCLUDEsssql16-md]. To manage how error feedback is sent to Microsoft, see [How to configure [!INCLUDEsssql16-md] to send feedback to Microsoft](https://support.microsoft.com/kb/3153756). In older versions this specifies feature usage reporting for SQL Server. Supported values: 0=disabled 1=enabled |
| [!INCLUDEssNoVersion] Setup Control | /HIDECONSOLE Optional |
Specifies that the console window is hidden or closed. |
| SQL Server Agent | /AGTSVCACCOUNT Required |
Specifies the account for the SQL Server Agent service. |
| SQL Server Agent | /AGTSVCPASSWORD Required |
Specifies the password for SQL Server Agent service account. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| SQL Server Agent | /AGTSVCSTARTUPTYPE Optional |
Specifies the startup mode for the SQL Server Agent service. Supported values: Automatic Disabled Manual |
| SQL Server Browser | /BROWSERSVCSTARTUPTYPE Optional |
Specifies the startup mode for SQL Server Browser service. Supported values: Automatic Disabled Manual |
| [!INCLUDEssDEnoversion] | /ENABLERANU Optional |
Enables run-as credentials for [!INCLUDEssExpress] installations. |
| [!INCLUDEssDEnoversion] | /INSTALLSQLDATADIR Optional |
Specifies the data directory for [!INCLUDEssNoVersion] 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\ |
| [!INCLUDEssDEnoversion] | /SAPWD Required when /SECURITYMODE=SQL |
Specifies the password for the [!INCLUDEssNoVersion] SA account. |
| [!INCLUDEssDEnoversion] | /SECURITYMODE Optional |
Specifies the security mode for [!INCLUDEssNoVersion]. If this parameter is not supplied, then Windows-only authentication mode is supported. Supported value: SQL |
| [!INCLUDEssDEnoversion] | /SQLBACKUPDIR Optional |
Specifies the directory for backup files. Default value: <InstallSQLDataDir>\<SQLInstanceID>\MSSQL\Backup |
| [!INCLUDEssDEnoversion] | /SQLCOLLATION Optional |
Specifies the collation settings for [!INCLUDEssNoVersion]. The default value is based on the locale of your Windows operating system. For more information, see Collation Settings in Setup. |
| [!INCLUDEssDEnoversion] | /SQLSVCACCOUNT Required |
Specifies the startup account for the [!INCLUDEssNoVersion] service. |
| [!INCLUDEssDEnoversion] | /SQLSVCPASSWORD Required |
Specifies the password for SQLSVCACCOUNT. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| [!INCLUDEssDEnoversion] | /SQLSVCSTARTUPTYPE Optional |
Specifies the startup mode for the [!INCLUDEssNoVersion] service. Supported values: Automatic Disabled Manual |
| [!INCLUDEssDEnoversion] | /SQLSYSADMINACCOUNTS Required |
Use this parameter to provision logins to be members of the sysadmin role. |
| [!INCLUDEssDEnoversion] | /SQLTEMPDBDIR Optional |
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 will be 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. |
| [!INCLUDEssDEnoversion] | /SQLTEMPDBLOGDIR Optional |
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. |
| [!INCLUDEssDEnoversion] | /SQLTEMPDBFILESIZE Optional |
Introduced in [!INCLUDEsssql16-md]. Specifies the initial size of each tempdb data file. Default = 4 MB for [!INCLUDEssExpress], 8 MB for all other editions. Min = (4 MB or 8 MB). Max = 1024 MB (262,144 MB for [!INCLUDEssSQL14]. |
| [!INCLUDEssDEnoversion] | /SQLTEMPDBFILEGROWTH Optional |
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 |
| [!INCLUDEssDEnoversion] | /SQLTEMPDBLOGFILESIZE Optional |
Specifies the initial size of the tempdb log file in MB. Setup allows the size up to 1024. Default value: 4 for [!INCLUDEssExpress] 8 for all other editions Allowed range: Min = default value (4 or 8), Max = 1024 |
| [!INCLUDEssDEnoversion] | /SQLTEMPDBLOGFILEGROWTH Optional |
Introduced in [!INCLUDEsssql16-md]. Specifies the initial size of each tempdb log file. Default = 4 MB for [!INCLUDEssExpress], 8 MB for all other editions. Min = (4 MB or 8 MB). Max = 1024 MB (262,144 MB for [!INCLUDEssSQL14] |
| [!INCLUDEssDEnoversion] | /SQLTEMPDBFILECOUNT Optional |
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 [!INCLUDEssExpress] 8 or the number of cores, whichever is lower for all other editions Important: The primary database file for tempdb will still be 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 SQL Server deletes the files with naming convention tempdb_mssql_#.ndf. Do not use tempdb_mssql_*.ndf naming convention for user database files. Warning: [!INCLUDEssExpress] is not supported for configuring this parameter. Setup installs only 1 tempdb data file. |
| [!INCLUDEssDEnoversion] | /SQLUSERDBDIR Optional |
Specifies the directory for the data files for user databases. Default value: <InstallSQLDataDir>\<SQLInstanceID>\MSSQL\Data |
| [!INCLUDEssDEnoversion] | /SQLUSERDBLOGDIR Optional |
Specifies the directory for the log files for user databases. Default value: <InstallSQLDataDir>\<SQLInstanceID>\MSSQL\Data |
| FILESTREAM | /FILESTREAMLEVEL Optional |
Specifies the access level for the FILESTREAM feature. Supported values: 0 =Disable FILESTREAM support for this instance. (Default value) 1=Enable FILESTREAM for [!INCLUDEtsql] access. 2=Enable FILESTREAM for [!INCLUDEtsql] and file I/O streaming access. (Not valid for cluster scenarios) 3=Allow remote clients to have streaming access to FILESTREAM data. |
| FILESTREAM | /FILESTREAMSHARENAME Optional Required when FILESTREAMLEVEL is greater than 1. |
Specifies the name of the windows share in which the FILESTREAM data will be stored. |
| SQL Server Full Text | /FTSVCACCOUNT Optional |
Specifies the account for Full-Text filter launcher service. This parameter is ignored in [!INCLUDEfirstref_longhorn] or higher. ServiceSID is used to help secure the communication between SQL Server and Full-text Filter Daemon. If the values are not provided, the Full-text Filter Launcher Service is disabled. You have to use SQL Server Control Manager to change the service account and enable full-text functionality. Default value: Local Service Account |
| SQL Server Full Text | /FTSVCPASSWORD Optional |
Specifies the password for the Full-Text filter launcher service. This parameter is ignored in [!INCLUDEfirstref_longhorn] or higher. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| SQL Server Network Configuration | /NPENABLED Optional |
Specifies the state of the Named Pipes protocol for the SQL Server service. Supported values: 0=disable the Named Pipes protocol 1=enable the Named Pipes protocol |
| SQL Server Network Configuration | /TCPENABLED Optional |
Specifies the state of the TCP protocol for the SQL Server service. Supported values: 0=disable the TCP protocol 1=enable the TCP protocol |
| [!INCLUDEssRSnoversion] | /RSINSTALLMODE Optional |
No longer applicable starting with SQL Server 2017. Specifies the Install mode for [!INCLUDEssRSnoversion]. |
| [!INCLUDEssRSnoversion] | /RSSVCACCOUNT Required |
No longer applicable starting with SQL Server 2017. Specifies the startup account for [!INCLUDEssRSnoversion]. |
| [!INCLUDEssRSnoversion] | /RSSVCPASSWORD Required |
No longer applicable starting with SQL Server 2017. Specifies the password for the startup account for the [!INCLUDEssRSnoversion] service. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| [!INCLUDEssRSnoversion] | /RSSVCStartupType Optional |
No longer applicable starting with SQL Server 2017. Specifies the startup mode for [!INCLUDEssRSnoversion]. Supported values: Automatic Disabled Manual |
To complete a prepared, stand-alone instance that includes [!INCLUDEssDEnoversion], Replication, and Full-Text Search components.
setup.exe /q /ACTION=/proxy/https/github.com/MicrosoftDocs/sql-docs/blob/803f1bfe4dac93e8a59dfb58205da9f3be47314e/docs/database-engine/install-windows/CompleteImage /INSTANCENAME=MYNEWINST /INSTANCEID=<MYINST> /SQLSVCACCOUNT="<DomainName\UserName>" /SQLSVCPASSWORD="<StrongPassword>" /SQLSYSADMINACCOUNTS="<DomainName\UserName>" /AGTSVCACCOUNT="NT AUTHORITY\Network Service" /IACCEPTSQLSERVERLICENSETERMS
Use the parameters in the following table to develop command-line scripts for upgrade.
| [!INCLUDEssDEnoversion] component | Parameter | Description |
|---|---|---|
| [!INCLUDEssDEnoversion] Setup Control | /ACTION Required |
Required to indicate the installation workflow. Supported values: Upgrade EditionUpgrade The value EditionUpgrade is used to upgrade an existing edition of [!INCLUDEssnoversion] to a different edition. For more information about the supported version and edition upgrades, see Supported Version and Edition Upgrades. |
| [!INCLUDEssDEnoversion] Setup Control | /IACCEPTSQLSERVERLICENSETERMS Required only when the /Q or /QS parameter is specified for unattended installations. |
Required to acknowledge acceptance of the license terms. |
| [!INCLUDEssDEnoversion] Setup Control | /ENU Optional |
Use this parameter to install the English version of SQL Server on a localized operating system when the installation media includes language packs for both English and the language corresponding to the operating system. |
| [!INCLUDEssDEnoversion] Setup Control | /UpdateEnabled Optional |
Specify whether SQL Server setup should discover and include product updates. The valid values are True and False or 1 and 0. By default, SQL Server setup will include updates that are found. |
| [!INCLUDEssDEnoversion] Setup Control | /UpdateSource Optional |
Specify the location where SQL Server setup will obtain product updates. The valid values are "MU" to search [!INCLUDEmsCoName] Update, a valid folder path, a relative path such as .\MyUpdates or a UNC share. By default, SQL Server setup will search [!INCLUDEmsCoName] Update or a Windows Update Service through the Windows Server Update Services. |
| [!INCLUDEssDEnoversion] Setup Control | /CONFIGURATIONFILE Optional |
Specifies the ConfigurationFile to use. |
| [!INCLUDEssDEnoversion] Setup Control | /ERRORREPORTING Optional |
Has no effect in [!INCLUDEsssql16-md]. To manage how error feedback is sent to Microsoft, see [How to configure [!INCLUDEsssql16-md] to send feedback to Microsoft](https://support.microsoft.com/kb/3153756). In older versions this specifies the error reporting for SQL Server. For more information, see Privacy Statement for the Microsoft Error Reporting Service. Supported values: 1=enabled 0=disabled |
| [!INCLUDEssDEnoversion] Setup Control | /HELP, ? Optional |
Displays the usage options for the parameters. |
| [!INCLUDEssDEnoversion] Setup Control | /INDICATEPROGRESS Optional |
Specifies that the verbose Setup log file will be piped to the console. |
| [!INCLUDEssDEnoversion] Setup Control | / INSTANCEDIR Optional |
Specifies a nondefault installation directory for shared components. |
| [!INCLUDEssDEnoversion] Setup Control | /INSTANCEID Required when you upgrade from [!INCLUDEssKatmai] or later. Optional when you upgrade from [!INCLUDEssVersion2005] |
Specifies a nondefault value for an InstanceID. |
| [!INCLUDEssDEnoversion] Setup Control | /INSTANCENAME Required |
Specifies a [!INCLUDEssDEnoversion] instance name. For more information, see Instance Configuration. |
| [!INCLUDEssDEnoversion] Setup Control | /PID Optional |
Specifies the product key for the edition of SQL Server. If this parameter is not specified, Evaluation is used. |
| [!INCLUDEssDEnoversion] Setup Control | /Q Optional |
Specifies that Setup runs in a quiet mode without any user interface. This is used for unattended installations. |
| [!INCLUDEssDEnoversion] Setup Control | /UIMODE Optional |
Specifies whether to present only the minimum number of dialog boxes during setup. /UIMode can only be used with the /ACTION=/proxy/https/github.com/MicrosoftDocs/sql-docs/blob/803f1bfe4dac93e8a59dfb58205da9f3be47314e/docs/database-engine/install-windows/INSTALL%3C/strong> 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. Note that the UIMode setting cannot be used with the /Q or /QS parameters. |
| [!INCLUDEssDEnoversion] Setup Control | /SQMREPORTING Optional |
Has no effect in [!INCLUDEsssql16-md]. To manage how error feedback is sent to Microsoft, see [How to configure [!INCLUDEsssql16-md] to send feedback to Microsoft](https://support.microsoft.com/kb/3153756). In older versions this specifies feature usage reporting for SQL Server. Supported values: 1=enabled 0=disabled |
| [!INCLUDEssDEnoversion] Setup Control | /HIDECONSOLE Optional |
Specifies the console window would be hidden or closed. |
| SQL Server Browser Service | /BROWSERSVCSTARTUPTYPE Optional |
Specifies the startup mode for SQL Server Browser service. Supported values: Automatic Disabled Manual |
| SQL Server Full-Text | /FTUPGRADEOPTION Optional |
Specifies the Full-Text catalog upgrade option. Supported values: REBUILD RESET IMPORT |
| [!INCLUDEssISnoversion] | /ISSVCACCOUNT Required |
Specifies the account for [!INCLUDEssISnoversion]. Default value: NT AUTHORITY\NETWORK SERVICE |
| [!INCLUDEssISnoversion] | /ISSVCPASSWORD Required |
Specifies the [!INCLUDEssISnoversion] password. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| [!INCLUDEssISnoversion] | /ISSVCStartupType Optional |
Specifies the startup mode for the [!INCLUDEssISnoversion] service. |
| [!INCLUDEssRSnoversion] | /RSUPGRADEDATABASEACCOUNT Optional |
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 [!INCLUDEssSQL11] [!INCLUDEssRSnoversion]. If this option is not 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. |
| [!INCLUDEssRSnoversion] | /RSUPGRADEPASSWORD Optional |
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. |
| [!INCLUDEssRSnoversion] | /ALLOWUPGRADEFORSSRSSHAREPOINTMODE | The switch is required when upgrading a SharePoint Mode installation that is based on the SharePoint shared service architecture. The switch is not needed for upgrading non-shared service versions of [!INCLUDEssRSnoversion]. |
To upgrade an existing instance or failover cluster node from a previous [!INCLUDEssDEnoversion] version,
setup.exe /q /ACTION=/proxy/https/github.com/MicrosoftDocs/sql-docs/blob/803f1bfe4dac93e8a59dfb58205da9f3be47314e/docs/database-engine/install-windows/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" /IACCEPTSQLSERVERLICENSETERMS
Use the parameters in the following table to develop command-line scripts for repair.
| [!INCLUDEssDEnoversion] component | Parameter | Description |
|---|---|---|
| [!INCLUDEssDEnoversion] Setup Control | /ACTION Required |
Required to indicate the repair workflow. Supported values: Repair |
| [!INCLUDEssDEnoversion] Setup Control | /ENU Optional |
Use this parameter to install the English version of [!INCLUDEssDEnoversion] on a localized operating system when the installation media includes language packs for both English and the language corresponding to the operating system. |
| [!INCLUDEssDEnoversion] Setup Control | /FEATURES Required |
Specifies components to repair. |
| [!INCLUDEssDEnoversion] Setup Control | /INSTANCENAME Required |
Specifies a [!INCLUDEssDEnoversion] instance name. For more information, see Instance Configuration. |
| PolyBase | /PBENGSVCACCOUNT Optional |
Specifies the account for the engine service. The default is NT Authority\NETWORK SERVICE. |
| PolyBase | /PBDMSSVCPASSWORD Optional |
Specifies the password for the engine service account. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| PolyBase | /PBENGSVCSTARTUPTYPE Optional |
Specifies the startup mode for the PolyBase engine service: Automatic (default) , Disabled, and Manual. |
| PolyBase | /PBPORTRANGE Optional |
Specifies a port range with at least 6 ports for PolyBase services. Example:/PBPORTRANGE=16450-16460 |
| PolyBase | /PBSCALEOUT Optional |
Specifies if the [!INCLUDEssDEnoversion] instance will be used as a part of PolyBase Scale-out computational group. Supported values: True, False |
| [!INCLUDEssDEnoversion] Setup Control | /Q or /QUIET Optional |
Specifies that Setup runs in a quiet mode without any user interface. This is used for unattended installations. |
| [!INCLUDEssDEnoversion] Setup Control | /HIDECONSOLE Optional |
Specifies that the console window is hidden or closed. |
Repair an instance and shared components.
setup.exe /q /ACTION=/proxy/https/github.com/MicrosoftDocs/sql-docs/blob/803f1bfe4dac93e8a59dfb58205da9f3be47314e/docs/database-engine/install-windows/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.
| [!INCLUDEssDEnoversion] component | Parameter | Description |
|---|---|---|
| [!INCLUDEssDEnoversion] Setup Control | /ACTION Required |
Required to indicate the rebuild database workflow. Supported values: Rebuilddatabase |
| [!INCLUDEssDEnoversion] Setup Control | /INSTANCENAME Required |
Specifies a [!INCLUDEssDEnoversion] instance name. For more information, see Instance Configuration. |
| [!INCLUDEssDEnoversion] Setup Control | /Q or /QUIET Optional |
Specifies that Setup runs in a quiet mode without any user interface. This is used for unattended installations. |
| [!INCLUDEssDEnoversion] | /SQLCOLLATION Optional |
Specifies a new server-level collation. The default value is based on the locale of your Windows operating system. For more information, see Collation Settings in Setup. |
| [!INCLUDEssDEnoversion] | /SAPWD Required when /SECURITYMODE=SQL was specified during Installation of the Instance. |
Specifies the password for [!INCLUDEssNoVersion] SA account. |
| [!INCLUDEssDEnoversion] | /SQLSYSADMINACCOUNTS Required |
Use this parameter to provision logins to be members of the sysadmin role. |
| [!INCLUDEssDEnoversion] | /SQLTEMPDBDIR Optional |
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 will be 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. |
| [!INCLUDEssDEnoversion] | /SQLTEMPDBLOGDIR Optional |
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. |
| [!INCLUDEssDEnoversion] | /SQLTEMPDBFILECOUNT Optional |
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 [!INCLUDEssExpress] 8 or the number of cores, whichever is lower for all other editions Important: The primary database file for tempdb will still be 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 [!INCLUDEssNoVersion] deletes the files with naming convention tempdb_mssql_#.ndf. Do not use tempdb_mssql_*.ndf naming convention for user database files. Warning: [!INCLUDEssExpress] is not supported for configuring this parameter. Setup installs only 1 tempdb data file. |
| [!INCLUDEssDEnoversion] | /SQLTEMPDBFILESIZE Optional |
Introduced in [!INCLUDEsssql16-md]. Specifies the initial size of each tempdb data file. Default = 4 MB for [!INCLUDEssExpress], 8 MB for all other editions. Min = (4 MB or 8 MB). Max = 1024 MB (262,144 MB for [!INCLUDEssSQL14]. |
| [!INCLUDEssDEnoversion] | /SQLTEMPDBFILEGROWTH Optional |
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 |
| [!INCLUDEssDEnoversion] | /SQLTEMPDBLOGFILESIZE Optional |
Specifies the initial size of the tempdb log file in MB. Setup allows the size up to 1024. Default value: 4 for [!INCLUDEssExpress] 8 for all other editions Allowed range: Min = default value (4 or 8), Max = 1024 |
| [!INCLUDEssDEnoversion] | /SQLTEMPDBLOGFILEGROWTH Optional |
Introduced in [!INCLUDEsssql16-md]. Specifies the initial size of each tempdb log file. Default = 4 MB for [!INCLUDEssExpress], 8 MB for all other editions. Min = (4 MB or 8 MB). Max = 1024 MB (262,144 MB for [!INCLUDEssSQL14] |
Use the parameters in the following table to develop command-line scripts for uninstallation.
| [!INCLUDEssDEnoversion] component | Parameter | Description |
|---|---|---|
| [!INCLUDEssDEnoversion] Setup Control | /ACTION Required |
Required to indicate the uninstall work flow. Supported values: Uninstall |
| [!INCLUDEssDEnoversion] Setup Control | /CONFIGURATIONFILE Optional |
Specifies the ConfigurationFile to use. |
| [!INCLUDEssDEnoversion] Setup Control | /FEATURES Required |
Specifies components to uninstall. |
| [!INCLUDEssDEnoversion] Setup Control | /HELP, H,? Optional |
Displays the usage options for the parameters. |
| [!INCLUDEssDEnoversion] Setup Control | /INDICATEPROGRESS Optional |
Specifies that the verbose Setup log file will be piped to the console. |
| [!INCLUDEssDEnoversion] Setup Control | /INSTANCENAME Required |
Specifies a [!INCLUDEssDEnoversion] instance name. For more information, see Instance Configuration. |
| [!INCLUDEssDEnoversion] Setup Control | /Q or /QUIET Optional |
Specifies that Setup runs in a quiet mode without any user interface. This is used for unattended installations. |
| [!INCLUDEssDEnoversion] Setup Control | /HIDECONSOLE Optional |
Specifies that the console window is hidden or closed. |
To uninstall an existing instance of SQL Server.
setup.exe /Action=/proxy/https/github.com/MicrosoftDocs/sql-docs/blob/803f1bfe4dac93e8a59dfb58205da9f3be47314e/docs/database-engine/install-windows/Uninstall /FEATURES=SQL,AS,RS,IS,Tools /INSTANCENAME=MSSQLSERVER
To remove a named instance, specify the name of the instance instead of "MSSQLSERVER" in the example that was mentioned earlier in this article.
Before you install a [!INCLUDEssDEnoversion] failover cluster instance, review the following articles:
-
[Hardware and Software Requirements for Installing [!INCLUDEsssql16-md]](../../sql-server/install/hardware-and-software-requirements-for-installing-sql-server.md)
-
Always On Failover Cluster Instances (SQL Server)
[!IMPORTANT]
All failover cluster installation commands require an underlying Windows cluster. All the nodes that will be part of a [!INCLUDEssDEnoversion] 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.
| [!INCLUDEssDEnoversion] component | Parameter | Details |
|---|---|---|
| [!INCLUDEssDEnoversion] Setup Control | /ACTION Required |
Required to indicate the failover cluster installation work flow. Supported value: InstallFailoverCluster |
| [!INCLUDEssDEnoversion] Setup Control | /IACCEPTSQLSERVERLICENSETERMS Required only when the /Q or /QS parameter is specified for unattended installations. |
Required to acknowledge acceptance of the license terms. |
| [!INCLUDEssDEnoversion] Setup Control | /ENU Optional |
Use this parameter to install the English version of SQL Server on a localized operating system when the installation media includes language packs for both English and the language corresponding to the operating system. |
| [!INCLUDEssDEnoversion] Setup Control | /FAILOVERCLUSTERGROUP Optional |
Specifies the name of the resource group to be used for the [!INCLUDEssDEnoversion] 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 | /PBENGSVCACCOUNT Optional |
Specifies the account for the engine service. The default is NT Authority\NETWORK SERVICE. |
| PolyBase | /PBDMSSVCPASSWORD Optional |
Specifies the password for the engine service account. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| PolyBase | /PBENGSVCSTARTUPTYPE Optional |
Specifies the startup mode for the PolyBase engine service: Automatic (default), Disabled, and Manual. |
| PolyBase | /PBPORTRANGE Optional |
Specifies a port range with at least 6 ports for PolyBase services. Example:/PBPORTRANGE=16450-16460 |
| PolyBase | /PBSCALEOUT Optional |
Specifies if the [!INCLUDEssDEnoversion] instance will be used as a part of PolyBase Scale-out computational group. Supported values: True, False |
| [!INCLUDEssDEnoversion] Setup Control | /UpdateEnabled Optional |
Specify whether SQL Server setup should discover and include product updates. The valid values are True and False or 1 and 0. By default, SQL Server setup will include updates that are found. |
| [!INCLUDEssDEnoversion] Setup Control | /UpdateSource Optional |
Specify the location where SQL Server setup will obtain product updates. The valid values are "MU" to search [!INCLUDEmsCoName] Update, a valid folder path, a relative path such as .\MyUpdates or a UNC share. By default, SQL Server setup will search [!INCLUDEmsCoName] Update or a Windows Update Service through the Windows Server Update Services. |
| [!INCLUDEssDEnoversion] Setup Control | /CONFIGURATIONFILE Optional |
Specifies the ConfigurationFile to use. |
| [!INCLUDEssDEnoversion] Setup Control | /ERRORREPORTING Optional |
Has no effect in [!INCLUDEsssql16-md]. To manage how error feedback is sent to Microsoft, see [How to configure [!INCLUDEsssql16-md] to send feedback to Microsoft](https://support.microsoft.com/kb/3153756). In older versions this specifies the error reporting for SQL Server. For more information, see Privacy Statement for the Microsoft Error Reporting Service. Supported values: 1=enabled 0=disabled |
| [!INCLUDEssDEnoversion] Setup Control | /FEATURES Required |
Specifies components to install. |
| [!INCLUDEssDEnoversion] Setup Control | /HELP, ? Optional |
Displays the usage options for the parameters. |
| [!INCLUDEssDEnoversion] Setup Control | /INDICATEPROGRESS Optional |
Specifies that the verbose Setup log file will be piped to the console. |
| [!INCLUDEssDEnoversion] Setup Control | /INSTALLSHAREDDIR Optional |
Specifies a nondefault installation directory for 64-bit shared components. Default is %Program Files%\Microsoft SQL ServerCannot be set to %Program Files(x86)%\Microsoft SQL Server |
| [!INCLUDEssDEnoversion] Setup Control | /INSTALLSHAREDWOWDIR Optional |
Specifies a nondefault installation directory for 32-bit shared components. Supported only on a 64-bit system. Default is %Program Files(x86)%\Microsoft SQL ServerCannot be set to %Program Files%\Microsoft SQL Server |
| [!INCLUDEssDEnoversion] Setup Control | /INSTANCEDIR Optional |
Specifies nondefault installation directory for instance-specific components. |
| [!INCLUDEssDEnoversion] Setup Control | /INSTANCEID Optional |
Specifies a nondefault value for an InstanceID. |
| [!INCLUDEssDEnoversion] Setup Control | /INSTANCENAME Required |
Specifies a [!INCLUDEssDEnoversion] instance name. For more information, see Instance Configuration. |
| [!INCLUDEssDEnoversion] Setup Control | /PID Optional |
Specifies the product key for the edition of SQL Server. If this parameter is not specified, Evaluation is used. |
| [!INCLUDEssDEnoversion] Setup Control | /Q or /QUIET Optional |
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. |
| [!INCLUDEssDEnoversion] Setup Control | /QS or /QUIETSIMPLE Optional |
Specifies that Setup runs and shows progress through the UI, but does not accept any input or show any error messages. |
| [!INCLUDEssDEnoversion] Setup Control | /SQMREPORTING Optional |
Has no effect in [!INCLUDEsssql16-md]. To manage how error feedback is sent to Microsoft, see [How to configure [!INCLUDEsssql16-md] to send feedback to Microsoft](https://support.microsoft.com/kb/3153756). In older versions this specifies feature usage reporting for SQL Server. Supported values: 1=enabled 0=disabled |
| [!INCLUDEssDEnoversion] Setup Control | /HIDECONSOLE Optional |
Specifies the console window would be hidden or closed. |
| [!INCLUDEssDEnoversion] Setup Control | /FAILOVERCLUSTERDISKS Optional |
Specifies the list of shared disks to be included in the [!INCLUDEssDEnoversion] failover cluster resource group. Default value: The first drive is used as the default drive for all databases. |
| [!INCLUDEssDEnoversion] Setup Control | /FAILOVERCLUSTERIPADDRESSES Required |
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=IPv4;172.16.0.0;ClusterNetwork1;172.31.255.255FAILOVERCLUSTERIPADDRESSES=IPv6;DHCP;ClusterNetwork1FAILOVERCLUSTERIPADDRESSES=IPv6;2001:db8:23:1002:20f:1fff:feff:b3a3;ClusterNetwork1 |
| [!INCLUDEssDEnoversion] Setup Control | /FAILOVERCLUSTERNETWORKNAME Required |
Specifies the network name for the new [!INCLUDEssDEnoversion] failover cluster. This name is used to identify the new [!INCLUDEssDEnoversion] failover cluster instance on the network. |
| SQL Server Agent | /AGTSVCACCOUNT Required |
Specifies the account for the SQL Server Agent service. |
| SQL Server Agent | /AGTSVCPASSWORD Required |
Specifies the password for SQL Server Agent service account. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| [!INCLUDEssASnoversion] | /ASBACKUPDIR Optional |
Specifies the directory for [!INCLUDEssASnoversion] 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 |
| [!INCLUDEssASnoversion] | /ASCOLLATION Optional |
Specifies the collation setting for [!INCLUDEssASnoversion]. Default value: Latin1_General_CI_AS |
| [!INCLUDEssASnoversion] | /ASCONFIGDIR Optional |
Specifies the directory for [!INCLUDEssASnoversion] 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 |
| [!INCLUDEssASnoversion] | /ASDATADIR Optional |
Specifies the directory for [!INCLUDEssASnoversion] 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 |
| [!INCLUDEssASnoversion] | /ASLOGDIR Optional |
Specifies the directory for [!INCLUDEssASnoversion] 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 |
| [!INCLUDEssASnoversion] | /ASSYSADMINACCOUNTS Required |
Specifies the administrator credentials for [!INCLUDEssASnoversion]. |
| [!INCLUDEssASnoversion] | /ASTEMPDIR Optional |
Specifies the directory for [!INCLUDEssASnoversion] 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 |
| [!INCLUDEssASnoversion] | /ASPROVIDERMSOLAP Optional |
Specifies whether the MSOLAP provider can run in-process. Default value: 1=enabled |
| [!INCLUDEssASnoversion] | /ASSERVERMODE Optional |
Specifies the server mode of the [!INCLUDEssASnoversion] instance. Valid values in a cluster scenario are MULTIDIMENSIONAL or TABULAR. ASSERVERMODE is case-sensitive. All values must be expressed in upper case. For more information about the valid values, see Install Analysis Services in Tabular Mode. |
| [!INCLUDEssDEnoversion] | /INSTALLSQLDATADIR Required |
Specifies the data directory for [!INCLUDEssNoVersion] data files. The data directory must be specified and on a shared cluster disk. |
| [!INCLUDEssDEnoversion] | /SAPWD Required when /SECURITYMODE=SQL |
Specifies the password for the [!INCLUDEssNoVersion] SA account. |
| [!INCLUDEssDEnoversion] | /SECURITYMODE Optional |
Specifies the security mode for [!INCLUDEssNoVersion]. If this parameter is not supplied, then Windows-only authentication mode is supported. Supported value: SQL |
| [!INCLUDEssDEnoversion] | /SQLBACKUPDIR Optional |
Specifies the directory for backup files. Default value: <InstallSQLDataDir>\<SQLInstanceID>\MSSQL\Backup |
| [!INCLUDEssDEnoversion] | /SQLCOLLATION Optional |
Specifies the collation settings for [!INCLUDEssNoVersion]. The default value is based on the locale of your Windows operating system. For more information, see Collation Settings in Setup. |
| [!INCLUDEssDEnoversion] | /SQLSVCACCOUNT Required |
Specifies the startup account for the [!INCLUDEssNoVersion] service. |
| [!INCLUDEssDEnoversion] | /SQLSVCPASSWORD Required |
Specifies the password for SQLSVCACCOUNT. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| [!INCLUDEssDEnoversion] | /SQLSYSADMINACCOUNTS Required |
Use this parameter to provision logins to be members of the sysadmin role. |
| [!INCLUDEssDEnoversion] | /SQLUSERDBDIR Optional |
Specifies the directory for the data files for user databases. Default value: <InstallSQLDataDir>\<SQLInstanceID>\MSSQL\Data |
| [!INCLUDEssDEnoversion] | /SQLTEMPDBDIR Optional |
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 will be 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. |
| [!INCLUDEssDEnoversion] | /SQLTEMPDBLOGDIR Optional |
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. |
| [!INCLUDEssDEnoversion] | /SQLTEMPDBFILECOUNT Optional |
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 [!INCLUDEssExpress] 8 or the number of cores, whichever is lower for all other editions Important: The primary database file for tempdb will still be 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 SQL Server deletes the files with naming convention tempdb_mssql_#.ndf. Do not use tempdb_mssql_*.ndf naming convention for user database files. Warning: [!INCLUDEssExpress] is not supported for configuring this parameter. Setup installs only 1 tempdb data file. |
| [!INCLUDEssDEnoversion] | /SQLTEMPDBFILESIZE Optional |
Introduced in [!INCLUDEsssql16-md]. Specifies the initial size of each tempdb data file. Default = 8 MB. Min = 8 MB. Max = 1024 MB (262,144 MB for [!INCLUDEssSQL14]. |
| [!INCLUDEssDEnoversion] | /SQLTEMPDBFILEGROWTH Optional |
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 |
| [!INCLUDEssDEnoversion] | /SQLTEMPDBLOGFILESIZE Optional |
Specifies the initial size of the tempdb log file in MB. Setup allows the size up to 1024. Default value: 4 for [!INCLUDEssExpress] 8 for all other editions Allowed range: Min = default value (4 or 8), Max = 1024 |
| [!INCLUDEssDEnoversion] | /SQLTEMPDBLOGFILEGROWTH Optional |
Introduced in [!INCLUDEsssql16-md]. Specifies the initial size of each tempdb log file. Default = 4 MB for [!INCLUDEssExpress], 8 MB for all other editions. Min = (4 MB or 8 MB). Max = 1024 MB (262,144 MB for [!INCLUDEssSQL14] |
| [!INCLUDEssDEnoversion] | /SQLUSERDBLOGDIR Optional |
Specifies the directory for the log files for user databases. Default value: <InstallSQLDataDir>\<SQLInstanceID>\MSSQL\Data |
| FILESTREAM | /FILESTREAMLEVEL Optional |
Specifies the access level for the FILESTREAM feature. Supported values: 0 =Disable FILESTREAM support for this instance. (Default value) 1=Enable FILESTREAM for [!INCLUDEtsql] access. 2=Enable FILESTREAM for [!INCLUDEtsql] and file I/O streaming access. (Not valid for cluster scenarios) 3=Allow remote clients to have streaming access to FILESTREAM data. |
| FILESTREAM | /FILESTREAMSHARENAME Optional Required when FILESTREAMLEVEL is greater than 1. |
Specifies the name of the windows share in which the FILESTREAM data will be stored. |
| SQL Server Full Text | /FTSVCACCOUNT Optional |
Specifies the account for Full-Text filter launcher service. This parameter is ignored in [!INCLUDEfirstref_longhorn] or higher. ServiceSID will be used to help secure the communication between SQL Server and Full-text Filter Daemon. If the values are not provided the Full-text Filter Launcher Service will be disabled. You have to use SQL Server Control Manager to change the service account and enable full-text functionality. Default value: Local Service Account |
| SQL Server Full Text | /FTSVCPASSWORD Optional |
Specifies the password for the Full-Text filter launcher service. This parameter is ignored in [!INCLUDEfirstref_longhorn] or higher. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| [!INCLUDEssISnoversion] | /ISSVCACCOUNT Required |
Specifies the account for [!INCLUDEssISnoversion]. Default value: NT AUTHORITY\NETWORK SERVICE |
| [!INCLUDEssISnoversion] | /ISSVCPASSWORD Required |
Specifies the [!INCLUDEssISnoversion] password. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| [!INCLUDEssISnoversion] | /ISSVCStartupType Optional |
Specifies the startup mode for the [!INCLUDEssISnoversion] service. |
| [!INCLUDEssRSnoversion] | /RSINSTALLMODE Optional |
No longer applicable starting with SQL Server 2017. Specifies the Install mode for [!INCLUDEssRSnoversion]. |
| [!INCLUDEssRSnoversion] | /RSSVCACCOUNT Required |
No longer applicable starting with SQL Server 2017. Specifies the startup account for [!INCLUDEssRSnoversion]. |
| [!INCLUDEssRSnoversion] | /RSSVCPASSWORD Required |
No longer applicable starting with SQL Server 2017. Specifies the password for the startup account for [!INCLUDEssRSnoversion] service. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| [!INCLUDEssRSnoversion] | /RSSVCStartupType Optional |
No longer applicable starting with SQL Server 2017. Specifies the startup mode for [!INCLUDEssRSnoversion]. Supported values: Automatic Disabled Manual |
We recommend that you use Service SID instead of domain groups.
The [!INCLUDEssDE] and [!INCLUDEssASnoversion] are the only components that are cluster-aware. Other features are not cluster-aware and do not have high availability through failover.
To install a single-node [!INCLUDEssDEnoversion] failover cluster instance with the [!INCLUDEssDE] and [!INCLUDEssASnoversion], default instance.
setup.exe /q /ACTION=/proxy/https/github.com/MicrosoftDocs/sql-docs/blob/803f1bfe4dac93e8a59dfb58205da9f3be47314e/docs/database-engine/install-windows/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> /IACCEPTSQLSERVERLICENSETERMS
Use 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).
| [!INCLUDEssDEnoversion] component | Parameter | Description |
|---|---|---|
| [!INCLUDEssDEnoversion] Setup Control | /ACTION Required |
Required to indicate the failover cluster prepare work flow. Supported value: PrepareFailoverCluster |
| [!INCLUDEssDEnoversion] Setup Control | /IACCEPTSQLSERVERLICENSETERMS Required only when the /Q or /QS parameter is specified for unattended installations. |
Required to acknowledge acceptance of the license terms. |
| [!INCLUDEssDEnoversion] Setup Control | /ENU Optional |
Use this parameter to install the English version of SQL Server on a localized operating system when the installation media includes language packs for both English and the language corresponding to the operating system. |
| [!INCLUDEssDEnoversion] Setup Control | /UpdateEnabled Optional |
Specify whether SQL Server setup should discover and include product updates. The valid values are True and False or 1 and 0. By default, SQL Server setup will include updates that are found. |
| [!INCLUDEssDEnoversion] Setup Control | /UpdateSource Optional |
Specify the location where SQL Server setup will obtain product updates. The valid values are "MU" to search [!INCLUDEmsCoName] Update, a valid folder path, a relative path such as .\MyUpdates or a UNC share. By default, [!INCLUDEssNoVersion] setup will search [!INCLUDEmsCoName] Update or a Windows Update Service through the Windows Server Update Services. |
| [!INCLUDEssDEnoversion] Setup Control | /CONFIGURATIONFILE Optional |
Specifies the ConfigurationFile to use. |
| [!INCLUDEssDEnoversion] Setup Control | /ERRORREPORTING Optional |
Has no effect in [!INCLUDEsssql16-md]. To manage how error feedback is sent to Microsoft, see [How to configure [!INCLUDEsssql16-md] to send feedback to Microsoft](https://support.microsoft.com/kb/3153756). In older versions this specifies the error reporting for SQL Server. For more information, see Privacy Statement for the Microsoft Error Reporting Service. Supported values: 0=disabled 1=enabled |
| [!INCLUDEssDEnoversion] Setup Control | /FEATURES Required |
Specifies components to install. |
| [!INCLUDEssDEnoversion] Setup Control | /HELP, ? Optional |
Displays the usage options for the parameters. |
| [!INCLUDEssDEnoversion] Setup Control | /INDICATEPROGRESS Optional |
Specifies that the verbose Setup log file will be piped to the console. |
| [!INCLUDEssDEnoversion] Setup Control | /INSTALLSHAREDDIR Optional |
Specifies a nondefault installation directory for 64-bit shared components. Default is %Program Files%\Microsoft SQL ServerCannot be set to %Program Files(x86)%\Microsoft SQL Server |
| [!INCLUDEssDEnoversion] Setup Control | /INSTALLSHAREDWOWDIR Optional |
Specifies a nondefault installation directory for 32-bit shared components. Supported only on a 64-bit system. Default is %Program Files(x86)%\Microsoft SQL ServerCannot be set to %Program Files%\Microsoft SQL Server |
| [!INCLUDEssDEnoversion] Setup Control | /INSTANCEDIR Optional |
Specifies nondefault installation directory for instance-specific components. |
| [!INCLUDEssDEnoversion] Setup Control | /INSTANCEID Optional |
Specifies a nondefault value for an InstanceID. |
| [!INCLUDEssDEnoversion] Setup Control | /INSTANCENAME Required |
Specifies a [!INCLUDEssDEnoversion] instance name. For more information, see Instance Configuration. |
| PolyBase | /PBENGSVCACCOUNT Optional |
Specifies the account for the engine service. The default is NT Authority\NETWORK SERVICE. |
| PolyBase | /PBDMSSVCPASSWORD Optional |
Specifies the password for the engine service account. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| PolyBase | /PBENGSVCSTARTUPTYPE Optional |
Specifies the startup mode for the PolyBase engine service: Automatic (default) , Disabled, and Manual. |
| PolyBase | /PBPORTRANGE Optional |
Specifies a port range with at least 6 ports for PolyBase services. Example:/PBPORTRANGE=16450-16460 |
| PolyBase | /PBSCALEOUT Optional |
Specifies if the [!INCLUDEssDEnoversion] instance will be used as a part of PolyBase Scale-out computational group. Supported values: True, False |
| [!INCLUDEssDEnoversion] Setup Control | /PID Optional |
Specifies the product key for the edition of SQL Server. If this parameter is not specified, Evaluation is used. |
| [!INCLUDEssDEnoversion] Setup Control | /Q or /QUIET Optional |
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. |
| [!INCLUDEssDEnoversion] Setup Control | /QS or /QUIETSIMPLE Optional |
Specifies that Setup runs and shows progress through the UI, but does not accept any input or show any error messages. |
| [!INCLUDEssDEnoversion] Setup Control | /SQMREPORTING Optional |
Has no effect in [!INCLUDEsssql16-md]. To manage how error feedback is sent to Microsoft, see [How to configure [!INCLUDEsssql16-md] to send feedback to Microsoft](https://support.microsoft.com/kb/3153756). In older versions this specifies feature usage reporting for SQL Server. Supported values: 0=disabled 1=enabled |
| [!INCLUDEssDEnoversion] Setup Control | /HIDECONSOLE Optional |
Specifies that the console window is hidden or closed. |
| SQL Server Agent | /AGTSVCACCOUNT Required |
Specifies the account for the SQL Server Agent service. |
| SQL Server Agent | /AGTSVCPASSWORD Required |
Specifies the password for SQL Server Agent service account. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| [!INCLUDEssASnoversion] | /ASSVCACCOUNT Required |
Specifies the account for the [!INCLUDEssASnoversion] service. |
| [!INCLUDEssASnoversion] | /ASSVCPASSWORD Required |
Specifies the password for the [!INCLUDEssASnoversion] service. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| [!INCLUDEssDEnoversion] | /SQLSVCACCOUNT Required |
Specifies the startup account for the SQL Server service. |
| [!INCLUDEssDEnoversion] | /SQLSVCPASSWORD Required |
Specifies the password for SQLSVCACCOUNT. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| FILESTREAM | /FILESTREAMLEVEL Optional |
Specifies the access level for the FILESTREAM feature. Supported values: 0 =Disable FILESTREAM support for this instance. (Default value) 1=Enable FILESTREAM for [!INCLUDEtsql] access. 2=Enable FILESTREAM for [!INCLUDEtsql] and file I/O streaming access. (Not valid for Cluster scenarios) 3=Allow remote clients to have streaming access to FILESTREAM data. |
| FILESTREAM | /FILESTREAMSHARENAME Optional Required when FILESTREAMLEVEL is greater than 1. |
Specifies the name of the windows share in which the FILESTREAM data will be stored. |
| SQL Server Full Text | /FTSVCACCOUNT Optional |
Specifies the account for Full-Text filter launcher service. This parameter is ignored in [!INCLUDEfirstref_longhorn] or higher. ServiceSID will be used to help secure the communication between SQL Server and Full-text Filter Daemon. If the values are not provided the Full-text Filter Launcher Service will be disabled. You have to use SQL Server Control Manager to change the service account and enable full-text functionality. Default value: Local Service Account |
| SQL Server Full Text | /FTSVCPASSWORD Optional |
Specifies the password for the Full-Text filter launcher service. This parameter is ignored in [!INCLUDEfirstref_longhorn] or higher. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| [!INCLUDEssISnoversion] | /ISSVCACCOUNT Required |
Specifies the account for [!INCLUDEssISnoversion]. Default value: NT AUTHORITY\NETWORK SERVICE |
| [!INCLUDEssISnoversion] | /ISSVCPASSWORD Required |
Specifies the [!INCLUDEssISnoversion] password. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| [!INCLUDEssISnoversion] | /ISSVCStartupType Optional |
Specifies the startup mode for the [!INCLUDEssISnoversion] service. |
| [!INCLUDEssRSnoversion] | /RSINSTALLMODE Available only on Files only mode. |
No longer applicable starting with SQL Server 2017. Specifies the Install mode for [!INCLUDEssRSnoversion]. |
| [!INCLUDEssRSnoversion] | /RSSVCACCOUNT Required |
No longer applicable starting with SQL Server 2017. Specifies the startup account for [!INCLUDEssRSnoversion]. |
| [!INCLUDEssRSnoversion] | /RSSVCPASSWORD Required |
No longer applicable starting with SQL Server 2017. Specifies the password for the startup account for [!INCLUDEssRSnoversion] service. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| [!INCLUDEssRSnoversion] | /RSSVCStartupType Optional |
No longer applicable starting with SQL Server 2017. Specifies the startup mode for [!INCLUDEssRSnoversion]. 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 [!INCLUDEssDE] and [!INCLUDEssASnoversion].
Run the following command at the command prompt to prepare a default instance:
setup.exe /q /ACTION=/proxy/https/github.com/MicrosoftDocs/sql-docs/blob/803f1bfe4dac93e8a59dfb58205da9f3be47314e/docs/database-engine/install-windows/PrepareFailoverCluster /InstanceName=MSSQLSERVER /Features=AS,SQL /INDICATEPROGRESS /ASSVCACCOUNT="<DomainName\UserName>" /ASSVCPASSWORD="xxxxxxxxxxx" /SQLSVCACCOUNT="<DomainName\UserName>" /SQLSVCPASSWORD="xxxxxxxxxxx" /AGTSVCACCOUNT="<DomainName\UserName>" /AGTSVCPASSWORD="xxxxxxxxxxx" /IACCEPTSQLSERVERLICENSETERMS
Run the following command at the command prompt to prepare a named instance:
setup.exe /q /ACTION=/proxy/https/github.com/MicrosoftDocs/sql-docs/blob/803f1bfe4dac93e8a59dfb58205da9f3be47314e/docs/database-engine/install-windows/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
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).
| [!INCLUDEssDEnoversion] component | Parameter | Description |
|---|---|---|
| [!INCLUDEssDEnoversion] Setup Control | /ACTION Required |
Required to indicate the failover cluster complete work flow. Supported value: CompleteFailoverCluster |
| [!INCLUDEssDEnoversion] Setup Control | /ENU Optional |
Use this parameter to install the English version of SQL Server on a localized operating system when the installation media includes language packs for both English and the language corresponding to the operating system. |
| [!INCLUDEssDEnoversion] Setup Control | /FAILOVERCLUSTERGROUP Optional |
Specifies the name of the resource group to be used for the [!INCLUDEssDEnoversion] failover cluster. It can be the name of an existing cluster group or the name of a new resource group. Default value: [!INCLUDEssNoVersion] (<InstanceName>) |
| [!INCLUDEssDEnoversion] Setup Control | /CONFIGURATIONFILE Optional |
Specifies the ConfigurationFile to use. |
| [!INCLUDEssDEnoversion] Setup Control | /ERRORREPORTING Optional |
Has no effect in [!INCLUDEsssql16-md]. To manage how error feedback is sent to Microsoft, see [How to configure [!INCLUDEsssql16-md] to send feedback to Microsoft](https://support.microsoft.com/kb/3153756). In older versions this specifies the error reporting for [!INCLUDEssNoVersion]. For more information, see Privacy Statement for the Microsoft Error Reporting Service. Supported values: 1=enabled 0=disabled |
| [!INCLUDEssDEnoversion] Setup Control | /HELP, ? Optional |
Displays the usage options for the parameters. |
| [!INCLUDEssDEnoversion] Setup Control | /INDICATEPROGRESS Optional |
Specifies that the verbose Setup log file will be piped to the console. |
| [!INCLUDEssDEnoversion] Setup Control | /INSTANCENAME Required |
Specifies a [!INCLUDEssDEnoversion] instance name. For more information, see Instance Configuration |
| [!INCLUDEssDEnoversion] Setup Control | /PID Optional |
Specifies the product key for the edition of [!INCLUDEssNoVersion]. If this parameter is not specified, Evaluation is used. |
| [!INCLUDEssDEnoversion] Setup Control | /Q or /QUIET Optional |
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. |
| [!INCLUDEssDEnoversion] Setup Control | /QS or /QUIETSIMPLE Optional |
Specifies that Setup runs and shows progress through the UI, but does not accept any input or show any error messages. |
| [!INCLUDEssDEnoversion] Setup Control | /SQMREPORTING Optional |
Has no effect in [!INCLUDEsssql16-md]. To manage how error feedback is sent to Microsoft, see [How to configure [!INCLUDEsssql16-md] to send feedback to Microsoft](https://support.microsoft.com/kb/3153756). In older versions this specifies feature usage reporting for [!INCLUDEssNoVersion]. Supported values: 1=enabled 0=disabled |
| [!INCLUDEssDEnoversion] Setup Control | /HIDECONSOLE Optional |
Specifies that the console window is hidden or closed. |
| [!INCLUDEssDEnoversion] Setup Control | /FAILOVERCLUSTERDISKS Optional |
Specifies the list of shared disks to be included in the [!INCLUDEssDEnoversion] failover cluster resource group. Default value: The first drive is used as the default drive for all databases. |
| [!INCLUDEssDEnoversion] Setup Control | /FAILOVERCLUSTERIPADDRESSES Required |
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=IPv4;172.16.0.0;ClusterNetwork1;172.31.255.255FAILOVERCLUSTERIPADDRESSES=IPv6;DHCP;ClusterNetwork1FAILOVERCLUSTERIPADDRESSES=IPv6;2001:db8:23:1002:20f:1fff:feff:b3a3;ClusterNetwork1 |
| [!INCLUDEssDEnoversion] Setup Control | /FAILOVERCLUSTERNETWORKNAME Required |
Specifies the network name for the new [!INCLUDEssDEnoversion] failover cluster. This name is used to identify the new [!INCLUDEssDEnoversion] failover cluster instance on the network. |
| [!INCLUDEssDEnoversion] Setup Control | /CONFIRMIPDEPENDENCYCHANGE | Indicates the consent to set the IP address resource dependency to OR for multi-subnet failover clusters. For more information, see Create a new SQL Server Failover Cluster (Setup). Supported Values: 0 = False (Default) 1 = True |
| [!INCLUDEssASnoversion] | /ASBACKUPDIR Optional |
Specifies the directory for [!INCLUDEssASnoversion] 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 |
| [!INCLUDEssASnoversion] | /ASCOLLATION Optional |
Specifies the collation setting for [!INCLUDEssASnoversion]. Default value: Latin1_General_CI_AS |
| [!INCLUDEssASnoversion] | /ASCONFIGDIR Optional |
Specifies the directory for [!INCLUDEssASnoversion] 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 |
| [!INCLUDEssASnoversion] | /ASDATADIR Optional |
Specifies the directory for [!INCLUDEssASnoversion] 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 |
| [!INCLUDEssASnoversion] | /ASLOGDIR Optional |
Specifies the directory for [!INCLUDEssASnoversion] 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 |
| [!INCLUDEssASnoversion] | /ASSERVERMODE Optional |
Specifies the server mode of the Analysis Services instance. Valid values in a cluster scenario are MULTIDIMENSIONAL or TABULAR. ASSERVERMODE is case-sensitive. All values must be expressed in upper case. For more information about the valid values, see Install Analysis Services in Tabular Mode. |
| [!INCLUDEssASnoversion] | /ASSYSADMINACCOUNTS Required |
Specifies the administrator credentials for [!INCLUDEssASnoversion]. |
| [!INCLUDEssASnoversion] | /ASTEMPDIR Optional |
Specifies the directory for [!INCLUDEssASnoversion] 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 |
| [!INCLUDEssASnoversion] | /ASPROVIDERMSOLAP Optional |
Specifies whether the MSOLAP provider can run in-process. Default value: 1=enabled |
| [!INCLUDEssDEnoversion] | /INSTALLSQLDATADIR Required |
Specifies the data directory for [!INCLUDEssNoVersion] data files. The data directory must to specified and on a shared cluster disk. |
| [!INCLUDEssDEnoversion] | /SAPWD Required when /SECURITYMODE=SQL |
Specifies the password for the [!INCLUDEssNoVersion] SA account. |
| [!INCLUDEssDEnoversion] | /SECURITYMODE Optional |
Specifies the security mode for [!INCLUDEssNoVersion]. If this parameter is not supplied, then Windows-only authentication mode is supported Supported value: SQL |
| [!INCLUDEssDEnoversion] | /SQLBACKUPDIR Optional |
Specifies the directory for backup files. Default value: <InstallSQLDataDir>\<SQLInstanceID>\MSSQL\Backup |
| [!INCLUDEssDEnoversion] | /SQLCOLLATION Optional |
Specifies the collation settings for [!INCLUDEssNoVersion]. The default value is based on the locale of your Windows operating system. For more information, see Collation Settings in Setup. |
| [!INCLUDEssDEnoversion] | /SQLSYSADMINACCOUNTS Required |
Use this parameter to provision logins to be members of the sysadmin role. |
| [!INCLUDEssDEnoversion] | /SQLUSERDBDIR Optional |
Specifies the directory for the data files for user databases. Default value: <InstallSQLDataDir>\<SQLInstanceID>\MSSQL\Data |
| [!INCLUDEssDEnoversion] | /SQLUSERDBLOGDIR Optional |
Specifies the directory for the log files for user databases. Default value: <InstallSQLDataDir>\<SQLInstanceID>\MSSQL\Data |
| [!INCLUDEssRSnoversion] | /RSINSTALLMODE Available on files only mode. |
No longer applicable starting with SQL Server 2017. Specifies the Install mode for [!INCLUDEssRSnoversion]. |
| [!INCLUDEssDEnoversion] | /SQLTEMPDBDIR Optional |
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 will be 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. |
| [!INCLUDEssDEnoversion] | /SQLTEMPDBLOGDIR Optional |
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. |
| [!INCLUDEssDEnoversion] | /SQLTEMPDBFILECOUNT Optional |
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 [!INCLUDEssExpress] 8 or the number of cores, whichever is lower for all other editions. Important: The primary database file for tempdb will still be 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 SQL Server deletes the files with naming convention tempdb_mssql_#.ndf. Do not use tempdb_mssql_*.ndf naming convention for user database files. Warning: [!INCLUDEssExpress] is not supported for configuring this parameter. Setup installs only 1 tempdb data file. |
| [!INCLUDEssDEnoversion] | /SQLTEMPDBFILESIZE Optional |
Introduced in [!INCLUDEsssql16-md]. Specifies the initial size of each tempdb data file. Default = 8 MB. Min = 8 MB. Max = 1024 MB (262,144 MB for [!INCLUDEssSQL14]). |
| [!INCLUDEssDEnoversion] | /SQLTEMPDBFILEGROWTH Optional |
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 |
| [!INCLUDEssDEnoversion] | /SQLTEMPDBLOGFILESIZE Optional |
Specifies the initial size of the tempdb log file in MB. Setup allows the size up to 1024. Default value: 4 for [!INCLUDEssExpress] 8 for all other editions Allowed range: Min = default value (4 or 8), Max = 1024 |
| [!INCLUDEssDEnoversion] | /SQLTEMPDBLOGFILEGROWTH Optional |
Introduced in [!INCLUDEsssql16-md]. Specifies the initial size of each tempdb log file. Default = 4 MB for [!INCLUDEssExpress], 8 MB for all other editions. Min = (4 MB or 8 MB). Max = 1024 MB (262,144 MB for [!INCLUDEssSQL14] |
To perform the "Completion" step of a failover cluster advanced installation scenario for the [!INCLUDEssDE] and [!INCLUDEssASnoversion]. Run the following command on the computer that will be 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 [!INCLUDEssASnoversion] failover cluster.
Run the following command at the command prompt to complete failover cluster installation for a default instance:
setup.exe /q /ACTION=/proxy/https/github.com/MicrosoftDocs/sql-docs/blob/803f1bfe4dac93e8a59dfb58205da9f3be47314e/docs/database-engine/install-windows/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 at the command prompt to complete failover cluster installation for a named instance:
setup.exe /q /ACTION=/proxy/https/github.com/MicrosoftDocs/sql-docs/blob/803f1bfe4dac93e8a59dfb58205da9f3be47314e/docs/database-engine/install-windows/CompleteFailoverCluster /InstanceName="<Insert Instance Name>" /INDICATEPROGRESS /ASSYSADMINACCOUNTS="<DomainName\UserName>" /ASDATADIR=<Drive>:\KATMAI\Data /ASLOGDIR=<drive>:\KATMAI\Log /ASBACKUPDIR=<Drive>:\KATMAI\Backup /ASCONFIGDIR=<Drive>:\KATMAI\Config /ASTEMPDIR=<Drive>:\KATMAI\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_KATMAI" /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 [!INCLUDEssDEnoversion] 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).
| [!INCLUDEssDEnoversion] component | Parameter | Description |
|---|---|---|
| [!INCLUDEssDEnoversion] Setup Control | /ACTION Required |
Required to indicate the installation workflow. Supported value: Upgrade |
| [!INCLUDEssDEnoversion] Setup Control | /IACCEPTSQLSERVERLICENSETERMS Required only when the /Q or /QS parameter is specified for unattended installations. |
Required to acknowledge acceptance of the license terms. |
| [!INCLUDEssDEnoversion] Setup Control | /ENU Optional |
Use this parameter to install the English version of SQL Server on a localized operating system when the installation media includes language packs for both English and the language corresponding to the operating system. |
| [!INCLUDEssDEnoversion] Setup Control | /UpdateEnabled Optional |
Specify whether SQL Server setup should discover and include product updates. The valid values are True and False or 1 and 0. By default, SQL Server setup will include updates that are found. |
| [!INCLUDEssDEnoversion] Setup Control | /UpdateSource Optional |
Specify the location where SQL Server setup will obtain product updates. The valid values are "MU" to search [!INCLUDEmsCoName] Update, a valid folder path, a relative path such as .\MyUpdates or a UNC share. By default, [!INCLUDEssNoVersion] setup will search [!INCLUDEmsCoName] Update or a Windows Update Service through the Windows Server Update Services. |
| [!INCLUDEssDEnoversion] Setup Control | /CONFIGURATIONFILE Optional |
Specifies the ConfigurationFile to use. |
| [!INCLUDEssDEnoversion] Setup Control | /ERRORREPORTING Optional |
Has no effect in [!INCLUDEsssql16-md]. To manage how error feedback is sent to Microsoft, see [How to configure [!INCLUDEsssql16-md] to send feedback to Microsoft](https://support.microsoft.com/kb/3153756). In older versions this specifies the error reporting for SQL Server. For more information, see Privacy Statement for the Microsoft Error Reporting Service. Supported values: 0=disabled 1=enabled |
| [!INCLUDEssDEnoversion] Setup Control | /HELP, ? Optional |
Displays the usage options for the parameters. |
| [!INCLUDEssDEnoversion] Setup Control | /INDICATEPROGRESS Optional |
Specifies that the verbose Setup log file will be piped to the console. |
| [!INCLUDEssDEnoversion] Setup Control | / INSTANCEDIR Optional |
Specifies a non-default installation directory for shared components. |
| [!INCLUDEssDEnoversion] Setup Control | /INSTANCEID Required when you upgrade from [!INCLUDEssKatmai] or higher. Optional when you upgrade from [!INCLUDEssVersion2005] |
Specifies a nondefault value for an InstanceID. |
| [!INCLUDEssDEnoversion] Setup Control | /INSTANCENAME Required |
Specifies a [!INCLUDEssDEnoversion] instance name. For more information, see Instance Configuration. |
| [!INCLUDEssDEnoversion] Setup Control | /PID Optional |
Specifies the product key for the edition of SQL Server. If this parameter is not specified, Evaluation is used. |
| [!INCLUDEssDEnoversion] Setup Control | /Q or /QUIET Optional |
Specifies that Setup runs in a quiet mode without any user interface. This is used for unattended installations. |
| [!INCLUDEssDEnoversion] Setup Control | /SQMREPORTING Optional |
Has no effect in [!INCLUDEsssql16-md]. In older versions this specifies feature usage reporting for SQL Server. Supported values: 0=disabled 1=enabled |
| [!INCLUDEssDEnoversion] Setup Control | /HIDECONSOLE Optional |
Specifies that the console window is hidden or closed. |
| [!INCLUDEssDEnoversion] Setup Control | /FAILOVERCLUSTERROLLOWNERSHIP | Specifies the failover behavior during upgrade. |
| SQL Server Browser Service | /BROWSERSVCSTARTUPTYPE Optional |
Specifies the startup mode for SQL Server Browser service. Supported values: Automatic Disabled Manual |
| SQL Server Full-Text | /FTUPGRADEOPTION Optional |
Specifies the Full-Text catalog upgrade option. Supported values: REBUILD RESET IMPORT |
| [!INCLUDEssISnoversion] | /ISSVCACCOUNT Required |
Specifies the account for [!INCLUDEssISnoversion]. Default value: NT AUTHORITY\NETWORK SERVICE |
| [!INCLUDEssISnoversion] | /ISSVCPASSWORD Required |
Specifies the [!INCLUDEssISnoversion] password. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| [!INCLUDEssISnoversion] | /ISSVCStartupType Optional |
Specifies the startup mode for the [!INCLUDEssISnoversion] service. |
| [!INCLUDEssRSnoversion] | /RSUPGRADEDATABASEACCOUNT Optional |
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 [!INCLUDEssSQL11] [!INCLUDEssRSnoversion]. If this option is not 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. |
| [!INCLUDEssRSnoversion] | /RSUPGRADEPASSWORD Optional |
Password of the existing Report Server service account. |
Use the parameters in the following table to develop command-line scripts for AddNode.
| [!INCLUDEssDEnoversion] component | Parameter | Description |
|---|---|---|
| [!INCLUDEssDEnoversion] Setup Control | /ACTION Required |
Required to indicate AddNode work flow. Supported value: AddNode |
| [!INCLUDEssDEnoversion] Setup Control | /IACCEPTSQLSERVERLICENSETERMS Required only when the /Q or /QS parameter is specified for unattended installations. |
Required to acknowledge acceptance of the license terms. |
| [!INCLUDEssDEnoversion] Setup Control | /ENU Optional |
Use this parameter to install the English version of [!INCLUDEssNoVersion] on a localized operating system when the installation media includes language packs for both English and the language corresponding to the operating system. |
| [!INCLUDEssDEnoversion] Setup Control | /UpdateEnabled Optional |
Specify whether [!INCLUDEssNoVersion] setup should discover and include product updates. The valid values are True and False or 1 and 0. By default, SQL Server setup will include updates that are found. |
| [!INCLUDEssDEnoversion] Setup Control | /UpdateSource Optional |
Specify the location where SQL Server setup will obtain product updates. The valid values are "MU" to search [!INCLUDEmsCoName] Update, a valid folder path, a relative path such as .\MyUpdates or a UNC share. By default, [!INCLUDEssNoVersion] setup will search [!INCLUDEmsCoName] Update or a Windows Update Service through the Windows Server Update Services. |
| [!INCLUDEssDEnoversion] Setup Control | /CONFIGURATIONFILE Optional |
Specifies the ConfigurationFile to use. |
| [!INCLUDEssDEnoversion] Setup Control | /HELP, ? Optional |
Displays the usage options for the parameters. |
| [!INCLUDEssDEnoversion] Setup Control | /INDICATEPROGRESS Optional |
Specifies that the verbose Setup log file will be piped to the console. |
| [!INCLUDEssDEnoversion] Setup Control | /INSTANCENAME Required |
Specifies a [!INCLUDEssDEnoversion] instance name. For more information, see Instance Configuration. |
| PolyBase | /PBENGSVCACCOUNT Optional |
Specifies the account for the engine service. The default is NT Authority\NETWORK SERVICE. |
| PolyBase | /PBDMSSVCPASSWORD Optional |
Specifies the password for the engine service account. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| PolyBase | /PBENGSVCSTARTUPTYPE Optional |
Specifies the startup mode for the PolyBase engine service: Automatic (default) , Disabled, and Manual. |
| PolyBase | /PBPORTRANGE Optional |
Specifies a port range with at least 6 ports for PolyBase services. Example:/PBPORTRANGE=16450-16460 |
| PolyBase | /PBSCALEOUT Optional |
Specifies if the [!INCLUDEssDEnoversion] instance will be used as a part of PolyBase Scale-out computational group. Supported values: True, False |
| [!INCLUDEssDEnoversion] Setup Control | /PID Optional |
Specifies the product key for the edition of SQL Server. If this parameter is not specified, Evaluation is used. |
| [!INCLUDEssDEnoversion] Setup Control | /Q or /QUIET Optional |
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. |
| [!INCLUDEssDEnoversion] Setup Control | /QS or /QUIETSIMPLE Optional |
Specifies that Setup runs and shows progress through the UI, but does not accept any input or show any error messages. |
| [!INCLUDEssDEnoversion] Setup Control | /HIDECONSOLE Optional |
Specifies that the console window is hidden or closed. |
| [!INCLUDEssDEnoversion] Setup Control | /FAILOVERCLUSTERIPADDRESSES Required |
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=IPv4;172.16.0.0;ClusterNetwork1;172.31.255.255FAILOVERCLUSTERIPADDRESSES=IPv6;DHCP;ClusterNetwork1FAILOVERCLUSTERIPADDRESSES=IPv6;2001:db8:23:1002:20f:1fff:feff:b3a3;ClusterNetwork1For more information, see [Add or Remove Nodes in a [!INCLUDEssDEnoversion] failover Cluster (Setup)](../../sql-server/failover-clusters/install/add-or-remove-nodes-in-a-sql-server-failover-cluster-setup.md). |
| [!INCLUDEssDEnoversion] Setup Control | /CONFIRMIPDEPENDENCYCHANGE Required |
Indicates the consent to set the IP address resource dependency to OR for multi-subnet failover clusters. For more information, see [Add or Remove Nodes in a [!INCLUDEssDEnoversion] failover Cluster (Setup)](../../sql-server/failover-clusters/install/add-or-remove-nodes-in-a-sql-server-failover-cluster-setup.md). Supported values: 0 = False (Default) 1 = True |
| SQL Server Agent | /AGTSVCACCOUNT Required |
Specifies the account for the SQL Server Agent service. |
| SQL Server Agent | /AGTSVCPASSWORD Required |
Specifies the password for SQL Server Agent service account. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| [!INCLUDEssASnoversion] | /ASSVCACCOUNT Required |
Specifies the account for the [!INCLUDEssASnoversion] service. |
| [!INCLUDEssASnoversion] | /ASSVCPASSWORD Required |
Specifies the password for the [!INCLUDEssASnoversion] service. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| [!INCLUDEssDEnoversion] | /SQLSVCACCOUNT Required |
Specifies the startup account for the SQL Server service. |
| [!INCLUDEssDEnoversion] | /SQLSVCPASSWORD Required |
Specifies the password for SQLSVCACCOUNT. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| [!INCLUDEssISnoversion] | /ISSVCPASSWORD Required |
Specifies the [!INCLUDEssISnoversion] password. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
| [!INCLUDEssRSnoversion] | /RSINSTALLMODE Available in Files only mode |
No longer applicable starting with SQL Server 2017. Specifies the Install mode for [!INCLUDEssRSnoversion]. |
| [!INCLUDEssRSnoversion] | /RSSVCPASSWORD Required |
No longer applicable starting with SQL Server 2017. Specifies the startup account password for the [!INCLUDEssRSnoversion] service. This parameter can be omitted when using a managed service account, virtual account, or built-in account. |
The [!INCLUDEssDE] and [!INCLUDEssASnoversion] are the only components that are cluster-aware. Other features are not cluster-aware and do not have high availability through failover.
To add a node to an existing failover cluster instance with the [!INCLUDEssDE] and [!INCLUDEssASnoversion].
setup.exe /q /ACTION=/proxy/https/github.com/MicrosoftDocs/sql-docs/blob/803f1bfe4dac93e8a59dfb58205da9f3be47314e/docs/database-engine/install-windows/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=0
Use 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).
| [!INCLUDEssDEnoversion] component | Parameter | Description |
|---|---|---|
| [!INCLUDEssDEnoversion] Setup Control | /ACTION Required |
Required to indicate RemoveNode work flow. Supported value: RemoveNode |
| [!INCLUDEssDEnoversion] Setup Control | /CONFIGURATIONFILE Optional |
Specifies the ConfigurationFile to use. |
| [!INCLUDEssDEnoversion] Setup Control | /HELP, ? Optional |
Displays the usage options for the parameters. |
| [!INCLUDEssDEnoversion] Setup Control | /INDICATEPROGRESS Optional |
Specifies that the verbose Setup log file will be piped to the console. |
| [!INCLUDEssDEnoversion] Setup Control | /INSTANCENAME Required |
Specifies a [!INCLUDEssDEnoversion] instance name. For more information, see Instance Configuration. |
| [!INCLUDEssDEnoversion] Setup Control | /Q or /QUIET Optional |
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. |
| [!INCLUDEssDEnoversion] Setup Control | /QS or /QUIETSIMPLE Optional |
Specifies that Setup runs and shows progress through the UI, but does not accept any input or show any error messages. |
| [!INCLUDEssDEnoversion] Setup Control | /HIDECONSOLE Optional |
Specifies that the console window is hidden or closed. |
| [!INCLUDEssDEnoversion] Setup Control | /CONFIRMIPDEPENDENCYCHANGE Required |
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 [!INCLUDEssDEnoversion] failover Cluster (Setup)](../../sql-server/failover-clusters/install/add-or-remove-nodes-in-a-sql-server-failover-cluster-setup.md). Supported values: 0 = False (Default) 1 = True |
To remove a node from an existing failover cluster instance with the [!INCLUDEssDE] and [!INCLUDEssASnoversion].
setup.exe /q /ACTION=/proxy/https/github.com/MicrosoftDocs/sql-docs/blob/803f1bfe4dac93e8a59dfb58205da9f3be47314e/docs/database-engine/install-windows/RemoveNode /INSTANCENAME="<Insert Instance Name>" [/INDICATEPROGRESS] /CONFIRMIPDEPENDENCYCHANGE=0
You can configure the SQL Server 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 should not specify the corresponding password parameters. For more information about these service accounts, see New Account Types Available with [!INCLUDEwin7] and [!INCLUDEwinserver2008r2] section in Configure Windows Service Accounts and Permissions.
For more information about service account configuration, see Configure Windows Service Accounts and Permissions.
| [!INCLUDEssDEnoversion] component | Account parameter | Password parameter | Startup type |
|---|---|---|---|
| SQL Server Agent | /AGTSVCACCOUNT | /AGTSVCPASSWORD | /AGTSVCSTARTUPTYPE |
| [!INCLUDEssASnoversion] | /ASSVCACCOUNT | /ASSVCPASSWORD | /ASSVCSTARTUPTYPE |
| [!INCLUDEssDEnoversion] | /SQLSVCACCOUNT | /SQLSVCPASSWORD | /SQLSVCSTARTUPTYPE |
| [!INCLUDEssISnoversion] | /ISSVCACCOUNT | /ISSVCPASSWORD | /ISSVCSTARTUPTYPE |
| [!INCLUDEssRSnoversion] | /RSSVCACCOUNT | /RSSVCPASSWORD | /RSSVCSTARTUPTYPE |
Note
Reporting services features were removed from SQL Server 2017. The account parameters for SQL Server Reporting Services are only applicable to versions prior to SQL Server 2017.
To install specific features, use the /FEATURES parameter and specify the parent feature or feature values in the following table. For a list of features that are supported by the editions of SQL Server, see [Editions and Supported Features for [!INCLUDEsssql16-md]](../../sql-server/editions-and-components-of-sql-server-2016.md), [Editions and Supported Features for [!INCLUDEsssql17]](../../sql-server/editions-and-components-of-sql-server-2017.md), or [Editions and Supported Features for [!INCLUDEsssql19]](../../sql-server/editions-and-components-of-sql-server-version-15.md).
| Parent feature parameter | Feature parameter | Description |
|---|---|---|
| SQL | Installs the [!INCLUDEssDEnoversion], Replication, Fulltext, and [!INCLUDEssDQSServer]. | |
| SQLEngine | Installs just the [!INCLUDEssDEnoversion]. | |
| Replication | Installs the Replication component along with [!INCLUDEssDEnoversion]. | |
| FullText | Installs the FullText component along with [!INCLUDEssDEnoversion]. | |
| DQ | Copies the files required for completing the [!INCLUDEssDQSServer] installation. After completing SQL Server installation, you must run the DQSInstaller.exe file to complete the [!INCLUDEssDQSServer] installation. For more information, see Run DQSInstaller.exe to Complete Data Quality Server Installation. This also installs [!INCLUDEssDEnoversion]. | |
| PolyBase | Installs PolyBase components. | |
| PolyBaseCore | Starting with SQL Server 2019, pair with PolyBase to install Polybase technology that enables truly integrated querying across Oracle, Teradata, SQL Server and other relational and non-relational data using standard T-SQL statements. | |
| PolyBaseJava | Starting with SQL Server 2019, 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 (In-Database). | |
| SQL_INST_MR | Applies to SQL Server Machine Learning Services (2017 or later) and SQL Server 2016 R Services (In-Database). Pair with AdvancedAnalytics to install R Open and proprietary R packages. | |
| SQL_INST_MPY | Applies to SQL Server Machine Learning Services (2017 or later). Pair with AdvancedAnalytics to install Anaconda and proprietary Python packages. | |
| SQL_INST_JAVA | Applies to SQL Server Java Language Extension (2019 and later). Pair with AdvancedAnalytics to install extensions that enable integration with Java using standard T-SQL statements. | |
| AS | Installs all [!INCLUDEssASnoversion] components. | |
| RS | Installs all [!INCLUDEssRSnoversion] components. Removed starting with SQL Server 2017. | |
| RS_SHP | Installs [!INCLUDEssRSnoversion] components for SharePoint. Removed starting with SQL Server 2017. | |
| RS_SHPWFE | Installs [!INCLUDEssRSnoversion] Add-In for SharePoint products. Removed starting with SQL Server 2017. | |
| DQC | Installs [!INCLUDEssDQSClient]. | |
| IS | Installs all [!INCLUDEssISnoversion] 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 [!INCLUDEssMDSshort]. | |
| SQL_SHARED_MPY | Installs Python packages for SQL Server 2017 Machine Learning Server (Standalone) | |
| SQL_SHARED_MR | Installs R packages for SQL Server 2016 R Server (Standalone) or SQL Server Machine Learning Server (Standalone) | |
| Tools* | Installs client tools and SQL Server Books Online components. | |
| BC | Installs backward compatibility components. | |
| Conn | Installs connectivity components. | |
| DREPLAY_CTLR | Installs Distributed Replay controller | |
| DREPLAY_CLT | Installs Distributed Replay client | |
| SNAC_SDK | Installs SDK for [!INCLUDEmsCoName] SQL Server Native Client | |
| SDK | Installs the software development kit. | |
| LocalDB** | Installs LocalDB, an execution mode of [!INCLUDEssExpress] targeted to program developers. |
*[!INCLUDEssManStudioFull] (SSMS) is now in a stand-alone installer that is separate from the [!INCLUDEssnoversion] installer. For details, see Install SQL Server Management Studio.
| Parameter and values | Description |
|---|---|
| /FEATURES=SQLEngine | Installs the [!INCLUDEssDE] without replication and full-text. |
| /FEATURES=SQLEngine,FullText | Installs the [!INCLUDEssDE] and full-text. |
| /FEATURES=SQL,Tools | Installs the complete [!INCLUDEssDE] and all tools. |
| /FEATURES=BOL | Installs SQL Server Books Online components to view and manage help content. |
| /FEATURES=SQLEngine,PolyBase | Installs 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 cannot 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 [!INCLUDEssExpress] and reduces the number of dialog boxes presented to the user. It can be specified from the command line when installing a SQL Server edition that is not [!INCLUDEssExpress].
| Role | Description | Installs... |
|---|---|---|
| SPI_AS_ExistingFarm | Installs [!INCLUDEssASnoversion] as a [!INCLUDEssGemini] named instance on an existing [!INCLUDESPS2010] farm or standalone server. | [!INCLUDEssASnoversion] calculation engine, preconfigured for in-memory data storage and processing. [!INCLUDEssGemini] solution packages Installer program for the [!INCLUDEssGeminiClient] SQL Server Books Online |
| SPI_AS_NewFarm | Installs [!INCLUDEssASnoversion] and [!INCLUDEssDE] as a [!INCLUDEssGemini] named instance on a new, unconfigured Office [!INCLUDESPS2010] farm or standalone server. SQL Server Setup will configure the farm during feature role installation. | [!INCLUDEssASnoversion] calculation engine, preconfigured for in-memory data storage and processing. [!INCLUDEssGemini] solution packages SQL Server Books Online [!INCLUDEssDE] Configuration Tools [!INCLUDEssManStudioFull] |
| AllFeatures_WithDefaults | Installs all features that are available with the current edition. Adds the current user to the SQL Server sysadmin fixed server role. On [!INCLUDEfirstref_longhorn] or higher and when the operating system is not a domain controller, the [!INCLUDEssDE], and [!INCLUDEssRSnoversion] are defaulted to use the NTAUTHORITY\NETWORK SERVICE account, and [!INCLUDEssISnoversion] is defaulted to use the NTAUTHORITY\NETWORK SERVICE account. This role is enabled by default in editions of [!INCLUDEssExpress]. For all other editions, this role is not enabled but can be specified through the UI or with command-line parameters. |
For editions of [!INCLUDEssExpress], installs only those features available in the edition. For other editions, installs all [!INCLUDEssNoVersion] 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 [!INCLUDEssRSnoversion], but honors the AllFeatures_WithDefaults parameter to use the default service account for [!INCLUDEssRSnoversion]. When using the AllFeatures_WithDefaults parameter along with the /ADDCURRENTUSERASSQLADMIN=FALSE the provisioning dialog is not auto populated with the current user. Add /AGTSVCACCOUNT and /AGTSVCPASSWORD to specify a service account and password for the SQL Server Agent. |
To upgrade a [!INCLUDEssDEnoversion] 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 will cause a failover to an upgraded node.
To control the failover behavior of cluster nodes during the upgrade process, run the upgrade operation at 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=0 will not roll cluster ownership (move group) to upgraded nodes, and does not add this node to the list of possible owners of the SQL Server cluster at the end of upgrade.
-
/FAILOVERCLUSTERROLLOWNERSHIP=1 will roll cluster ownership (move group) to upgraded nodes, and will add this node to the list of possible owners of the SQL Server cluster at the end of upgrade.
-
/FAILOVERCLUSTERROLLOWNERSHIP=2 is the default setting. It will be used if this parameter is not specified. This setting indicates that SQL Server Setup will manage 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 is not specified on the command line, then by default Setup substitute <INSTANCEID> with the <INSTANCENAME>.