Install SQL Server from the Command Prompt

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.

NOTE: When installing through the command prompt, SQL Server 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=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 SQL Server edition to another edition of SQL Server.

  • Installing an instance of SQL Server 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.

    When you install SQL Server at the command prompt, specify Setup parameters for your installation at the command prompt as part of your installation syntax.

NOTE: For local installations, you must run Setup as an administrator. If you install SQL Server 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.

Proper Use of Setup Parameters

Use the following guidelines to develop installation commands that have correct syntax:

  • /PARAMETER

  • /PARAMETER=true/false

  • /PARAMETER=1/0 for Boolean types

  • /PARAMETER="value" for all single-value parameters. Using double quotation marks is recommended, but required if the value contains a space

  • /PARAMETER="value1" "value2" "value3" for all multiple-value parameters. Using double quotation marks is recommended, but required if the value contains a space

    Exceptions:

  • /FEATURES, which is a multivalued parameter, but its format is /FEATURES=AS,RS,IS without a space, comma-delimited

    Examples:

  • /INSTANCEDIR=c:\Path is supported.

  • /INSTANCEDIR=”c:\Path” is supported

Note
  • When installing SQL Server, 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.

    The relational server values support the additional terminating backslash formats (backslash or two backslash characters) for the path.

    • /PID, the value for this parameter should be enclosed in double quotation marks.

SQL Server Parameters

The following sections provide parameters to develop command line installation scripts for install, update, and repair scenarios.

Parameters that are listed for a SQL Server component are specific to that component. SQL Server Agent and SQL Server Browser parameters are applicable when you install the SQL Server Database Engine.

Installation Parameters

Use the parameters in the following table to develop command line scripts for installation.

SQL Server component Parameter Description
SQL Server Setup Control /ACTION

Required
Required to indicate the installation workflow.

Supported values: Install.
SQL Server Setup Control /IACCEPTSQLSERVERLICENSETERMS

Required only when the /Q or /QS parameter is specified for unattended installations.
Required to acknowledge acceptance of the license terms.
SQL Server Setup Control /IACCEPTROPENLICENSETERMS

Required only when the /Q or /QS parameter is specified for unattended installations that include either R Services (In-Database), or Microsoft R Server.
Required to acknowledge acceptance of the license terms.
SQL Server 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.
SQL Server 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.
SQL Server Setup Control /UpdateSource

Optional
Specify the location where SQL Server setup will obtain product updates. The valid values are "MU" to search Microsoft Update, a valid folder path, a relative path such as .\MyUpdates or a UNC share. By default, SQL Server setup will search Microsoft Update or a Windows Update Service through the Windows Server Update Services.
SQL Server Setup Control /CONFIGURATIONFILE

Optional
Specifies the ConfigurationFile to use.
SQL Server Setup Control /ERRORREPORTING

Optional
Has no effect in SQL Server 2016.

To manage how error feedback is sent to Microsoft, see How to configure SQL Server 2016 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
SQL Server Setup Control /FEATURES

- Or -

/ROLE

Required
Specifies the components to install.

Choose /FEATURES to specify individual SQL Server components to install. For more information, see Feature Parameters below.

Choose /ROLE to specify a setup role. Setup roles install SQL Server in a predetermined configuration.
SQL Server Setup Control /HELP, H, ?

Optional
Displays the usage options for installation parameters.
SQL Server Setup Control /INDICATEPROGRESS

Optional
Specifies that the verbose Setup log file is piped to the console.
SQL Server Setup Control /INSTALLSHAREDDIR

Optional
Specifies a nondefault installation directory for 64-bit shared components.

Default is %Program Files%\ MicrosoftSQL Server

Cannot be set to %Program Files(x86)%\ MicrosoftSQL Server
SQL Server 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)%\ MicrosoftSQL Server

Cannot be set to %Program Files%\ MicrosoftSQL Server
SQL Server Setup Control /INSTANCEDIR

Optional
Specifies a nondefault installation directory for instance-specific components.
SQL Server Setup Control /INSTANCEID

Optional
Specifies a nondefault value for an InstanceID.
SQL Server Setup Control /INSTANCENAME

Required
Specifies a SQL Server 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.
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 SQL Server instance will be used as a part of PolyBase Scale-out computational group. Supported values: True, False
SQL Server Setup Control /PID

Optional
Specifies the product key for the edition of SQL Server. If this parameter is not specified, Evaluation is used.
SQL Server Setup Control /Q

Optional
Specifies that Setup runs in a quiet mode without any user interface. This is used for unattended installations.
SQL Server Setup Control /QS

Optional
Specifies that Setup runs and shows progress through the UI, but does not accept any input or show any error messages.
SQL Server 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=INSTALL and UPGRADE parameters. Supported values:

/UIMODE=Normal is the default for non-Express editions and presents all setup dialog boxes for the selected features.

/UIMODE=AutoAdvance is the default for Express editions and skips nonessential dialog boxes.



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.
SQL Server Setup Control /SQMREPORTING

Optional
Has no effect in SQL Server 2016.

To manage how error feedback is sent to Microsoft, see How to configure SQL Server 2016 to send feedback to Microsoft.

In older versions this specifies feature usage reporting for SQL Server.

Supported values:

0=disabled

1=enabled
SQL Server 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.
SQL Server Agent /AGTSVCSTARTUPTYPE

Optional
Specifies the startup mode for the SQL Server Agent service.

Supported values:

Automatic

Disabled

Manual
Analysis Services /ASBACKUPDIR

Optional
Specifies the directory for Analysis Services backup files. Default values:

For WOW mode on 64-bit: %Program Files(x86)%\ MicrosoftSQL Server\\\OLAP\Backup.

For all other installations: %Program Files%\ MicrosoftSQL Server\\\OLAP\Backup.
Analysis Services /ASCOLLATION

Optional
Specifies the collation setting for Analysis Services.

Default value: Latin1_General_CI_AS
Analysis Services /ASCONFIGDIR

Optional
Specifies the directory for Analysis Services configuration files. Default values:

For WOW mode on 64-bit: %Program Files(x86)%\ MicrosoftSQL Server\\\OLAP\Config.

For all other installations: %Program Files%\ MicrosoftSQL Server\\\OLAP\Config.
Analysis Services /ASDATADIR

Optional
Specifies the directory for Analysis Services data files. Default values:

For WOW mode on 64-bit: %Program Files(x86)%\ MicrosoftSQL Server\\\OLAP\Data.

For all other installations: %Program Files%\ MicrosoftSQL Server\\\OLAP\Data.
Analysis Services /ASLOGDIR

Optional
Specifies the directory for Analysis Services log files. Default values:

For WOW mode on 64-bit: %Program Files(x86)%\ MicrosoftSQL Server\\\OLAP\Log.

For all other installations: %Program Files%\ MicrosoftSQL Server\\\OLAP\Log.
Analysis Services /ASSERVERMODE

Optional
Specifies the server mode of the Analysis Services 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.
Analysis Services /ASSVCACCOUNT

Required
Specifies the account for the Analysis Services service.
Analysis Services /ASSVCPASSWORD

Required
Specifies the password for the Analysis Services service.
Analysis Services /ASSVCSTARTUPTYPE

Optional
Specifies the startup mode for the Analysis Services service. Supported values:

Automatic

Disabled

Manual
Analysis Services /ASSYSADMINACCOUNTS

Required
Specifies the administrator credentials for Analysis Services.
Analysis Services /ASTEMPDIR

Optional
Specifies the directory for Analysis Services temporary files. Default values:

For WOW mode on 64-bit: %Program Files(x86)%\ MicrosoftSQL Server \\\OLAP\Temp.

For all other installations: %Program Files%\ MicrosoftSQL Server\\\OLAP\Temp.
Analysis Services /ASPROVIDERMSOLAP

Optional
Specifies whether the MSOLAP provider can run in-process.

Default value: 1=enabled
Analysis Services /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 Analysis Services instances that are installed through /ROLE = SPI_AS_NEWFARM.
Analysis Services /FARMPASSWORD

Required for SPI_AS_NewFarm
Specifies a password for the farm account.
Analysis Services /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 Analysis Services instances that are installed through /ROLE = SPI_AS_NEWFARM.
Analysis Services /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 Analysis Services 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
SQL Server Database Engine /ENABLERANU

Optional
Enables run-as credentials for SQL Server Express installations.
SQL Server Database Engine /INSTALLSQLDATADIR

Optional
Specifies the data directory for SQL Server data files. Default values:

For WOW mode on 64-bit:%Program Files(x86)%\ MicrosoftSQL Server\

For all other installations:%Program Files%\ MicrosoftSQL Server\
SQL Server Database Engine /SAPWD

Required when /SECURITYMODE=SQL
Specifies the password for the SQL Serversa account.
SQL Server Database Engine /SECURITYMODE

Optional
Specifies the security mode for SQL Server.

If this parameter is not supplied, then Windows-only authentication mode is supported.

Supported value: SQL
SQL Server Database Engine /SQLBACKUPDIR

Optional
Specifies the directory for backup files.

Default value: <InstallSQLDataDir>\ <SQLInstanceID>\MSSQL\Backup
SQL Server Database Engine /SQLCOLLATION

Optional
Specifies the collation settings for SQL Server.

The default value is based on the locale of your Windows operating system. For more information, see Collation Settings in Setup.
SQL Server Database Engine /ADDCURRENTUSERASSQLADMIN

Optional
Adds the current user to the SQL Serversysadmin 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 SQL Server Express

False for all other editions
SQL Server Database Engine /SQLSVCACCOUNT

Required
Specifies the startup account for the SQL Server service.
SQL Server Database Engine /SQLSVCPASSWORD

Required
Specifies the password for SQLSVCACCOUNT.
SQL Server Database Engine /SQLSVCSTARTUPTYPE

Optional
Specifies the startup mode for the SQL Server service. Supported values:

Automatic

Disabled

Manual
SQL Server Database Engine /SQLSYSADMINACCOUNTS

Required
Use this parameter to provision logins to be members of the sysadmin role.

For SQL Server editions other than SQL Server Express, /SQLSYSADMINACCOUNTS is required. For editions of SQL Server Express, use of /SQLSYSADMINACCOUNTS is optional, but either /SQLSYSADMINACCOUNTS or /ADDCURRENTUSERASSQLADMIN is required.
SQL Server Database Engine /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.
SQL Server Database Engine /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.
SQL Server Database Engine /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 SQL Server Express

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.
SQL Server Database Engine /SQLTEMPDBFILESIZE

Optional
Introduced in SQL Server 2016. Specifies the initial size of each tempdb data file.

Default = 4 MB for SQL Server Express, 8 MB for all other editions.

Min = (4 or 8 MB).

Max = 1024 MB (262,144 MB for SQL Server 2017)
SQL Server Database Engine /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
SQL Server Database Engine /SQLTEMPDBLOGFILESIZE

Optional
Introduced in SQL Server 2016. Specifies the initial size of each tempdb log file.

Default = 4 MB for SQL Server Express, 8 MB for all other editions.

Min = (4 or 8 MB).

Max = 1024 MB (262,144 MB for SQL Server 2017)
SQL Server Database Engine /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
SQL Server Database Engine /SQLUSERDBDIR

Optional
Specifies the directory for the data files for user databases.

Default value: <InstallSQLDataDir>\ <SQLInstanceID>\MSSQL\Data
SQL Server Database Engine /SQLSVCINSTANTFILEINIT

Optional
Enables instant file initialization for SQL Server service account. For security and performance considerations, see Database Instant File Initialization.

Default value: "False"

Optional value: "True"
SQL Server Database Engine /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 Transact-SQL access.

2=Enable FILESTREAM for Transact-SQL 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 Windows Server 2008. 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 Windows Server 2008.
Integration Services /ISSVCACCOUNT

Required
Specifies the account for Integration Services.

Default value: NT AUTHORITY\NETWORK SERVICE
Integration Services /ISSVCPASSWORD

Required
Specifies the Integration Services password.
Integration Services /ISSVCStartupType

Optional
Specifies the startup mode for the Integration Services 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
Reporting Services /RSINSTALLMODE

Optional
Specifies the Install mode for Reporting Services. Supported Values:

SharePointFilesOnlyMode

DefaultNativeMode

FilesOnlyMode



Note: If the installation includes the SQL Server Database Engine, the default RSINSTALLMODE is DefaultNativeMode.

If the installation does not include the SQL Server Database Engine, the default RSINSTALLMODE is FilesOnlyMode.

If you choose DefaultNativeMode but the installation does not include the SQL Server Database Engine, the installation will automatically change the RSINSTALLMODE to FilesOnlyMode.
Reporting Services /RSSVCACCOUNT

Required
Specifies the startup account for Reporting Services.
Reporting Services /RSSVCPASSWORD

Required
Specifies the password for the startup account for the Reporting Services service.
Reporting Services /RSSVCStartupType

Optional
Specifies the startup mode for Reporting Services.
R Services (In-Database) MRCACHEDIRECTORY Use this parameter to specify the Cache directory for Microsoft R Open and Microsoft R Server components as described in this section. This setting is typically used when installing SQL Server R Services from the command line on a computer without Internet access.
Sample Syntax:

To install a new, stand-alone instance with the SQL Server Database Engine, Replication, and Full-Text Search components and enable instant file initialization for SQL Server Database Engine.


Setup.exe /q /ACTION=Install /FEATURES=SQL /INSTANCENAME=MSSQLSERVER /SQLSVCACCOUNT="<DomainName\UserName>" /SQLSVCPASSWORD="<StrongPassword>" /SQLSYSADMINACCOUNTS="<DomainName\UserName>" /AGTSVCACCOUNT="NT AUTHORITY\Network Service" /SQLSVCINSTANTFILEINIT="True" /IACCEPTSQLSERVERLICENSETERMS  

SysPrep Parameters

For more information about SQL Server SysPrep, see

Install SQL Server 2016 Using SysPrep.

Prepare Image Parameters

Use the parameters in the following table to develop command-line scripts for preparing an instance of SQL Server without configuring it.

SQL Server component Parameter Description
SQL Server Setup Control /ACTION

Required
Required to indicate the installation workflow.

Supported values: PrepareImage
SQL ServerSetup Control /IACCEPTSQLSERVERLICENSETERMS

Required only when the /Q or /QS parameter is specified for unattended installations.
Required to acknowledge acceptance of the license terms.
SQL Server 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.
SQL Server 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.
SQL Server Setup Control /UpdateSource

Optional
Specify the location where SQL Server setup will obtain product updates. The valid values are "MU" to search Microsoft Update, a valid folder path, a relative path such as .\MyUpdates or a UNC share. By default, SQL Server setup will search Microsoft Update or a Windows Update Service through the Windows Server Update Services.
SQL Server Setup Control /CONFIGURATIONFILE

Optional
Specifies the ConfigurationFile to use.
SQL Server 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
SQL Server Setup Control /HELP, H, ?

Optional
Displays the usage options for installation parameters.
SQL Server Setup Control /HIDECONSOLE

Optional
Specifies that the console window is hidden or closed.
SQL Server Setup Control /INDICATEPROGRESS

Optional
Specifies that the verbose Setup log file is piped to the console.
SQL Server Setup Control /INSTALLSHAREDDIR

Optional
Specifies a nondefault installation directory for 64-bit shared components.

Default is %Program Files%\ MicrosoftSQL Server

Cannot be set to %Program Files(x86)%\ MicrosoftSQL Server
SQL Server Setup Control /INSTANCEDIR

Optional
Specifies a nondefault installation directory for instance-specific components.
SQL Server Setup Control /INSTANCEID

Prior to SQL Server 2012 Service Pack 1 Cumulative Update 2 (January 2013) Required

Beginning with SQL Server 2012 Service Pack 1 Cumulative Update 2 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.
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 SQL Server instance will be used as a part of PolyBase Scale-out computational group. Supported values: True, False
SQL Server Setup Control /Q

Optional
Specifies that Setup runs in a quiet mode without any user interface. This is used for unattended installations.
SQL Server Setup Control /QS

Optional
Specifies that Setup runs and shows progress through the UI, but does not accept any input or show any error messages.
Sample Syntax:

To prepare a new, stand-alone instance with the SQL Server Database Engine, Replication, and Full-Text Search components, and Reporting Services.

Setup.exe /q /ACTION=PrepareImage /FEATURES=SQL,RS /InstanceID =<MYINST> /IACCEPTSQLSERVERLICENSETERMS  

Complete Image Parameters

Use the parameters in the following table to develop command-line scripts for completing and configuring a prepared instance of SQL Server.

SQL Server component Parameter Description
SQL Server Setup Control /ACTION

Required
Required to indicate the installation workflow.

Supported values: CompleteImage
SQL Server Setup Control /IACCEPTSQLSERVERLICENSETERMS

Required only when the /Q or /QS parameter is specified for unattended installations.
Required to acknowledge acceptance of the license terms.
SQL Server 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.
SQL Server Setup Control /CONFIGURATIONFILE

Optional
Specifies the ConfigurationFile to use.
SQL Server Setup Control /ERRORREPORTING

Optional
Has no effect in SQL Server 2016.

To manage how error feedback is sent to Microsoft, see How to configure SQL Server 2016 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:

1=enabled

0=disabled
SQL Server Setup Control /HELP, H, ?

Optional
Displays the usage options for installation parameters.
SQL Server Setup Control /INDICATEPROGRESS

Optional
Specifies that the verbose Setup log file is piped to the console.
SQL Server Setup Control /INSTANCEID

Prior to SQL Server 2012 Service Pack 1 Cumulative Update 2 (January 2013) Required

Beginning with SQL Server 2012 Service Pack 1 Cumulative Update 2 Optional
Use the Instance ID specified during the prepare image step.

Supported Values: InstanceID of a Prepared Instance.
SQL Server Setup Control /INSTANCENAME

Prior to SQL Server 2012 Service Pack 1 Cumulative Update 2 (January 2013) Required

Beginning with SQL Server 2012 Service Pack 1 Cumulative Update 2 Optional
Specifies a SQL Server 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.
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 SQL Server instance will be used as a part of PolyBase Scale-out computational group. Supported values: True, False
SQL Server Setup Control /PID

Optional
Specifies the product key for the edition of SQL Server. If this parameter is not specified, Evaluation is used.

Note: If you are installing SQL Server Express, SQL Server Express with tools, or SQL Server Express with Advanced Services, the PID is predefined.
SQL Server Setup Control /Q

Optional
Specifies that Setup runs in a quiet mode without any user interface. This is used for unattended installations.
SQL Server Setup Control /QS

Optional
Specifies that Setup runs and shows progress through the UI, but does not accept any input or show any error messages.
SQL Server Setup Control /SQMREPORTING

Optional
Has no effect in SQL Server 2016.

To manage how error feedback is sent to Microsoft, see How to configure SQL Server 2016 to send feedback to Microsoft.

In older versions this specifies feature usage reporting for SQL Server.

Supported values:

0=disabled

1=enabled
SQL Server 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.
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
SQL Server Database Engine /ENABLERANU

Optional
Enables run-as credentials for SQL Server Express installations.
SQL Server Database Engine /INSTALLSQLDATADIR

Optional
Specifies the data directory for SQL Server data files. Default values:

For WOW mode on 64-bit:%Program Files(x86)%\ MicrosoftSQL Server\

For all other installations: %Program Files%\ MicrosoftSQL Server\
SQL Server Database Engine /SAPWD

Required when /SECURITYMODE=SQL
Specifies the password for the SQL Serversa account.
SQL Server Database Engine /SECURITYMODE

Optional
Specifies the security mode for SQL Server.

If this parameter is not supplied, then Windows-only authentication mode is supported.

Supported value: SQL
SQL Server Database Engine /SQLBACKUPDIR

Optional
Specifies the directory for backup files.

Default value:

<InstallSQLDataDir>\ <SQLInstanceID>\MSSQL\Backup
SQL Server Database Engine /SQLCOLLATION

Optional
Specifies the collation settings for SQL Server.

The default value is based on the locale of your Windows operating system. For more information, see Collation Settings in Setup.
SQL Server Database Engine /SQLSVCACCOUNT

Required
Specifies the startup account for the SQL Server service.
SQL Server Database Engine /SQLSVCPASSWORD

Required
Specifies the password for SQLSVCACCOUNT.
SQL Server Database Engine /SQLSVCSTARTUPTYPE

Optional
Specifies the startup mode for the SQL Server service. Supported values:

Automatic

Disabled

Manual
SQL Server Database Engine /SQLSYSADMINACCOUNTS

Required
Use this parameter to provision logins to be members of the sysadmin role.
SQL Server Database Engine /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.
SQL Server Database Engine /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.
SQL Server Database Engine /SQLTEMPDBFILESIZE

Optional
Introduced in SQL Server 2016. Specifies the initial size of each tempdb data file.

Default = 4 MB for SQL Server Express, 8 MB for all other editions.

Min = (4 or 8 MB).

Max = 1024 MB (262,144 MB for SQL Server 2017).
SQL Server Database Engine /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
SQL Server Database Engine /SQLTEMPDBLOGFILESIZE

Optional
Specifies the initial size of the tempdb log file in MB. Setup allows the size up to 1024.

Default value:

4 for SQL Server Express

8 for all other editions

Allowed range: Min = default value (4 or 8), Max = 1024
SQL Server Database Engine /SQLTEMPDBLOGFILEGROWTH

Optional
Introduced in SQL Server 2016. Specifies the initial size of each tempdb log file.

Default = 4 MB for SQL Server Express, 8 MB for all other editions.

Min = (4 or 8 MB).

Max = 1024 MB (262,144 MB for SQL Server 2017)
SQL Server Database Engine /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 SQL Server Express

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 *\* SQL Server Expressis not supported for configuring this parameter. Setup installs only 1 tempdb data file.
SQL Server Database Engine /SQLUSERDBDIR

Optional
Specifies the directory for the data files for user databases.

Default value: <InstallSQLDataDir>\ <SQLInstanceID>\MSSQL\Data
SQL Server Database Engine /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 Transact-SQL access.

2=Enable FILESTREAM for Transact-SQL 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 Windows Server 2008. 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 Windows Server 2008.
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
Reporting Services /RSINSTALLMODE

Optional
Specifies the Install mode for Reporting Services.
Reporting Services /RSSVCACCOUNT

Required
Specifies the startup account for Reporting Services.
Reporting Services /RSSVCPASSWORD

Required
Specifies the password for the startup account for the Reporting Services service.
Reporting Services /RSSVCStartupType

Optional
Specifies the startup mode for Reporting Services.
Sample Syntax:

To complete a prepared, stand-alone instance that includes SQL Server Database Engine, Replication, and Full-Text Search components.


setup.exe /q /ACTION=CompleteImage /INSTANCENAME=MYNEWINST /INSTANCEID=<MYINST> /SQLSVCACCOUNT="<DomainName\UserName>" /SQLSVCPASSWORD="<StrongPassword>" /SQLSYSADMINACCOUNTS="<DomainName\UserName>" /AGTSVCACCOUNT="NT AUTHORITY\Network Service" /IACCEPTSQLSERVERLICENSETERMS  

Upgrade Parameters

Use the parameters in the following table to develop command-line scripts for upgrade.

SQL Server component Parameter Description
SQL Server 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 SQL Server 2017 to a different edition. For more information about the supported version and edition upgrades, see Supported Version and Edition Upgrades.
SQL Server Setup Control /IACCEPTSQLSERVERLICENSETERMS

Required only when the /Q or /QS parameter is specified for unattended installations.
Required to acknowledge acceptance of the license terms.
SQL Server 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.
SQL Server 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.
SQL Server Setup Control /UpdateSource

Optional
Specify the location where SQL Server setup will obtain product updates. The valid values are "MU" to search Microsoft Update, a valid folder path, a relative path such as .\MyUpdates or a UNC share. By default, SQL Server setup will search Microsoft Update or a Windows Update Service through the Windows Server Update Services.
SQL Server Setup Control /CONFIGURATIONFILE

Optional
Specifies the ConfigurationFile to use.
SQL Server Setup Control /ERRORREPORTING

Optional
Has no effect in SQL Server 2016.

To manage how error feedback is sent to Microsoft, see How to configure SQL Server 2016 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:

1=enabled

0=disabled
SQL Server Setup Control /HELP, H, ?

Optional
Displays the usage options for the parameters.
SQL Server Setup Control /INDICATEPROGRESS

Optional
Specifies that the verbose Setup log file will be piped to the console.
SQL Server Setup Control / INSTANCEDIR

Optional
Specifies a nondefault installation directory for shared components.
SQL Server Setup Control /INSTANCEID

Required when you upgrade from SQL Server 2008 or later.

Optional when you upgrade from SQL Server 2005
Specifies a nondefault value for an InstanceID.
SQL Server Setup Control /INSTANCENAME

Required
Specifies a SQL Server instance name.

For more information, see Instance Configuration.
SQL Server Setup Control /PID

Optional
Specifies the product key for the edition of SQL Server. If this parameter is not specified, Evaluation is used.
SQL Server Setup Control /Q

Optional
Specifies that Setup runs in a quiet mode without any user interface. This is used for unattended installations.
SQL Server 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=INSTALL and UPGRADE parameters. Supported values:

/UIMODE=Normal is the default for non-Express editions and presents all setup dialog boxes for the selected features.

/UIMODE=AutoAdvance is the default for Express editions and skips nonessential dialog boxes.

Note that the UIMode setting cannot be used with the /Q or /QS parameters.
SQL Server Setup Control /SQMREPORTING

Optional
Has no effect in SQL Server 2016.

To manage how error feedback is sent to Microsoft, see How to configure SQL Server 2016 to send feedback to Microsoft.

In older versions this specifies feature usage reporting for SQL Server.

Supported values:

1=enabled

0=disabled
SQL Server 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
Integration Services /ISSVCACCOUNT

Required
Specifies the account for Integration Services.

Default value: NT AUTHORITY\NETWORK SERVICE
Integration Services /ISSVCPASSWORD

Required
Specifies the Integration Services password.
Integration Services /ISSVCStartupType

Optional
Specifies the startup mode for the Integration Services service.
Reporting Services /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 SQL Server 2012 Reporting Services. 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.
Reporting Services /RSUPGRADEPASSWORD

Optional
Password of the existing Report Server service account.
Reporting Services /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 Reporting Services.
Sample Syntax:

To upgrade an existing instance or failover cluster node from a previous SQL Server version,

Setup.exe /q /ACTION=upgrade /INSTANCEID = <INSTANCEID>/INSTANCENAME=MSSQLSERVER /RSUPGRADEDATABASEACCOUNT="<Provide a SQL Server logon account that can connect to the report server during upgrade>" /RSUPGRADEPASSWORD="<Provide a password for the report server upgrade account>" /ISSVCAccount="NT Authority\Network Service" /IACCEPTSQLSERVERLICENSETERMS  

Repair Parameters

Use the parameters in the following table to develop command-line scripts for repair.

SQL Server component Parameter Description
SQL Server Setup Control /ACTION

Required
Required to indicate the repair workflow.

Supported values: Repair
SQL Server 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.
SQL Server Setup Control /FEATURES

Required
Specifies components to repair.
SQL Server Setup Control /INSTANCENAME

Required
Specifies a SQL Server 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.
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 SQL Server instance will be used as a part of PolyBase Scale-out computational group. Supported values: True, False
SQL Server Setup Control /Q

Optional
Specifies that Setup runs in a quiet mode without any user interface. This is used for unattended installations.
SQL Server Setup Control /HIDECONSOLE

Optional
Specifies that the console window is hidden or closed.
Sample Syntax:

Repair an instance and shared components.

Setup.exe /q /ACTION=Repair /INSTANCENAME=<instancename>  

Rebuild System Database Parameters

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.

SQL Server component Parameter Description
SQL Server Setup Control /ACTION

Required
Required to indicate the rebuild database workflow.

Supported values: Rebuilddatabase
SQL Server Setup Control /INSTANCENAME

Required
Specifies a SQL Server instance name.

For more information, see Instance Configuration.
SQL Server Setup Control /Q

Optional
Specifies that Setup runs in a quiet mode without any user interface. This is used for unattended installations.
SQL Server Database Engine /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.
SQL Server Database Engine /SAPWD

Required when /SECURITYMODE=SQL was specified during Installation of the Instance.
Specifies the password for SQL SA account.
SQL Server Database Engine /SQLSYSADMINACCOUNTS

Required
Use this parameter to provision logins to be members of the sysadmin role.
SQL Server Database Engine /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.
SQL Server Database Engine /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.
SQL Server Database Engine /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 SQL Server Express

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 *\* SQL Server Expressis not supported for configuring this parameter. Setup installs only 1 tempdb data file.
SQL Server Database Engine /SQLTEMPDBFILESIZE

Optional
Introduced in SQL Server 2016. Specifies the initial size of each tempdb data file.

Default = 4 MB for SQL Server Express, 8 MB for all other editions.

Min = (4 or 8 MB).

Max = 1024 MB (262,144 MB for SQL Server 2017).
SQL Server Database Engine /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
SQL Server Database Engine /SQLTEMPDBLOGFILESIZE

Optional
Specifies the initial size of the tempdb log file in MB. Setup allows the size up to 1024. Default value:

4 for SQL Server Express

8 for all other editions

Allowed range: Min = default value (4 or 8), Max = 1024
SQL Server Database Engine /SQLTEMPDBLOGFILEGROWTH

Optional
Introduced in SQL Server 2016. Specifies the initial size of each tempdb log file.

Default = 4 MB for SQL Server Express, 8 MB for all other editions.

Min = (4 or 8 MB).

Max = 1024 MB (262,144 MB for SQL Server 2017)

Uninstall Parameters

Use the parameters in the following table to develop command-line scripts for uninstallation.

SQL Server component Parameter Description
SQL Server Setup Control /ACTION

Required
Required to indicate the uninstall work flow.

Supported values: Uninstall
SQL Server Setup Control /CONFIGURATIONFILE

Optional
Specifies the ConfigurationFile to use.
SQL Server Setup Control /FEATURES

Required
Specifies components to uninstall.
SQL Server Setup Control /HELP, H, ?

Optional
Displays the usage options for the parameters.
SQL Server Setup Control /INDICATEPROGRESS

Optional
Specifies that the verbose Setup log file will be piped to the console.
SQL Server Setup Control /INSTANCENAME

Required
Specifies a SQL Server instance name.

For more information, see Instance Configuration.
SQL Server Setup Control /Q

Optional
Specifies that Setup runs in a quiet mode without any user interface. This is used for unattended installations.
SQL Server Setup Control /HIDECONSOLE

Optional
Specifies that the console window is hidden or closed.
Sample Syntax:

To uninstall an existing instance of SQL Server.

Setup.exe /Action=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 topic.

Failover Cluster Parameters

Before you install a SQL Server failover cluster instance, review the following topics:

Integrated Install Failover Cluster Parameters

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.

SQL Server component Parameter Details
SQL Server Setup Control /ACTION

Required
Required to indicate the failover cluster installation work flow.

Supported value: InstallFailoverCluster
SQL Server Setup Control /IACCEPTSQLSERVERLICENSETERMS

Required only when the /Q or /QS parameter is specified for unattended installations.
Required to acknowledge acceptance of the license terms.
SQL Server 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.
SQL Server Setup Control /FAILOVERCLUSTERGROUP

Optional
Specifies the name of the resource group to be used for the SQL Server 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.
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 SQL Server instance will be used as a part of PolyBase Scale-out computational group. Supported values: True, False
SQL Server 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.
SQL Server Setup Control /UpdateSource

Optional
Specify the location where SQL Server setup will obtain product updates. The valid values are "MU" to search Microsoft Update, a valid folder path, a relative path such as .\MyUpdates or a UNC share. By default, SQL Server setup will search Microsoft Update or a Windows Update Service through the Windows Server Update Services.
SQL Server Setup Control /CONFIGURATIONFILE

Optional
Specifies the ConfigurationFile to use.
SQL Server Setup Control /ERRORREPORTING

Optional
Has no effect in SQL Server 2016.

To manage how error feedback is sent to Microsoft, see How to configure SQL Server 2016 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:

1=enabled

0=disabled
SQL Server Setup Control /FEATURES

Required
Specifies components to install.
SQL Server Setup Control /HELP, H, ?

Optional
Displays the usage options for the parameters.
SQL Server Setup Control /INDICATEPROGRESS

Optional
Specifies that the verbose Setup log file will be piped to the console.
SQL Server Setup Control /INSTALLSHAREDDIR

Optional
Specifies a nondefault installation directory for 64-bit shared components.

Default is %Program Files%\ MicrosoftSQL Server

Cannot be set to %Program Files(x86)%\ MicrosoftSQL Server
SQL Server 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)%\ MicrosoftSQL Server

Cannot be set to %Program Files%\ MicrosoftSQL Server
SQL Server Setup Control /INSTANCEDIR

Optional
Specifies nondefault installation directory for instance-specific components.
SQL Server Setup Control /INSTANCEID

Optional
Specifies a nondefault value for an InstanceID.
SQL Server Setup Control /INSTANCENAME

Required
Specifies a SQL Server instance name.

For more information, see Instance Configuration.
SQL Server Setup Control /PID

Optional
Specifies the product key for the edition of SQL Server. If this parameter is not specified, Evaluation is used.
SQL Server Setup Control /Q

Optional
Specifies that Setup runs in a quiet mode without any user interface. This is used for unattended installations.
SQL Server Setup Control /QS

Optional
Specifies that Setup runs and shows progress through the UI, but does not accept any input or show any error messages.
SQL Server Setup Control /SQMREPORTING

Optional
Has no effect in SQL Server 2016.

To manage how error feedback is sent to Microsoft, see How to configure SQL Server 2016 to send feedback to Microsoft.

In older versions this specifies feature usage reporting for SQL Server.

Supported values:

1=enabled

0=disabled
SQL Server Setup Control /HIDECONSOLE

Optional
Specifies the console window would be hidden or closed.
SQL Server Setup Control /FAILOVERCLUSTERDISKS

Optional
Specifies the list of shared disks to be included in the SQL Server failover cluster resource group.

Default value: The first drive is used as the default drive for all databases.
SQL Server 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=DEFAULT

FAILOVERCLUSTERIPADDRESSES=IPv4;DHCP;ClusterNetwork1

FAILOVERCLUSTERIPADDRESSES=IPv4;172.16.0.0;ClusterNetwork1;172.31.255.255

FAILOVERCLUSTERIPADDRESSES=IPv6;DHCP;ClusterNetwork1

FAILOVERCLUSTERIPADDRESSES=IPv6;2001:db8:23:1002:20f:1fff:feff:b3a3;ClusterNetwork1
SQL Server Setup Control /FAILOVERCLUSTERNETWORKNAME

Required
Specifies the network name for the new SQL Server failover cluster. This name is used to identify the new SQL Server 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.
Analysis Services /ASBACKUPDIR

Optional
Specifies the directory for Analysis Services backup files. Default values:

For WOW mode on 64-bit: %Program Files(x86)%\ MicrosoftSQL Server\\\OLAP\Backup.

For all other installations:%Program Files%\ MicrosoftSQL Server\\\OLAP\Backup.
Analysis Services /ASCOLLATION

Optional
Specifies the collation setting for Analysis Services.

Default value: Latin1_General_CI_AS
Analysis Services /ASCONFIGDIR

Optional
Specifies the directory for Analysis Services configuration files. Default values:

For WOW mode on 64-bit: %Program Files(x86)%\ MicrosoftSQL Server\\\OLAP\Config.

For all other installations: %Program Files%\ MicrosoftSQL Server\\\OLAP\Config.
Analysis Services /ASDATADIR

Optional
Specifies the directory for Analysis Services data files. Default values:

For WOW mode on 64-bit: %Program Files(x86)%\ MicrosoftSQL Server\\\OLAP\Data.

For all other installations: %Program Files%\ MicrosoftSQL Server\\\OLAP\Data.
Analysis Services /ASLOGDIR

Optional
Specifies the directory for Analysis Services log files. Default values:

For WOW mode on 64-bit: %Program Files(x86)%\ MicrosoftSQL Server\\\OLAP\Log.

For all other installations: %Program Files%\ MicrosoftSQL Server\\\OLAP\Log.
Analysis Services /ASSYSADMINACCOUNTS

Required
Specifies the administrator credentials for Analysis Services.
Analysis Services /ASTEMPDIR

Optional
Specifies the directory for Analysis Services temporary files. Default values:

For WOW mode on 64-bit: %Program Files(x86)%\ MicrosoftSQL Server\\\OLAP\Temp.

For all other installations: %Program Files%\ MicrosoftSQL Server\\\OLAP\Temp.
Analysis Services /ASPROVIDERMSOLAP

Optional
Specifies whether the MSOLAP provider can run in-process.

Default value: 1=enabled
Analysis Services /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.
SQL Server Database Engine /INSTALLSQLDATADIR

Required
Specifies the data directory for SQL Server data files.

The data directory must to specified and on a shared cluster disk.
SQL Server Database Engine /SAPWD

Required when /SECURITYMODE=SQL
Specifies the password for the SQL Serversa account.
SQL Server Database Engine /SECURITYMODE

Optional
Specifies the security mode for SQL Server.

If this parameter is not supplied, then Windows-only authentication mode is supported.

Supported value: SQL
SQL Server Database Engine /SQLBACKUPDIR

Optional
Specifies the directory for backup files.

Default value: <InstallSQLDataDir>\ <SQLInstanceID>\MSSQL\Backup.
SQL Server Database Engine /SQLCOLLATION

Optional
Specifies the collation settings for SQL Server.

The default value is based on the locale of your Windows operating system. For more information, see Collation Settings in Setup.
SQL Server Database Engine /SQLSVCACCOUNT

Required
Specifies the startup account for the SQL Server service.
SQL Server Database Engine /SQLSVCPASSWORD

Required
Specifies the password for SQLSVCACCOUNT.
SQL Server Database Engine /SQLSYSADMINACCOUNTS

Required
Use this parameter to provision logins to be members of the sysadmin role.
SQL Server Database Engine /SQLUSERDBDIR

Optional
Specifies the directory for the data files for user databases.

Default value: <InstallSQLDataDir>\ <SQLInstanceID>\MSSQL\Data
SQL Server Database Engine /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.
SQL Server Database Engine /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.
SQL Server Database Engine /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 SQL Server Express

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 *\* SQL Server Expressis not supported for configuring this parameter. Setup installs only 1 tempdb data file.
SQL Server Database Engine /SQLTEMPDBFILESIZE

Optional
Introduced in SQL Server 2016. Specifies the initial size of each tempdb data file.

Default = 8 MB.

Min = 8 MB.

Max = 1024 MB (262,144 MB for SQL Server 2017).
SQL Server Database Engine /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
SQL Server Database Engine /SQLTEMPDBLOGFILESIZE

Optional
Specifies the initial size of the tempdb log file in MB. Setup allows the size up to 1024.
Default value:

4 for SQL Server Express

8 for all other editions

Allowed range: Min = default value (4 or 8), Max = 1024
SQL Server Database Engine /SQLTEMPDBLOGFILEGROWTH

Optional
Introduced in SQL Server 2016. Specifies the initial size of each tempdb log file.

Default = 4 MB for SQL Server Express, 8 MB for all other editions.

Min = (4 or 8 MB).

Max = 1024 MB (262,144 MB for SQL Server 2017)
SQL Server Database Engine /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 Transact-SQL access.

2=Enable FILESTREAM for Transact-SQL 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

Requiredwhen 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 Windows Server 2008. 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 Windows Server 2008.
Integration Services /ISSVCACCOUNT

Required
Specifies the account for Integration Services.

Default value: NT AUTHORITY\NETWORK SERVICE
Integration Services /ISSVCPASSWORD

Required
Specifies the Integration Services password.
Integration Services /ISSVCStartupType

Optional
Specifies the startup mode for the Integration Services service.
Reporting Services /RSINSTALLMODE

Optional
Specifies the Install mode for Reporting Services.
Reporting Services /RSSVCACCOUNT

Required
Specifies the startup account for Reporting Services.
Reporting Services /RSSVCPASSWORD

Required
Specifies the password for the startup account for Reporting Services service.
Reporting Services /RSSVCStartupType

Optional
Specifies the startup mode for Reporting Services.

We recommend that you use Service SID instead of domain groups.

Additional Notes:

The Database Engine and Analysis Services are the only components that are cluster-aware. Other features are not cluster-aware and do not have high availability through failover.

Sample Syntax:

To install a single-node SQL Server failover cluster instance with the Database Engine and Analysis Services, default instance.

setup.exe /q /ACTION=InstallFailoverCluster /InstanceName=MSSQLSERVER /INDICATEPROGRESS /ASSYSADMINACCOUNTS="<DomainName\UserName>" /ASDATADIR=<Drive>:\OLAP\Data /ASLOGDIR=<Drive>:\OLAP\Log /ASBACKUPDIR=<Drive>:\OLAP\Backup /ASCONFIGDIR=<Drive>:\OLAP\Config /ASTEMPDIR=<Drive>:\OLAP\Temp /FAILOVERCLUSTERDISKS="<Cluster Disk Resource Name - for example, 'Disk S:'" /FAILOVERCLUSTERNETWORKNAME="<Insert Network Name>" /FAILOVERCLUSTERIPADDRESSES="IPv4;xx.xxx.xx.xx;Cluster Network;xxx.xxx.xxx.x" /FAILOVERCLUSTERGROUP="MSSQLSERVER" /Features=AS,SQL /ASSVCACCOUNT="<DomainName\UserName>" /ASSVCPASSWORD="xxxxxxxxxxx" /AGTSVCACCOUNT="<DomainName\UserName>" /AGTSVCPASSWORD="xxxxxxxxxxx" /INSTALLSQLDATADIR="<Drive>:\<Path>\MSSQLSERVER" /SQLCOLLATION="SQL_Latin1_General_CP1_CS_AS" /SQLSVCACCOUNT="<DomainName\UserName>" /SQLSVCPASSWORD="xxxxxxxxxxx" /SQLSYSADMINACCOUNTS="<DomainName\UserName> /IACCEPTSQLSERVERLICENSETERMS  

Prepare Failover Cluster Parameters

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).

SQL Server component Parameter Description
SQL Server Setup Control /ACTION

Required
Required to indicate the failover cluster prepare work flow.

Supported value: PrepareFailoverCluster
SQL Server Setup Control /IACCEPTSQLSERVERLICENSETERMS

Required only when the /Q or /QS parameter is specified for unattended installations.
Required to acknowledge acceptance of the license terms.
SQL Server 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.
SQL Server 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.
SQL Server Setup Control /UpdateSource

Optional
Specify the location where SQL Server setup will obtain product updates. The valid values are "MU" to search Microsoft Update, a valid folder path, a relative path such as .\MyUpdates or a UNC share. By default, SQL Server setup will search Microsoft Update or a Windows Update Service through the Windows Server Update Services.
SQL Server Setup Control /CONFIGURATIONFILE

Optional
Specifies the ConfigurationFile to use.
SQL Server Setup Control /ERRORREPORTING

Optional
Has no effect in SQL Server 2016.

To manage how error feedback is sent to Microsoft, see How to configure SQL Server 2016 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
SQL Server Setup Control /FEATURES

Required
Specifies components to install.
SQL Server Setup Control /HELP, H, ?

Optional
Displays the usage options for the parameters.
SQL Server Setup Control /INDICATEPROGRESS

Optional
Specifies that the verbose Setup log file will be piped to the console.
SQL Server Setup Control /INSTALLSHAREDDIR

Optional
Specifies a nondefault installation directory for 64-bit shared components.

Default is %Program Files%\ MicrosoftSQL Server

Cannot be set to %Program Files(x86)%\ MicrosoftSQL Server
SQL Server 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)%\ MicrosoftSQL Server

Cannot be set to %Program Files%\ MicrosoftSQL Server
SQL Server Setup Control /INSTANCEDIR

Optional
Specifies nondefault installation directory for instance specific components.
SQL Server Setup Control /INSTANCEID

Optional
Specifies a nondefault value for an InstanceID.
SQL Server Setup Control /INSTANCENAME

Required
Specifies a SQL Server 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.
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 SQL Server instance will be used as a part of PolyBase Scale-out computational group. Supported values: True, False
SQL Server Setup Control /PID

Optional
Specifies the product key for the edition of SQL Server. If this parameter is not specified,

Evaluation is used.
SQL Server Setup Control /Q

Optional
Specifies that Setup runs in a quiet mode without any user interface. This is used for unattended installations.
SQL Server Setup Control /QS

Optional
Specifies that Setup runs and shows progress through the UI, but does not accept any input or show any error messages.
SQL Server Setup Control /SQMREPORTING

Optional
Has no effect in SQL Server 2016.

To manage how error feedback is sent to Microsoft, see How to configure SQL Server 2016 to send feedback to Microsoft.

In older versions this specifies feature usage reporting for SQL Server.

Supported values:

0=disabled

1=enabled
SQL Server 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.
Analysis Services /ASSVCACCOUNT

Required
Specifies the account for the Analysis Services service.
Analysis Services /ASSVCPASSWORD

Required
Specifies the password for the Analysis Services service.
SQL Server Database Engine /SQLSVCACCOUNT

Required
Specifies the startup account for the SQL Server service.
SQL Server Database Engine /SQLSVCPASSWORD

Required
Specifies the password for SQLSVCACCOUNT.
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 Transact-SQL access.

2=Enable FILESTREAM for Transact-SQL 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 Windows Server 2008. 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 Windows Server 2008.
Integration Services /ISSVCACCOUNT

Required
Specifies the account for Integration Services.

Default value: NT AUTHORITY\NETWORK SERVICE
Integration Services /ISSVCPASSWORD

Required
Specifies the Integration Services password.
Integration Services /ISSVCStartupType

Optional
Specifies the startup mode for the Integration Services service.
Reporting Services /RSINSTALLMODE

Available only on Files only mode.
Specifies the Install mode for Reporting Services.
Reporting Services /RSSVCACCOUNT

Required
Specifies the startup account for Reporting Services.
Reporting Services /RSSVCPASSWORD

Required
Specifies the password for the startup account for Reporting Services service.
Reporting Services /RSSVCStartupType

Optional
Specifies the startup mode for Reporting Services.

We recommend that you use Service SID instead of domain groups.

Sample Syntax:

To perform the "Preparation" step of a failover cluster advanced installation scenario for the Database Engine and Analysis Services.

Run the following command at the command prompt to prepare a default instance:

setup.exe /q /ACTION=PrepareFailoverCluster /InstanceName=MSSQLSERVER /Features=AS,SQL /INDICATEPROGRESS /ASSVCACCOUNT="<DomainName\UserName>" /ASSVCPASSWORD="xxxxxxxxxxx" /SQLSVCACCOUNT="<DomainName\UserName>" /SQLSVCPASSWORD="xxxxxxxxxxx" /AGTSVCACCOUNT="<DomainName\UserName>" /AGTSVCPASSWORD="xxxxxxxxxxx" /IACCEPTSQLSERVERLICENSETERMS  

Run the following command at the command prompt to prepare a named instance:

setup.exe /q /ACTION=PrepareFailoverCluster /InstanceName="<Insert Instance name>" /Features=AS,SQL /INDICATEPROGRESS /ASSVCACCOUNT="<DomainName\UserName>" /ASSVCPASSWORD="xxxxxxxxxxx" /SQLSVCACCOUNT="<DomainName\UserName>" /SQLSVCPASSWORD="xxxxxxxxxxx" /AGTSVCACCOUNT="<DomainName\UserName>" /AGTSVCPASSWORD="xxxxxxxxxxx" /IACCEPTSQLSERVERLICENSETERMS  

Complete Failover Cluster Parameters

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).

SQL Server component Parameter Description
SQL Server Setup Control /ACTION

Required
Required to indicate the failover cluster complete work flow.

Supported value: CompleteFailoverCluster
SQL Server 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.
SQL Server Setup Control /FAILOVERCLUSTERGROUP

Optional
Specifies the name of the resource group to be used for the SQL Server 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>)
SQL Server Setup Control /CONFIGURATIONFILE

Optional
Specifies the ConfigurationFile to use.
SQL Server Setup Control /ERRORREPORTING

Optional
Has no effect in SQL Server 2016.

To manage how error feedback is sent to Microsoft, see How to configure SQL Server 2016 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:

1=enabled

0=disabled
SQL Server Setup Control /HELP, H, ?

Optional
Displays the usage options for the parameters.
SQL Server Setup Control /INDICATEPROGRESS

Optional
Specifies that the verbose Setup log file will be piped to the console.
SQL Server Setup Control /INSTANCENAME

Required
Specifies a SQL Server instance name.

For more information, see Instance Configuration.
SQL Server Setup Control /PID

Optional
Specifies the product key for the edition of SQL Server. If this parameter is not specified, Evaluation is used.
SQL Server Setup Control /Q

Optional
Specifies that Setup runs in a quiet mode without any user interface. This is used for unattended installations.
SQL Server Setup Control /QS

Optional
Specifies that Setup runs and shows progress through the UI, but does not accept any input or show any error messages.
SQL Server Setup Control /SQMREPORTING

Optional
Has no effect in SQL Server 2016.

To manage how error feedback is sent to Microsoft, see How to configure SQL Server 2016 to send feedback to Microsoft.

In older versions this specifies feature usage reporting for SQL Server.

Supported values:

1=enabled

0=disabled
SQL Server Setup Control /HIDECONSOLE

Optional
Specifies that the console window is hidden or closed.
SQL Server Setup Control /FAILOVERCLUSTERDISKS

Optional
Specifies the list of shared disks to be included in the SQL Server failover cluster resource group.

Default value:

The first drive is used as the default drive for all databases.
SQL Server 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=DEFAULT

FAILOVERCLUSTERIPADDRESSES=IPv4;DHCP;ClusterNetwork1

FAILOVERCLUSTERIPADDRESSES=IPv4;172.16.0.0;ClusterNetwork1;172.31.255.255

FAILOVERCLUSTERIPADDRESSES=IPv6;DHCP;ClusterNetwork1

FAILOVERCLUSTERIPADDRESSES=IPv6;2001:db8:23:1002:20f:1fff:feff:b3a3;ClusterNetwork1
SQL Server Setup Control /FAILOVERCLUSTERNETWORKNAME

Required
Specifies the network name for the new SQL Server failover cluster. This name is used to identify the new SQL Server failover cluster instance on the network.
SQL Server 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
Analysis Services /ASBACKUPDIR

Optional
Specifies the directory for Analysis Services backup files. Default values:

For WOW mode on 64-bit: %Program Files(x86)%\ MicrosoftSQL Server\\\OLAP\Backup.

For all other installations:%Program Files%\ MicrosoftSQL Server\\\OLAP\Backup.
Analysis Services /ASCOLLATION

Optional
Specifies the collation setting for Analysis Services.

Default value: Latin1_General_CI_AS
Analysis Services /ASCONFIGDIR

Optional
Specifies the directory for Analysis Services configuration files. Default values:

For WOW mode on 64-bit: %Program Files(x86)%\ MicrosoftSQL Server\\\OLAP\Config.

For all other installations: %Program Files%\ MicrosoftSQL Server\\\OLAP\Config.
Analysis Services /ASDATADIR

Optional
Specifies the directory for Analysis Services data files. Default values:

For WOW mode on 64-bit: %Program Files(x86)%\ MicrosoftSQL Server\\\OLAP\Data.

For all other installations: %Program Files%\ MicrosoftSQL Server\\\OLAP\Data.
Analysis Services /ASLOGDIR

Optional
Specifies the directory for Analysis Services log files. Default values:

For WOW mode on 64-bit: %Program Files(x86)%\ MicrosoftSQL Server\ <INSTANCEDIR>\\OLAP\Log.

For all other installations: %Program Files%\ MicrosoftSQL Server\ <INSTANCEDIR>\\OLAP\Log.
Analysis Services /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.
Analysis Services /ASSYSADMINACCOUNTS

Required
Specifies the administrator credentials for Analysis Services.
Analysis Services /ASTEMPDIR

Optional
Specifies the directory for Analysis Services temporary files.Default values:

For WOW mode on 64-bit: %Program Files(x86)%\ MicrosoftSQL Server\ <INSTANCEDIR>\\OLAP\Temp.

For all other installations: %Program Files%\ MicrosoftSQL Server\ <INSTANCEDIR>\\OLAP\Temp.
Analysis Services /ASPROVIDERMSOLAP

Optional
Specifies whether the MSOLAP provider can run in-process.

Default value: 1=enabled
SQL Server Database Engine /INSTALLSQLDATADIR

Required
Specifies the data directory for SQL Server data files.

The data directory must to specified and on a shared cluster disk.
SQL Server Database Engine /SAPWD

Required when /SECURITYMODE=SQL
Specifies the password for the SQL Serversa account.
SQL Server Database Engine /SECURITYMODE

Optional
Specifies the security mode for SQL Server.

If this parameter is not supplied, then Windows-only authentication mode is supported

Supported value: SQL
SQL Server Database Engine /SQLBACKUPDIR

Optional
Specifies the directory for backup files.

Default value: <InstallSQLDataDir>\ <SQLInstanceID>\MSSQL\Backup.
SQL Server Database Engine /SQLCOLLATION

Optional
Specifies the collation settings for SQL Server.

The default value is based on the locale of your Windows operating system. For more information, see Collation Settings in Setup.
SQL Server Database Engine /SQLSYSADMINACCOUNTS

Required
Use this parameter to provision logins to be members of the sysadmin role.
SQL Server Database Engine /SQLUSERDBDIR

Optional
Specifies the directory for the data files for user databases.

Default value: <InstallSQLDataDir>\ <SQLInstanceID>\MSSQL\Data
SQL Server Database Engine /SQLUSERDBLOGDIR

Optional
Specifies the directory for the log files for user databases.

Default value: <InstallSQLDataDir>\ <SQLInstanceID>\MSSQL\Data
Reporting Services /RSINSTALLMODE

Available on files only mode.
Specifies the Install mode for Reporting Services.
SQL Server Database Engine /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.
SQL Server Database Engine /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.
SQL Server Database Engine /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 SQL Server Express

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 *\* SQL Server Expressis not supported for configuring this parameter. Setup installs only 1 tempdb data file.
SQL Server Database Engine /SQLTEMPDBFILESIZE

Optional
Introduced in SQL Server 2016. Specifies the initial size of each tempdb data file.

Default = 8 MB.

Min = 8 MB.

Max = 1024 MB (262,144 MB for SQL Server 2017).
SQL Server Database Engine /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
SQL Server Database Engine /SQLTEMPDBLOGFILESIZE

Optional
Specifies the initial size of the tempdb log file in MB. Setup allows the size up to 1024.
Default value:

4 for SQL Server Express

8 for all other editions

Allowed range: Min = default value (4 or 8), Max = 1024
SQL Server Database Engine /SQLTEMPDBLOGFILEGROWTH

Optional
Introduced in SQL Server 2016. Specifies the initial size of each tempdb log file.

Default = 4 MB for SQL Server Express, 8 MB for all other editions.

Min = (4 or 8 MB).

Max = 1024 MB (262,144 MB for SQL Server 2017)
Sample Syntax:

To perform the "Completion" step of a failover cluster advanced installation scenario for the Database Engine and Analysis Services. 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 Analysis Services failover cluster.

Run the following command at the command prompt to complete failover cluster installation for a default instance:

setup.exe /q /ACTION=CompleteFailoverCluster /InstanceName=MSSQLSERVER /INDICATEPROGRESS /ASSYSADMINACCOUNTS="<DomainName\Username>" /ASDATADIR=<Drive>:\OLAP\Data /ASLOGDIR=<Drive>:\OLAP\Log /ASBACKUPDIR=<Drive>:\OLAP\Backup /ASCONFIGDIR=<Drive>:\OLAP\Config /ASTEMPDIR=<Drive>:\OLAP\Temp /FAILOVERCLUSTERDISKS="<Cluster Disk Resource Name - for example, 'Disk S:'>:" /FAILOVERCLUSTERNETWORKNAME="<Insert FOI Network Name>" /FAILOVERCLUSTERIPADDRESSES="IPv4;xx.xxx.xx.xx;Cluster Network;xxx.xxx.xxx.x" /FAILOVERCLUSTERGROUP="MSSQLSERVER" /INSTALLSQLDATADIR="<Drive>:\<Path>\MSSQLSERVER" /SQLCOLLATION="SQL_Latin1_General_CP1_CS_AS" /SQLSYSADMINACCOUNTS="<DomainName\UserName>"  

Run the following command at the command prompt to complete failover cluster installation for a named instance:

setup.exe /q /ACTION=CompleteFailoverCluster /InstanceName="<Insert Instance Name>" /INDICATEPROGRESS /ASSYSADMINACCOUNTS="<DomainName\UserName>" /ASDATADIR=<Drive>:\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>"  

Upgrade Failover Cluster Parameters

Use the parameters in the following table to develop command-line scripts for failover cluster upgrade. For more information, see Upgrade a SQL Server Failover Cluster Instance (Setup) and Always On Failover Cluster Instances (SQL Server).

SQL Server component Parameter Description
SQL Server Setup Control /ACTION

Required
Required to indicate the installation workflow.

Supported value: Upgrade
SQL Server Setup Control /IACCEPTSQLSERVERLICENSETERMS

Required only when the /Q or /QS parameter is specified for unattended installations.
Required to acknowledge acceptance of the license terms.
SQL Server 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.
SQL Server 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.
SQL Server Setup Control /UpdateSource

Optional
Specify the location where SQL Server setup will obtain product updates. The valid values are "MU" to search Microsoft Update, a valid folder path, a relative path such as .\MyUpdates or a UNC share. By default, SQL Server setup will search Microsoft Update or a Windows Update Service through the Windows Server Update Services.
SQL Server Setup Control /CONFIGURATIONFILE

Optional
Specifies the ConfigurationFile to use.
SQL Server Setup Control /ERRORREPORTING

Optional
Has no effect in SQL Server 2016.

To manage how error feedback is sent to Microsoft, see How to configure SQL Server 2016 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
SQL Server Setup Control /HELP, H, ?

Optional
Displays the usage options for the parameters.
SQL Server Setup Control /INDICATEPROGRESS

Optional
Specifies that the verbose Setup log file will be piped to the console.
SQL Server Setup Control / INSTANCEDIR

Optional
Specifies a nondefault installation directory for shared components.
SQL Server Setup Control /INSTANCEID

Required when you upgrade from SQL Server 2008 or higher.

Optional when you upgrade from SQL Server 2005
Specifies a nondefault value for an InstanceID.
SQL Server Setup Control /INSTANCENAME

Required
Specifies a SQL Server instance name.

For more information, see Instance Configuration.
SQL Server Setup Control /PID

Optional
Specifies the product key for the edition of SQL Server. If this parameter is not specified, Evaluation is used.
SQL Server Setup Control /Q

Optional
Specifies that Setup runs in a quiet mode without any user interface. This is used for unattended installations.
SQL Server Setup Control /SQMREPORTING

Optional
Has no effect in SQL Server 2016. In older versions this specifies feature usage reporting for SQL Server.

Supported values:

0=disabled

1=enabled
SQL Server Setup Control /HIDECONSOLE

Optional
Specifies that the console window is hidden or closed.
SQL Server 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
Integration Services /ISSVCACCOUNT

Required
Specifies the account for Integration Services.

Default value: NT AUTHORITY\NETWORK SERVICE
Integration Services /ISSVCPASSWORD

Required
Specifies the Integration Services password.
Integration Services /ISSVCStartupType

Optional
Specifies the startup mode for the Integration Services service.
Reporting Services /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 SQL Server 2012 Reporting Services. 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.
Reporting Services /RSUPGRADEPASSWORD

Optional
Password of the existing Report Server service account.

Add Node Parameters

Use the parameters in the following table to develop command-line scripts for AddNode.

SQL Server component Parameter Description
SQL Server Setup Control /ACTION

Required
Required to indicate AddNode work flow.

Supported value: AddNode
SQL Server Setup Control /IACCEPTSQLSERVERLICENSETERMS

Required only when the /Q or /QS parameter is specified for unattended installations.
Required to acknowledge acceptance of the license terms.
SQL Server 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.
SQL Server 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.
SQL Server Setup Control /UpdateSource

Optional
Specify the location where SQL Server setup will obtain product updates. The valid values are "MU" to search Microsoft Update, a valid folder path, a relative path such as .\MyUpdates or a UNC share. By default, SQL Server setup will search Microsoft Update or a Windows Update Service through the Windows Server Update Services.
SQL Server Setup Control /CONFIGURATIONFILE

Optional
Specifies the ConfigurationFile to use.
SQL Server Setup Control /HELP, H, ?

Optional
Displays the usage options for the parameters.
SQL Server Setup Control /INDICATEPROGRESS

Optional
Specifies that the verbose Setup log file will be piped to the console.
SQL Server Setup Control /INSTANCENAME

Required
Specifies a SQL Server 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.
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 SQL Server instance will be used as a part of PolyBase Scale-out computational group. Supported values: True, False
SQL Server Setup Control /PID

Optional
Specifies the product key for the edition of SQL Server. If this parameter is not specified, Evaluation is used.
SQL Server Setup Control /Q

Optional
Specifies that Setup runs in a quiet mode without any user interface. This is used for unattended installations.
SQL Server Setup Control /QS

Optional
Specifies that Setup runs and shows progress through the UI, but does not accept any input or show any error messages.
SQL Server Setup Control /HIDECONSOLE

Optional
Specifies that the console window is hidden or closed.
SQL Server 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=DEFAULT

FAILOVERCLUSTERIPADDRESSES=IPv4;DHCP;ClusterNetwork1

FAILOVERCLUSTERIPADDRESSES=IPv4;172.16.0.0;ClusterNetwork1;172.31.255.255

FAILOVERCLUSTERIPADDRESSES=IPv6;DHCP;ClusterNetwork1

FAILOVERCLUSTERIPADDRESSES=IPv6;2001:db8:23:1002:20f:1fff:feff:b3a3;ClusterNetwork1



For more information, see Add or Remove Nodes in a SQL Server Failover Cluster (Setup).
SQL Server 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 SQL Server Failover Cluster (Setup). 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.
Analysis Services /ASSVCACCOUNT

Required
Specifies the account for the Analysis Services service.
Analysis Services /ASSVCPASSWORD

Required
Specifies the password for the Analysis Services service.
SQL Server Database Engine /SQLSVCACCOUNT

Required
Specifies the startup account for the SQL Server service.
SQL Server Database Engine /SQLSVCPASSWORD

Required
Specifies the password for SQLSVCACCOUNT.
Integration Services /ISSVCPASSWORD

Required
Specifies the Integration Services password.
Reporting Services /RSINSTALLMODE

Available in Files only mode
Specifies the Install mode for Reporting Services.
Reporting Services /RSSVCPASSWORD

Required
Specifies the startup account password for the Reporting Services service.
Additional Notes:

The Database Engine and Analysis Services are the only components that are cluster-aware. Other features are not cluster-aware and do not have high availability through failover.

Sample Syntax:

To add a node to an existing failover cluster instance with the Database Engine and Analysis Services.

setup.exe /q /ACTION=AddNode /INSTANCENAME="<Insert Instance Name>" /SQLSVCACCOUNT="<SQL account that is used on other nodes>" /SQLSVCPASSWORD="<password for SQL account>" /AGTSVCACCOUNT="<SQL Server Agent account that is used on other nodes>", /AGTSVCPASSWORD="<SQL Server Agent account password>" /ASSVCACCOUNT="<AS account that is used on other nodes>" /ASSVCPASSWORD=”<password for AS account>” /INDICATEPROGRESS /IACCEPTSQLSERVERLICENSETERMS /FAILOVERCLUSTERIPADDRESSES="IPv4;xx.xxx.xx.xx;ClusterNetwork1;xxx.xxx.xxx.x" /CONFIRMIPDEPENDENCYCHANGE=0  

Remove Node Parameters

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).

SQL Server component Parameter Description
SQL Server Setup Control /ACTION

Required
Required to indicate RemoveNode work flow.

Supported value: RemoveNode
SQL Server Setup Control /CONFIGURATIONFILE

Optional
Specifies the ConfigurationFile to use.
SQL Server Setup Control /HELP, H, ?

Optional
Displays the usage options for the parameters.
SQL Server Setup Control /INDICATEPROGRESS

Optional
Specifies that the verbose Setup log file will be piped to the console.
SQL Server Setup Control /INSTANCENAME

Required
Specifies a SQL Server instance name.

For more information, see Instance Configuration.
SQL Server Setup Control /Q

Optional
Specifies that Setup runs in a quiet mode without any user interface. This is used for unattended installations.
SQL Server Setup Control /QS

Optional
Specifies that Setup runs and shows progress through the UI, but does not accept any input or show any error messages.
SQL Server Setup Control /HIDECONSOLE

Optional
Specifies that the console window is hidden or closed.
SQL Server 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 SQL Server Failover Cluster (Setup). Supported values:

0 = False (Default)

1 = True
Sample Syntax:

To remove a node from an existing failover cluster instance with the Database Engine and Analysis Services.

setup.exe /q /ACTION=RemoveNode /INSTANCENAME="<Insert Instance Name>" [/INDICATEPROGRESS] /CONFIRMIPDEPENDENCYCHANGE=0  

Service Account Parameters

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 Windows 7 and Windows Server 2008 R2 section in Configure Windows Service Accounts and Permissions.

For more information about service account configuration, see Configure Windows Service Accounts and Permissions.

SQL Server component Account parameter Password parameter Startup type
SQL Server Agent /AGTSVCACCOUNT /AGTSVCPASSWORD /AGTSVCSTARTUPTYPE
Analysis Services /ASSVCACCOUNT /ASSVCPASSWORD /ASSVCSTARTUPTYPE
SQL Server Database Engine /SQLSVCACCOUNT /SQLSVCPASSWORD /SQLSVCSTARTUPTYPE
Integration Services /ISSVCACCOUNT /ISSVCPASSWORD /ISSVCSTARTUPTYPE
Reporting Services /RSSVCACCOUNT /RSSVCPASSWORD /RSSVCSTARTUPTYPE

Feature Parameters

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 SQL Server 2016.

Parent feature parameter Feature parameter Description
SQL Installs the SQL Server Database Engine, Replication, Fulltext, and Data Quality Server.
SQLEngine Installs just the SQL Server Database Engine.
Replication Installs the Replication component along with SQL Server Database Engine.
FullText Installs the FullText component along with SQL Server Database Engine.
DQ Copies the files required for completing the Data Quality Server installation. After completing SQL Server installation, you must run the DQSInstaller.exe file to complete the Data Quality Server installation. For more information, see Run DQSInstaller.exe to Complete Data Quality Server Installation. This also installs SQL Server Database Engine.
PolyBase Installs PolyBase components.
AdvancedAnalytics Installs R Services (In-Database).
AS Installs all Analysis Services components.
RS Installs all Reporting Services components.
DQC Installs Data Quality Client.
IS Installs all Integration Services components.
MDS Installs Master Data Services.
SQL_SHARED_MR Installs Microsoft R Server.
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 Microsoft SQL Server Native Client
SDK Installs the software development kit.
LocalDB** Installs LocalDB, an execution mode of SQL Server Express targeted to program developers.

*SQL Server Management Tools (SSMS) is now in a stand-alone installer that is separate from the SQL Server installer. For details, see Install SQL Server Management Studio from the command line.

**LocalDB is an option when installing any SKU of SQL Server 2017 Express. For more information, see SQL Server 2016 Express LocalDB.

Feature parameter examples:

Parameter and values Description
/FEATURES=SQLEngine Installs the Database Engine without replication and full-text.
/FEATURES=SQLEngine, FullText Installs the Database Engine and full-text.
/FEATURES=SQL, Tools Installs the complete Database Engine and all tools.
/FEATURES=BOL Installs SQL Server Books Online components to view and manage help content.
/FEATURES=SQLEngine, PolBase Intalls the PolyBase engine.

Role Parameters

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 un-configured 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 SQL Server Express 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 SQL Server Express.

Role Description Installs…
SPI_AS_ExistingFarm Installs Analysis Services as a Power Pivot named instance on an existing SharePoint Server 2010 farm or standalone server. Analysis Services calculation engine, preconfigured for in-memory data storage and processing.

Power Pivot solution packages

Installer program for the Power Pivot for Excel

SQL Server Books Online
SPI_AS_NewFarm Installs Analysis Services and Database Engine as a Power Pivot named instance on a new, un-configured Office SharePoint Server 2010 farm or standalone server. SQL Server Setup will configure the farm during feature role installation. Analysis Services calculation engine, preconfigured for in-memory data storage and processing.

Power Pivot solution packages

SQL Server Books Online

Database Engine

Configuration Tools

SQL Server Management Studio
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 Windows Server 2008 or higher and when the operating system is not a domain controller, the Database Engine, and Reporting Services are defaulted to use the NTAUTHORITY\NETWORK SERVICE account, and Integration Services is defaulted to use the NTAUTHORITY\NETWORK SERVICE account.

This role is enabled by default in editions of SQL Server Express. For all other editions, this role is not enabled but can be specified through the UI or with command line parameters.
For editions of SQL Server Express, installs only those features available in the edition. For other editions, installs all SQL Server features.

The AllFeatures_WithDefaults parameter can be combined with other parameters which 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 Reporting Services, but honors the AllFeatures_WithDefaults parameter to use the default service account for Reporting Services.

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.

Controlling Failover Behavior using the /FAILOVERCLUSTERROLLOWNERSHIP Parameter

To upgrade a SQL Server failover cluster to SQL Server 2017, 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.

Instance ID or InstanceID Configuration

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:MSSQL13.<INSTANCEID>

  • AS Instance ID:MSAS13.<INSTANCEID>

  • RS Instance ID:MSRS13.<INSTANCEID>

    The instance-aware components are installed to the following locations:

    %Program Files%\Microsoft SQL Server\

    %Program Files%\Microsoft SQL Server\

    %Program Files Microsoft SQL Server\

NOTE: If INSTANCEID is not specified on the command line, then by default Setup substitute <INSTANCEID> with the <INSTANCENAME>.

See Also

Install SQL Server 2016 from the Installation Wizard
SQL Server Failover Cluster Installation
[Install SQL Server 2016 Business Intelligence Features]