As an expert in automotive diagnostics and content creator for obd2scanner.store, I understand the need for robust and efficient data management. This guide provides a comprehensive walkthrough for installing and configuring SQL Server on Windows using the command prompt. This method is invaluable for automation, scripting, and advanced configurations, ensuring a streamlined approach to database deployment.
Before proceeding with SQL Server Setup, it’s crucial to review the essential planning steps for a SQL Server installation. Proper planning ensures a smooth and successful installation process tailored to your specific needs.
Installing a new SQL Server instance from the command line offers granular control over feature selection and configuration settings. You have the flexibility to choose between silent, basic, or full interactive modes for the Setup user interface, accommodating various deployment scenarios.
To initiate SQL Server installation or configuration via the command prompt, you must first open an administrative command prompt. Navigate to the directory containing setup.exe
within your SQL Server installation media. Execute the setup.exe
command, incorporating the necessary and optional parameters to achieve your desired outcome.
C:SQLMediaSQLServer2022> setup.exe /[Option] /[Option] = {value}
For example, to install the SQL Server Database Engine, SQL Server Analysis Services, SQL Server, and Integration Services in quiet mode, you would use the following command:
C:SQLMediaSQLServer2022> setup.exe /Q /IACCEPTSQLSERVERLICENSETERMS /ACTION="install" /PID="AAAAA-BBBBB-CCCCC-DDDDD-EEEEE" /FEATURES=SQL,AS,IS /INSTANCENAME=MSSQLSERVER /SQLSVCACCOUNT="MyDomainMyAccount" /SQLSVCPASSWORD="************" /SQLSYSADMINACCOUNTS="MyDomainMyAccount " /AGTSVCACCOUNT="MyDomainMyAccount" /AGTSVCPASSWORD="************" /ASSVCACCOUNT="MyDomainMyAccount" /ASSVCPASSWORD="************" /ISSVCACCOUNT="MyDomainMyAccount" /ISSVCPASSWORD="************" /ASSYSADMINACCOUNTS="MyDomainMyAccount"
To explore a complete list of available commands within the console, execute the setup with the /help
flag:
C:SQLMediaSQLServer2022> setup.exe /help
Important Licensing Note:
A new parameter, /PRODUCTCOVEREDBYSA
, was introduced in SQL Server 2022 (16.x). This parameter is essential for specifying whether your product key (/PID=
) is covered by a Software Assurance or SQL Server Subscription contract, or solely a SQL Server license.
The following sections detail each available parameter to customize your command-line installations.
Understanding Quiet Modes:
SQL Server command-line installation supports two quiet modes:
- Full quiet mode (
/Q
): Executes the installation without any user interface. - Quiet simple mode (
/QS
): Displays progress in the UI but doesn’t accept input or show error messages (only supported with/ACTION=INSTALL
).
Regardless of the method used, accepting the software license terms is mandatory unless your software use is governed by a separate agreement (like volume licensing). For unattended installations using /Q
or /QS
, the /IACCEPTSQLSERVERLICENSETERMS
parameter must be included. You can review the license terms at Microsoft Software License Terms. For SQL Server 2022 (16.x) and later, refer to aka.ms/useterms.
Command-line installations are suitable for various scenarios:
- New installations, upgrades, and removals of SQL Server instances and shared components.
- Failover cluster instance installations, upgrades, and removals.
- Edition upgrades between different SQL Server editions.
- Consistent installations across multiple computers using configuration files, ideal for failover cluster node deployments or replicating configurations.
Note: For local installations, administrator privileges are required. Remote share installations necessitate a domain account with read and execute permissions on the share. Failover cluster installations demand local administrator rights with service login and operating system act-as privileges across all cluster nodes.
Best Practices for Setup Parameter Usage
Adhering to correct syntax is vital for successful command-line installations. Use these guidelines:
Parameter | Example |
---|---|
/PARAMETER |
/INDICATEPROGRESS |
/PARAMETER=true/false |
/SQLSVCINSTANTFILEINIT=True |
/PARAMETER=1/0 (Boolean) |
/TCPENABLED=1 |
/PARAMETER="value" (Single-value) |
/PID="PID" /SQLSVCSTARTUPTYPE="Automatic" |
/PARAMETER="value1" "value2" "value3" (Multi-value) |
/SQLSYSADMINACCOUNTS="ContosoJohn" "ContosoMary" |
Exception: /FEATURES
is multi-valued but uses comma-separated values without spaces: /FEATURES=AS,RS,IS
.
Important Directory Considerations:
Avoid using the same directory path for INSTANCEDIR
and SQLUSERDBDIR
during SQL Server installation, as this can prevent SQL Server Agent and Full Text Search from starting due to permission issues.
Path Formats: Relational server values support backslash () or double backslash (
\
) path terminators.
Detailed Parameter Options
The following sections provide comprehensive parameter details for command-line scripts covering installation, update, and repair scenarios. Parameter values vary based on the chosen action.
Parameters are categorized by SQL Server component. SQL Server Agent and SQL Server Browser parameters are relevant when installing the SQL Server Database Engine.
Installation Parameters
The parameters in the following table are used for developing command-line scripts to install a new instance of SQL Server.
SQL Server Database Engine Component | Parameter | Description |
---|---|---|
Database Engine Setup Control | /ACTION Required |
Specifies the installation workflow. Value must be Install . |
Database Engine Setup Control | /SUPPRESSPRIVACYSTATEMENTNOTICE Required, with /Q or /QS |
Suppresses the privacy notice statement. Using this flag implies agreement with the privacy notice. |
Database Engine Setup Control | /IACCEPTSQLSERVERLICENSETERMS Required, with /Q or /QS |
Acknowledges acceptance of the license terms. Review terms at aka.ms/useterms. |
SQL Server Python Setup Control | /IACCEPTPYTHONLICENSETERMS Required, with /Q or /QS (Python feature) |
Acknowledges Python license terms for installations including Anaconda Python. |
SQL Server R Setup Control | /IACCEPTROPENLICENSETERMS Required, with /Q or /QS (R feature) |
Acknowledges R license terms for installations including Microsoft R Open. |
Database Engine Setup Control | /ENU Optional |
Installs the English version on localized OS when the media contains language packs for both English and the OS language. |
Database Engine Setup Control | /UpdateEnabled Optional |
Enables or disables product update discovery and inclusion. Values: True /False or 1 /0 . Default: True (updates included). |
Database Engine Setup Control | /UpdateSource Optional |
Specifies the update source location. Values: "MU" (Microsoft Update), folder path, relative path (e.g., .MyUpdates ), or UNC share. Default: Microsoft Update or Windows Update Service via WSUS. |
Database Engine Setup Control | /CONFIGURATIONFILE Optional |
Specifies the ConfigurationFile to use. |
Database Engine Setup Control | /ERRORREPORTING Optional (SQL Server 2014 and earlier) |
Configures error feedback to Microsoft. See How to configure SQL Server 2016 (13.x) to send feedback. Values: 1 (enabled), 0 (disabled). Refer to SQL Server privacy supplement. |
Database Engine Setup Control | /FEATURES or /ROLE Required |
Specifies components to install using /FEATURES or a predefined setup role using /ROLE . See Feature Parameters and Role Parameters. |
Database Engine Setup Control | /HELP or ? Optional |
Displays parameter usage options. |
Database Engine Setup Control | /INDICATEPROGRESS Optional |
Pipes verbose Setup log to the console. |
Database Engine Setup Control | /INSTALLSHAREDDIR Optional |
Non-default directory for 64-bit shared components. Default: %Program Files%Microsoft SQL Server . Cannot be %Program Files(x86)%Microsoft SQL Server . |
Database Engine Setup Control | /INSTALLSHAREDWOWDIR Optional |
Non-default directory for 32-bit shared components (64-bit systems only). Default: %Program Files(x86)%Microsoft SQL Server . Cannot be %Program Files%Microsoft SQL Server . |
Database Engine Setup Control | /INSTANCEDIR Optional |
Non-default installation directory for instance-specific components. |
Database Engine Setup Control | /INSTANCEID Optional |
Non-default InstanceID value. |
Database Engine Setup Control | /INSTANCENAME Required |
SQL Server Database Engine instance name. See Instance Configuration. |
Database Engine Setup Control | /PRODUCTCOVEREDBYSA Required, for AZUREEXTENSION (SQL Server 2022+) |
Specifies license coverage for SQL Server when installing Azure Extension. /PRODUCTCOVEREDBYSA=True (or just /PRODUCTCOVEREDBYSA ) for Software Assurance/Subscription. /PRODUCTCOVEREDBYSA=False (or omitted) for standard SQL Server license. |
Database Engine Setup Control | /PID Optional |
Product key for SQL Server edition. Evaluation edition used if omitted. Predefined for Express, Developer, and Evaluation editions. |
Database Engine Setup Control | /Q or /QUIET Optional |
Runs Setup in full quiet mode (no UI). Overrides /QS . |
Database Engine Setup Control | /QS or /QUIETSIMPLE Optional |
Runs Setup in quiet simple mode (progress UI, no input/errors). Only with /ACTION=INSTALL . |
Database Engine Setup Control | /UIMODE Optional |
Specifies UI verbosity. /UIMODE=Normal (default, all dialogs), /UIMODE=AutoAdvance (fewer dialogs, default for Express). Cannot be used with /Q or /QS . |
Database Engine Setup Control | /SQMREPORTING Optional (SQL Server 2014 and earlier) |
Configures feature usage reporting. See How to configure SQL Server 2016 (13.x) to send feedback. Values: 1 (enabled), 0 (disabled). |
Database Engine Setup Control | /HIDECONSOLE Optional |
Hides or closes the console window. |
SQL Server Agent | /AGTSVCACCOUNT Required |
Account for SQL Server Agent service. |
SQL Server Agent | /AGTSVCPASSWORD Required |
Password for SQL Server Agent service account. Omit for managed, virtual, or built-in accounts. |
SQL Server Agent | /AGTSVCSTARTUPTYPE Optional |
Startup mode for SQL Server Agent service. Values: Automatic , Disabled , Manual . |
PolyBase Engine | /PBENGSVCACCOUNT Optional |
Account for PolyBase Engine service. Default: NT AUTHORITYNETWORK SERVICE . |
PolyBase Engine | /PBENGSVCPASSWORD Optional |
Password for PolyBase Engine service account. |
PolyBase Engine | /PBENGSVCSTARTUPTYPE Optional |
Startup mode for PolyBase Engine service. Values: Automatic (default), Disabled , Manual . |
PolyBase Data Movement | /PBDMSSVCACCOUNT Optional |
Account for PolyBase Data Movement service. Default: NT AUTHORITYNETWORK SERVICE . |
PolyBase Data Movement | /PBDMSSVCPASSWORD Optional |
Password for PolyBase Data Movement service account. Omit for managed, virtual, or built-in accounts. |
PolyBase Data Movement | /PBDMSSVCSTARTUPTYPE Optional |
Startup mode for PolyBase Data Movement service. Values: Automatic (default), Disabled , Manual . |
PolyBase | /PBPORTRANGE Optional |
Port range (at least 6 ports) for PolyBase services. Example: /PBPORTRANGE=16450-16460 . |
PolyBase | /PBSCALEOUT Optional |
Whether the SQL Server Database Engine instance is part of a PolyBase Scale-out group. Values: True , False . |
Analysis Services | /ASBACKUPDIR Optional |
Directory for Analysis Services backup files. Defaults vary based on WOW mode. |
Analysis Services | /ASCOLLATION Optional |
Collation setting for Analysis Services. Default: Latin1_General_CI_AS . Windows collation only. |
Analysis Services | /ASCONFIGDIR Optional |
Directory for Analysis Services configuration files. Defaults vary based on WOW mode. |
Analysis Services | /ASDATADIR Optional |
Directory for Analysis Services data files. Defaults vary based on WOW mode. |
Analysis Services | /ASLOGDIR Optional |
Directory for Analysis Services log files. Defaults vary based on WOW mode. |
Analysis Services | /ASSERVERMODE Optional |
Server mode of the Analysis Services instance. Valid values in cluster: MULTIDIMENSIONAL , TABULAR . Case-sensitive, uppercase. See Install Analysis Services in Tabular Mode. |
Analysis Services | /ASSVCACCOUNT Required |
Account for Analysis Services service. |
Analysis Services | /ASSVCPASSWORD Required |
Password for Analysis Services service account. Omit for managed, virtual, or built-in accounts. |
Analysis Services | /ASSVCSTARTUPTYPE Optional |
Startup mode for Analysis Services service. Values: Automatic , Disabled , Manual . |
Analysis Services | /ASSYSADMINACCOUNTS Required |
Administrator credentials for Analysis Services. |
Analysis Services | /ASTEMPDIR Optional |
Directory for Analysis Services temporary files. Defaults vary based on WOW mode. |
Analysis Services | /ASPROVIDERMSOLAP Optional |
Whether MSOLAP provider can run in-process. Default: 1 (enabled). |
Analysis Services | /FARMACCOUNT Required, for SPI_AS_NewFarm |
Domain user account for SharePoint Central Administration services in a farm. Only for /ROLE = SPI_AS_NEWFARM . |
Analysis Services | /FARMPASSWORD Required, for SPI_AS_NewFarm |
Password for the farm account. Omit for managed, virtual, or built-in accounts. Only for /ROLE = SPI_AS_NEWFARM . |
Analysis Services | /PASSPHRASE Required, for SPI_AS_NewFarm |
Passphrase to add application/web front-end servers to a SharePoint farm. Only for /ROLE = SPI_AS_NEWFARM . |
Analysis Services | /FARMADMINIPORT Required, for SPI_AS_NewFarm |
Port to connect to SharePoint Central Administration web app. Only for /ROLE = SPI_AS_NEWFARM . |
SQL Server Browser | /BROWSERSVCSTARTUPTYPE Optional |
Startup mode for SQL Server Browser service. 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 |
Data directory for SQL Server data files. Defaults vary based on WOW mode. |
SQL Server Database Engine | /SAPWD Required, if /SECURITYMODE=SQL |
Password for the SQL Server SA account when using SQL security mode. |
SQL Server Database Engine | /SECURITYMODE Optional |
Security mode for SQL Server. Default: Windows-only authentication. Value: SQL (mixed mode). |
SQL Server Database Engine | /SQLBACKUPDIR Optional |
Directory for backup files. Default: <installsqldatadir><sqlinstanceid>MSSQLBackup</sqlinstanceid></installsqldatadir> . |
SQL Server Database Engine | /SQLCOLLATION Optional |
Collation settings for SQL Server. Default: OS locale. See Collation and Unicode support. |
SQL Server Database Engine | /ADDCURRENTUSERASSQLADMIN Optional |
Adds current user to the sysadmin role. Default: True for Express editions, False otherwise. Required with /SQLSYSADMINACCOUNTS or /ADDCURRENTUSERASSQLADMIN . |
SQL Server Database Engine | /SQLSVCACCOUNT Required |
Startup account for SQL Server service. |
SQL Server Database Engine | /SQLSVCPASSWORD Required |
Password for SQLSVCACCOUNT . Omit for managed, virtual, or built-in accounts. |
SQL Server Database Engine | /SQLSVCSTARTUPTYPE Optional |
Startup mode for SQL Server service. Values: Automatic , Disabled , Manual . |
SQL Server Database Engine | /SQLSYSADMINACCOUNTS Required |
Logins to provision as sysadmin role members. Required for non-Express editions. Required with /ADDCURRENTUSERASSQLADMIN or /SQLSYSADMINACCOUNTS . |
SQL Server Database Engine | /SQLTEMPDBDIR Optional |
Directories for tempdb data files (space-separated for multiple directories). Default: <installsqldatadir><sqlinstanceid>MSSQLData</sqlinstanceid></installsqldatadir> . |
SQL Server Database Engine | /SQLTEMPDBLOGDIR Optional |
Directory for tempdb log file. Default: <installsqldatadir><sqlinstanceid>MSSQLData</sqlinstanceid></installsqldatadir> . |
SQL Server Database Engine | /SQLTEMPDBFILECOUNT Optional |
Number of tempdb data files. Default: 1 (Express), 8 or cores (other editions). Max: cores. Not supported for Express. |
SQL Server Database Engine | /SQLTEMPDBFILESIZE Optional (SQL Server 2016+) |
Initial size of each tempdb data file in MB. Default: 4MB (Express), 8MB (other). Min: 4MB/8MB, Max: 1024MB. |
SQL Server Database Engine | /SQLTEMPDBFILEGROWTH Optional |
File growth increment of tempdb data files in MB. 0 disables autogrowth. Default: 64MB. Range: 0-1024MB. |
SQL Server Database Engine | /SQLTEMPDBLOGFILESIZE Optional (SQL Server 2016+) |
Initial size of tempdb log file in MB. Max: 1024MB. Default: 4MB (Express), 8MB (other). Range: default-1024MB. |
SQL Server Database Engine | /SQLTEMPDBLOGFILEGROWTH Optional (SQL Server 2016+) |
File growth increment of tempdb log file in MB. 0 disables autogrowth. Default: 64MB. Range: 0-1024MB. |
SQL Server Database Engine | /SQLUSERDBDIR Optional |
Directory for user database data files. Default: <installsqldatadir><sqlinstanceid>MSSQLData</sqlinstanceid></installsqldatadir> . |
SQL Server Database Engine | /SQLSVCINSTANTFILEINIT Optional |
Enables instant file initialization for SQL Server service account. Values: False (default), True . See Database instant file initialization. |
SQL Server Database Engine | /SQLUSERDBLOGDIR Optional |
Directory for user database log files. Default: <installsqldatadir><sqlinstanceid>MSSQLData</sqlinstanceid></installsqldatadir> . |
SQL Server Database Engine | /SQLMAXDOP=parameter Optional (SQL Server 2019+) |
Specifies the max degree of parallelism (MAXDOP). Default: aligns with max degree of parallelism guidelines. |
SQL Server Database Engine | /USESQLRECOMMENDEDMEMORYLIMITS Optional (SQL Server 2019+) |
Uses calculated recommended memory limits. Cannot be used with /SQLMINMEMORY and /SQLMAXMEMORY . Default: uses default SQL Server memory configuration if omitted in unattended installs. |
SQL Server Database Engine | /SQLMINMEMORY Optional (SQL Server 2019+) |
Minimum server memory configuration in MB. Default: 0. Cannot be used with /USESQLRECOMMENDEDMEMORYLIMITS . Default: uses default SQL Server memory configuration if omitted in unattended installs. |
SQL Server Database Engine | /SQLMAXMEMORY Optional (SQL Server 2019+) |
Maximum server memory configuration in MB. Default: calculated recommended value. Cannot be used with /USESQLRECOMMENDEDMEMORYLIMITS . Default: uses default SQL Server memory configuration if omitted in unattended installs. |
FILESTREAM | /FILESTREAMLEVEL Optional |
Access level for FILESTREAM feature. Values: 0 (disable, default), 1 (Transact-SQL access), 2 (Transact-SQL and file I/O streaming access), 3 (remote client streaming access). |
FILESTREAM | /FILESTREAMSHARENAME Optional |
Windows share name for FILESTREAM data. Required if FILESTREAMLEVEL > 1. |
SQL Server Full Text | /FTSVCACCOUNT Optional |
Account for Full-Text filter launcher service. Ignored in Windows Server 2008+. Default: Local Service Account. |
SQL Server Full Text | /FTSVCPASSWORD Optional |
Password for Full-Text filter launcher service. Ignored in Windows Server 2008+. Omit for managed, virtual, or built-in accounts. |
Integration Services | /ISSVCACCOUNT Required |
Account for Integration Services. Default: NT AUTHORITYNETWORK SERVICE . |
Integration Services | /ISSVCPASSWORD Required |
Password for Integration Services. Omit for managed, virtual, or built-in accounts. |
Integration Services | /ISSVCStartupType Optional |
Startup mode for Integration Services service. |
SQL Server Network Configuration | /NPENABLED Optional |
State of Named Pipes protocol. Values: 0 (disable), 1 (enable). |
SQL Server Network Configuration | /TCPENABLED Optional |
State of TCP protocol. Values: 0 (disable), 1 (enable). |
Reporting Services | /RSINSTALLMODE Optional (SQL Server 2016 and earlier) |
Install mode for Reporting Services. Values: SharePointFilesOnlyMode , DefaultNativeMode , FilesOnlyMode . Default: DefaultNativeMode (with DB Engine), FilesOnlyMode (without DB Engine). |
Reporting Services | /RSSVCACCOUNT Required (SQL Server 2016 and earlier) |
Startup account for Reporting Services. |
Reporting Services | /RSSVCPASSWORD Required (SQL Server 2016 and earlier) |
Password for Reporting Services service account. Omit for managed, virtual, or built-in accounts. |
Reporting Services | /RSSVCStartupType Optional (SQL Server 2016 and earlier) |
Startup mode for Reporting Services. Values: Automatic , Disabled , Manual . |
Python/Machine Learning Services | /MPYCACHEDIRECTORY Optional |
Reserved for future use. Use %TEMP% for Python .CAB files when installing offline. |
R/Machine Learning Services | /MRCACHEDIRECTORY Optional |
Cache directory for Microsoft R Open/SQL Server R Services/Machine Learning Services. For offline R component installations. |
Java/Language Extensions | /SQL_INST_JAVA , /SQLJAVADIR = "path" Optional (SQL Server 2019 only) |
Installs Java with Language Extensions. /SQL_INST_JAVA installs Zulu Open JRE from media. /SQLJAVADIR specifies path to existing JRE/JDK. |
Azure extension for SQL Server | /FEATURES=AZUREEXTENSION Optional (SQL Server 2022+) |
Connects instance to Azure Arc. |
Azure extension for SQL Server | /AZURESUBSCRIPTIONID Optional (SQL Server 2022+) |
Azure subscription for SQL Server instance resource. |
Azure extension for SQL Server | /AZURERESOURCEGROUP Optional (SQL Server 2022+) |
Azure resource group for SQL Server instance resource. |
Azure extension for SQL Server | /AZUREREGION Optional (SQL Server 2022+) |
Azure region for SQL Server instance resource. |
Azure extension for SQL Server | /AZURETENANTID Optional (SQL Server 2022+) |
Azure tenant ID for service principal. |
Azure extension for SQL Server | /AZURESERVICEPRINCIPAL Optional (SQL Server 2022+) |
Service principal for authentication against tenant ID, subscription, and resource group. |
Azure extension for SQL Server | /AZURESERVICEPRINCIPALSECRET Optional (SQL Server 2022+) |
Service principal secret. |
Azure extension for SQL Server | /AZUREARCPROXY Optional (SQL Server 2022+) |
Proxy server name for Azure Arc connection. |
Installation Syntax Example
To install a new standalone instance with SQL Server Database Engine, Replication, and Full-Text Search, enabling instant file initialization:
setup.exe /q /ACTION=Install /FEATURES=SQL /INSTANCENAME=MSSQLSERVER /SQLSVCACCOUNT="<domainname>" /SQLSVCPASSWORD="<strongpassword>" /SQLSYSADMINACCOUNTS="<domainname>" /AGTSVCACCOUNT="NT AUTHORITYNETWORK SERVICE" /SQLSVCINSTANTFILEINIT="True" /IACCEPTSQLSERVERLICENSETERMS
Installing and Connecting to Azure Arc (SQL Server 2022+)
Starting with SQL Server 2022 (16.x), you can integrate Azure Arc agent installation directly with SQL Server setup. This automatically Arc-enables all instances on the host, registering them as Azure resources and allowing attachment of Azure management services.
This example installs a SQL Server instance, Azure Arc agent, and Azure extension for SQL Server, connecting the instance to Azure post-installation. Replace bracketed information with your specific details:
setup.exe /qs /ACTION=Install /FEATURES=SQLEngine,AZUREEXTENSION /INSTANCENAME=<instance name=""> /SQLSYSADMINACCOUNTS="<sysadmin account="">" /IACCEPTSQLSERVERLICENSETERMS /AZURESUBSCRIPTIONID="<azure subscription="">" /AZURETENANTID="<azure id="" tenant="">" /AZURERESOURCEGROUP="<resource group="" name="">" /AZURESERVICEPRINCIPAL="<service principal="">" /AZURESERVICEPRINCIPALSECRET="<secret>" /AZUREREGION=</secret></service></resource></azure></azure></sysadmin></instance>
To install only the Azure Arc agent and Azure extension for managing existing SQL Server instances:
setup.exe /qs /ACTION=Install /FEATURES=AZUREEXTENSION /IACCEPTSQLSERVERLICENSETERMS /AZURESUBSCRIPTIONID="<azure subscription="">" /AZURETENANTID="<azure id="" tenant="">" /AZURERESOURCEGROUP="<resource group="" name="">" /AZURESERVICEPRINCIPAL="<service principal="">" /AZURESERVICEPRINCIPALSECRET="<secret>" /AZUREREGION=</secret></service></resource></azure></azure>
Removing the Azure extension for SQL Server (note: does not uninstall Azure Arc agent):
setup.exe /qs /ACTION=Uninstall /FEATURES=AZUREEXTENSION /IACCEPTSQLSERVERLICENSETERMS
For detailed information on Azure Arc integration, refer to [link to Azure Arc documentation].
SysPrep Parameters
For advanced deployment scenarios using SQL Server SysPrep, consult Install SQL Server 2016 (13.x) Using SysPrep.
Prepare Image Parameters
These parameters are used to create a prepared SQL Server instance image without configuring it.
SQL Server Database Engine Component | Parameter | Description |
---|---|---|
Database Engine Setup Control | /ACTION Required |
Specifies the installation workflow. Value must be PrepareImage . |
Database Engine Setup Control | /IACCEPTSQLSERVERLICENSETERMS Required, with /Q or /QS |
Acknowledges acceptance of the license terms. Review terms at aka.ms/useterms. |
Database Engine Setup Control | /ENU Optional |
Installs the English version on localized OS when the media contains language packs for both English and the OS language. |
Database Engine Setup Control | /UpdateEnabled Optional |
Enables or disables product update discovery and inclusion. Values: True /False or 1 /0 . Default: True (updates included). |
Database Engine Setup Control | /UpdateSource Optional |
Specifies the update source location. Values: "MU" (Microsoft Update), folder path, relative path (e.g., .MyUpdates ), or UNC share. Default: Microsoft Update or Windows Update Service via WSUS. |
Database Engine Setup Control | /CONFIGURATIONFILE Optional |
Specifies the ConfigurationFile to use. |
Database Engine Setup Control | /FEATURES Required |
Specifies components to install. Supported values: 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 . |
Database Engine Setup Control | /HELP or ? Optional |
Displays parameter usage options. |
Database Engine Setup Control | /HIDECONSOLE Optional |
Hides or closes the console window. |
Database Engine Setup Control | /INDICATEPROGRESS Optional |
Pipes verbose Setup log to the console. |
Database Engine Setup Control | /INSTALLSHAREDDIR Optional |
Non-default directory for 64-bit shared components. Default: %Program Files%Microsoft SQL Server . Cannot be %Program Files(x86)%Microsoft SQL Server . |
Database Engine Setup Control | /INSTANCEDIR Optional |
Non-default installation directory for instance-specific components. |
Database Engine Setup Control | /INSTANCEID Required |
InstanceID for the prepared instance. Required for instance features since SQL Server 2012 SP1 CU2. |
PolyBase Engine | /PBENGSVCACCOUNT Optional |
Account for PolyBase Engine service. Default: NT AUTHORITYNETWORK SERVICE . |
PolyBase Data Movement | /PBDMSSVCPASSWORD Optional |
Password for PolyBase Data Movement service account. Omit for managed, virtual, or built-in accounts. |
PolyBase Engine | /PBENGSVCSTARTUPTYPE Optional |
Startup mode for PolyBase Engine service. Values: Automatic (default), Disabled , Manual . |
PolyBase | /PBPORTRANGE Optional |
Port range (at least 6 ports) for PolyBase services. Example: /PBPORTRANGE=16450-16460 . |
PolyBase | /PBSCALEOUT Optional |
Whether the SQL Server Database Engine instance is part of a PolyBase Scale-out group. Values: True , False . |
Database Engine Setup Control | /Q or /QUIET Optional |
Runs Setup in full quiet mode (no UI). Overrides /QS . |
Database Engine Setup Control | /QS or /QUIETSIMPLE Optional |
Runs Setup in quiet simple mode (progress UI, no input/errors). Only with /ACTION=INSTALL . |
Note: Distributed Replay, SDK, and SNAC are not available in SQL Server 2022 (16.x).
Prepare Image Syntax Example
To prepare a new standalone instance with Database Engine, Replication, Full-Text Search, and Reporting Services:
setup.exe /q /ACTION=PrepareImage /FEATURES=SQL,RS /InstanceID =<myinst> /IACCEPTSQLSERVERLICENSETERMS
Complete Image Parameters
These parameters configure a previously prepared SQL Server instance.
SQL Server Component | Parameter | Description |
---|---|---|
Database Engine Setup Control | /ACTION Required |
Specifies the installation workflow. Value must be CompleteImage . |
Database Engine Setup Control | /IACCEPTSQLSERVERLICENSETERMS Required, with /Q or /QS |
Acknowledges acceptance of the license terms. Review terms at aka.ms/useterms. |
Database Engine Setup Control | /ENU Optional |
Installs the English version on localized OS when the media contains language packs for both English and the OS language. |
Database Engine Setup Control | /CONFIGURATIONFILE Optional |
Specifies the ConfigurationFile to use. |
Database Engine Setup Control | /ERRORREPORTING Optional (SQL Server 2014 and earlier) |
Configures error feedback to Microsoft. See How to configure SQL Server 2016 (13.x) to send feedback. Values: 1 (enabled), 0 (disabled). Refer to SQL Server privacy supplement. |
Database Engine Setup Control | /HELP or ? Optional |
Displays parameter usage options. |
Database Engine Setup Control | /INDICATEPROGRESS Optional |
Pipes verbose Setup log to the console. |
Database Engine Setup Control | /INSTANCEID Optional |
InstanceID used during PrepareImage. Required before SQL Server 2012 SP1 CU2. |
Database Engine Setup Control | /INSTANCENAME Optional |
SQL Server instance name for completion. See Instance Configuration. Required before SQL Server 2012 SP1 CU2. |
Database Engine Setup Control | /PRODUCTCOVEREDBYSA Required, for AZUREEXTENSION (SQL Server 2022+) |
Specifies license coverage for SQL Server when installing Azure Extension. /PRODUCTCOVEREDBYSA=True (or just /PRODUCTCOVEREDBYSA ) for Software Assurance/Subscription. /PRODUCTCOVEREDBYSA=False (or omitted) for standard SQL Server license. |
Database Engine Setup Control | /PID Optional |
Product key for SQL Server edition. Evaluation edition used if omitted. Predefined for Express, Developer, and Evaluation editions. |
Database Engine Setup Control | /Q or /QUIET Optional |
Runs Setup in full quiet mode (no UI). Overrides /QS . |
Database Engine Setup Control | /QS or /QUIETSIMPLE Optional |
Runs Setup in quiet simple mode (progress UI, no input/errors). Only with /ACTION=INSTALL . |
Database Engine Setup Control | /SQMREPORTING Optional (SQL Server 2014 and earlier) |
Configures feature usage reporting. See How to configure SQL Server 2016 (13.x) to send feedback. Values: 1 (enabled), 0 (disabled). |
Database Engine Setup Control | /HIDECONSOLE Optional |
Hides or closes the console window. |
SQL Server Agent | /AGTSVCACCOUNT Required |
Account for SQL Server Agent service. |
SQL Server Agent | /AGTSVCPASSWORD Required |
Password for SQL Server Agent service account. Omit for managed, virtual, or built-in accounts. |
SQL Server Agent | /AGTSVCSTARTUPTYPE Optional |
Startup mode for SQL Server Agent service. Values: Automatic , Disabled , Manual . |
PolyBase Engine | /PBENGSVCACCOUNT Optional |
Account for PolyBase Engine service. Default: NT AUTHORITYNETWORK SERVICE . |
PolyBase Data Movement | /PBDMSSVCPASSWORD Optional |
Password for PolyBase Data Movement service account. Omit for managed, virtual, or built-in accounts. |
PolyBase Engine | /PBENGSVCSTARTUPTYPE Optional |
Startup mode for PolyBase Engine service. Values: Automatic (default), Disabled , Manual . |
PolyBase | /PBPORTRANGE Optional |
Port range (at least 6 ports) for PolyBase services. Example: /PBPORTRANGE=16450-16460 . |
PolyBase | /PBSCALEOUT Optional |
Whether the SQL Server Database Engine instance is part of a PolyBase Scale-out group. Values: True , False . |
SQL Server Browser | /BROWSERSVCSTARTUPTYPE Optional |
Startup mode for SQL Server Browser service. 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 |
Data directory for SQL Server data files. Defaults vary based on WOW mode. |
SQL Server Database Engine | /SAPWD Required, if /SECURITYMODE=SQL |
Password for the SQL Server SA account when using SQL security mode. |
SQL Server Database Engine | /SECURITYMODE Optional |
Security mode for SQL Server. Default: Windows-only authentication. Value: SQL (mixed mode). |
SQL Server Database Engine | /SQLBACKUPDIR Optional |
Directory for backup files. Default: <installsqldatadir><sqlinstanceid>MSSQLBackup</sqlinstanceid></installsqldatadir> . |
SQL Server Database Engine | /SQLCOLLATION Optional |
Collation settings for SQL Server. Default: OS locale. See Collation and Unicode support. |
SQL Server Database Engine | /SQLSVCACCOUNT Required |
Startup account for SQL Server service. |
SQL Server Database Engine | /SQLSVCPASSWORD Required |
Password for SQLSVCACCOUNT . Omit for managed, virtual, or built-in accounts. |
SQL Server Database Engine | /SQLSVCSTARTUPTYPE Optional |
Startup mode for SQL Server service. Values: Automatic , Disabled , Manual . |
SQL Server Database Engine | /SQLSYSADMINACCOUNTS Required |
Logins to provision as sysadmin role members. Required for non-Express editions. Required with /ADDCURRENTUSERASSQLADMIN or /SQLSYSADMINACCOUNTS . |
SQL Server Database Engine | /SQLTEMPDBDIR Optional |
Directories for tempdb data files (space-separated for multiple directories). Default: <installsqldatadir><sqlinstanceid>MSSQLData</sqlinstanceid></installsqldatadir> . |
SQL Server Database Engine | /SQLTEMPDBLOGDIR Optional |
Directory for tempdb log file. Default: <installsqldatadir><sqlinstanceid>MSSQLData</sqlinstanceid></installsqldatadir> . |
SQL Server Database Engine | /SQLTEMPDBFILESIZE Optional (SQL Server 2016+) |
Initial size of each tempdb data file in MB. Default: 4MB (Express), 8MB (other). Min: 4MB/8MB, Max: 1024MB. |
SQL Server Database Engine | /SQLTEMPDBFILEGROWTH Optional |
File growth increment of tempdb data files in MB. 0 disables autogrowth. Default: 64MB. Range: 0-1024MB. |
SQL Server Database Engine | /SQLTEMPDBLOGFILESIZE Optional (SQL Server 2016+) |
Initial size of tempdb log file in MB. Max: 1024MB. Default: 4MB (Express), 8MB (other). Range: default-1024MB. |
SQL Server Database Engine | /SQLTEMPDBLOGFILEGROWTH Optional (SQL Server 2016+) |
File growth increment of tempdb log file in MB. 0 disables autogrowth. Default: 64MB. Range: 0-1024MB. |
SQL Server Database Engine | /SQLTEMPDBFILECOUNT Optional |
Number of tempdb data files. Default: 1 (Express), 8 or cores (other editions). Max: cores. Not supported for Express. |
SQL Server Database Engine | /SQLUSERDBDIR Optional |
Directory for user database data files. Default: <installsqldatadir><sqlinstanceid>MSSQLData</sqlinstanceid></installsqldatadir> . |
SQL Server Database Engine | /SQLUSERDBLOGDIR Optional |
Directory for user database log files. Default: <installsqldatadir><sqlinstanceid>MSSQLData</sqlinstanceid></installsqldatadir> . |
FILESTREAM | /FILESTREAMLEVEL Optional |
Access level for FILESTREAM feature. Values: 0 (disable, default), 1 (Transact-SQL access), 2 (Transact-SQL and file I/O streaming access), 3 (remote client streaming access). |
FILESTREAM | /FILESTREAMSHARENAME Optional |
Windows share name for FILESTREAM data. Required if FILESTREAMLEVEL > 1. |
SQL Server Full Text | /FTSVCACCOUNT Optional |
Account for Full-Text filter launcher service. Ignored in Windows Server 2008+. Default: Local Service Account. |
SQL Server Full Text | /FTSVCPASSWORD Optional |
Password for Full-Text filter launcher service. Ignored in Windows Server 2008+. Omit for managed, virtual, or built-in accounts. |
SQL Server Network Configuration | /NPENABLED Optional |
State of Named Pipes protocol. Values: 0 (disable), 1 (enable). |
SQL Server Network Configuration | /TCPENABLED Optional |
State of TCP protocol. Values: 0 (disable), 1 (enable). |
Reporting Services | /RSINSTALLMODE Optional (SQL Server 2016 and earlier) |
Install mode for Reporting Services. Values: SharePointFilesOnlyMode , DefaultNativeMode , FilesOnlyMode . Default: DefaultNativeMode (with DB Engine), FilesOnlyMode (without DB Engine). |
Reporting Services | /RSSVCACCOUNT Required (SQL Server 2016 and earlier) |
Startup account for Reporting Services. |
Reporting Services | /RSSVCPASSWORD Required (SQL Server 2016 and earlier) |
Password for Reporting Services service account. Omit for managed, virtual, or built-in accounts. |
Reporting Services | /RSSVCStartupType Optional (SQL Server 2016 and earlier) |
Startup mode for Reporting Services. Values: Automatic , Disabled , Manual . |
Complete Image Syntax Example
To complete a prepared standalone instance with Database Engine, Replication, and Full-Text Search:
setup.exe /q /ACTION=CompleteImage /INSTANCENAME=MYNEWINST /INSTANCEID=<myinst> /SQLSVCACCOUNT="<domainname>" /SQLSVCPASSWORD="<strongpassword>" /SQLSYSADMINACCOUNTS="<domainname>" /AGTSVCACCOUNT="NT AUTHORITYNETWORK SERVICE" /IACCEPTSQLSERVERLICENSETERMS
Upgrade Parameters
Use these parameters for command-line SQL Server upgrades.
SQL Server Database Engine Component | Parameter | Description |
---|---|---|
Database Engine Setup Control | /ACTION Required |
Specifies the installation workflow. Values: Upgrade , EditionUpgrade . EditionUpgrade for upgrading SQL Server edition. See Supported version and edition upgrades. |
Database Engine Setup Control | /IACCEPTSQLSERVERLICENSETERMS Required, with /Q or /QS |
Acknowledges acceptance of the license terms. Review terms at aka.ms/useterms. |
Database Engine Setup Control | /ENU Optional |
Installs the English version on localized OS when the media contains language packs for both English and the OS language. |
Database Engine Setup Control | /UpdateEnabled Optional |
Enables or disables product update discovery and inclusion. Values: True /False or 1 /0 . Default: True (updates included). |
Database Engine Setup Control | /UpdateSource Optional |
Specifies the update source location. Values: "MU" (Microsoft Update), folder path, relative path (e.g., .MyUpdates ), or UNC share. Default: Microsoft Update or Windows Update Service via WSUS. |
Database Engine Setup Control | /CONFIGURATIONFILE Optional |
Specifies the ConfigurationFile to use. |
Database Engine Setup Control | /ERRORREPORTING Optional (SQL Server 2014 and earlier) |
Configures error feedback to Microsoft. See How to configure SQL Server 2016 (13.x) to send feedback. Values: 1 (enabled), 0 (disabled). Refer to SQL Server privacy supplement. |
Database Engine Setup Control | /HELP or ? Optional |
Displays parameter usage options. |
Database Engine Setup Control | /INDICATEPROGRESS Optional |
Pipes verbose Setup log to the console. |
Database Engine Setup Control | /INSTANCEDIR Optional |
Non-default installation directory for shared components. |
Database Engine Setup Control | /INSTANCEID Optional |
InstanceID. Required for upgrades from SQL Server 2008+. Optional from SQL Server 2005. |
Database Engine Setup Control | /INSTANCENAME Required |
SQL Server Database Engine instance name. See Instance Configuration. |
Database Engine Setup Control | /PID Optional |
Product key for SQL Server edition. Evaluation edition used if omitted. Predefined for Express, Developer, and Evaluation editions. |
Database Engine Setup Control | /Q or /QUIET Optional |
Runs Setup in full quiet mode (no UI). Overrides /QS . |
Database Engine Setup Control | /UIMODE Optional |
Specifies UI verbosity. /UIMODE=Normal (default, all dialogs), /UIMODE=AutoAdvance (fewer dialogs, default for Express). Cannot be used with /Q or /QS . |
Database Engine Setup Control | /SQMREPORTING Optional (SQL Server 2014 and earlier) |
Configures feature usage reporting. See How to configure SQL Server 2016 (13.x) to send feedback. Values: 1 (enabled), 0 (disabled). |
Database Engine Setup Control | /HIDECONSOLE Optional |
Hides or closes the console window. |
SQL Server Browser | /BROWSERSVCSTARTUPTYPE Optional |
Startup mode for SQL Server Browser service. Values: Automatic , Disabled , Manual . |
SQL Server Full-Text | /FTUPGRADEOPTION Optional |
Full-Text catalog upgrade option. Values: REBUILD , RESET , IMPORT . |
Integration Services | /ISSVCACCOUNT Required |
Account for Integration Services. Default: NT AUTHORITYNETWORK SERVICE . |
Integration Services | /ISSVCPASSWORD Required |
Password for Integration Services. Omit for managed, virtual, or built-in accounts. |
Integration Services | /ISSVCStartupType Optional |
Startup mode for Integration Services service. |
Reporting Services | /RSUPGRADEDATABASEACCOUNT Optional |
Account for SharePoint mode Report Server upgrade (version 2008 R2 or earlier). If omitted, default service account is used. Use with /RSUPGRADEPASSWORD . |
Reporting Services | /RSUPGRADEPASSWORD Optional |
Password for existing Report Server service account. Omit for managed, virtual, or built-in accounts. |
Reporting Services | /ALLOWUPGRADEFORSSRSSHAREPOINTMODE |
Required switch for upgrading SharePoint Mode installations based on shared service architecture. Not needed for non-shared service versions. |
Upgrade Syntax Example
To upgrade an existing instance or failover cluster node from a previous SQL Server Database Engine version:
setup.exe /q /ACTION=upgrade /INSTANCEID = <instanceid>/INSTANCENAME=MSSQLSERVER /RSUPGRADEDATABASEACCOUNT="<provide a="" account="" can="" connect="" during="" logon="" report="" server="" sql="" that="" the="" to="" upgrade="">" /RSUPGRADEPASSWORD="<provide a="" account="" for="" password="" report="" server="" the="" upgrade="">" /ISSVCAccount="NT AUTHORITYNETWORK SERVICE" /IACCEPTSQLSERVERLICENSETERMS
Repair Parameters
Use these parameters to repair an existing SQL Server installation.
SQL Server Database Engine Component | Parameter | Description |
---|---|---|
Database Engine Setup Control | /ACTION Required |
Specifies the repair workflow. Value must be Repair . |
Database Engine Setup Control | /ENU Optional |
Installs the English version on localized OS when the media contains language packs for both English and the OS language. |
Database Engine Setup Control | /FEATURES Required |
Specifies components to repair. |
Database Engine Setup Control | /INSTANCENAME Required |
SQL Server Database Engine instance name. See Instance Configuration. |
PolyBase Engine | /PBENGSVCACCOUNT Optional |
Account for PolyBase Engine service. Default: NT AUTHORITYNETWORK SERVICE . |
PolyBase Data Movement | /PBDMSSVCPASSWORD Optional |
Password for PolyBase Data Movement service account. Omit for managed, virtual, or built-in accounts. |
PolyBase Engine | /PBENGSVCSTARTUPTYPE Optional |
Startup mode for PolyBase Engine service. Values: Automatic (default), Disabled , Manual . |
PolyBase | /PBPORTRANGE Optional |
Port range (at least 6 ports) for PolyBase services. Example: /PBPORTRANGE=16450-16460 . |
PolyBase | /PBSCALEOUT Optional |
Whether the SQL Server Database Engine instance is part of a PolyBase Scale-out group. Values: True , False . |
Database Engine Setup Control | /Q or /QUIET Optional |
Runs Setup in full quiet mode (no UI). Overrides /QS . |
Database Engine Setup Control | /HIDECONSOLE Optional |
Hides or closes the console window. |
Repair Syntax Example
To repair an instance and shared components:
setup.exe /q /ACTION=Repair /INSTANCENAME=<InstanceName>
Rebuild System Database Parameters
These parameters rebuild the master
, model
, msdb
, and tempdb
system databases. See Rebuild system databases.
SQL Server Database Engine Component | Parameter | Description |
---|---|---|
Database Engine Setup Control | /ACTION Required |
Specifies the rebuild database workflow. Value must be RebuildDatabase . |
Database Engine Setup Control | /INSTANCENAME Required |
SQL Server Database Engine instance name. See Instance Configuration. |
Database Engine Setup Control | /Q or /QUIET Optional |
Runs Setup in full quiet mode (no UI). Overrides /QS . |
SQL Server Database Engine | /SQLCOLLATION Optional |
New server-level collation. Default: OS locale. See Collation and Unicode support. |
SQL Server Database Engine | /SAPWD Required, if /SECURITYMODE=SQL |
Password for the SQL Server SA account when using SQL security mode during installation. |
SQL Server Database Engine | /SQLSYSADMINACCOUNTS Required |
Logins to provision as sysadmin role members. Required for non-Express editions. Required with /ADDCURRENTUSERASSQLADMIN or /SQLSYSADMINACCOUNTS . |
SQL Server Database Engine | /SQLTEMPDBDIR Optional |
Directories for tempdb data files (space-separated for multiple directories). Default: <installsqldatadir><sqlinstanceid>MSSQLData</sqlinstanceid></installsqldatadir> . |
SQL Server Database Engine | /SQLTEMPDBLOGDIR Optional |
Directory for tempdb log file. Default: <installsqldatadir><sqlinstanceid>MSSQLData</sqlinstanceid></installsqldatadir> . |
SQL Server Database Engine | /SQLTEMPDBFILECOUNT Optional |
Number of tempdb data files. Default: 1 (Express), 8 or cores (other editions). Max: cores. Not supported for Express. |
SQL Server Database Engine | /SQLTEMPDBFILESIZE Optional (SQL Server 2016+) |
Initial size of each tempdb data file in MB. Default: 4MB (Express), 8MB (other). Min: 4MB/8MB, Max: 1024MB. |
SQL Server Database Engine | /SQLTEMPDBFILEGROWTH Optional |
File growth increment of tempdb data files in MB. 0 disables autogrowth. Default: 64MB. Range: 0-1024MB. |
SQL Server Database Engine | /SQLTEMPDBLOGFILESIZE Optional (SQL Server 2016+) |
Initial size of tempdb log file in MB. Max: 1024MB. Default: 4MB (Express), 8MB (other). Range: default-1024MB. |
SQL Server Database Engine | /SQLTEMPDBLOGFILEGROWTH Optional (SQL Server 2016+) |
File growth increment of tempdb log file in MB. 0 disables autogrowth. Default: 64MB. Range: 0-1024MB. |
Uninstall Parameters
These parameters are used for command-line uninstallation of SQL Server.
SQL Server Database Engine Component | Parameter | Description |
---|---|---|
Database Engine Setup Control | /ACTION Required |
Specifies the uninstall workflow. Value must be Uninstall . |
Database Engine Setup Control | /CONFIGURATIONFILE Optional |
Specifies the ConfigurationFile to use. |
Database Engine Setup Control | /FEATURES Required |
Specifies components to uninstall. |
Database Engine Setup Control | /HELP or ? Optional |
Displays parameter usage options. |
Database Engine Setup Control | /INDICATEPROGRESS Optional |
Pipes verbose Setup log to the console. |
Database Engine Setup Control | /INSTANCENAME Required |
SQL Server Database Engine instance name. See Instance Configuration. |
Database Engine Setup Control | /Q or /QUIET Optional |
Runs Setup in full quiet mode (no UI). Overrides /QS . |
Database Engine Setup Control | /HIDECONSOLE Optional |
Hides or closes the console window. |
Uninstall Syntax Example
To uninstall an existing SQL Server instance:
setup.exe /Action=Uninstall /FEATURES=SQL,AS,RS,IS,Tools /INSTANCENAME=MSSQLSERVER
For named instances, replace “MSSQLSERVER” with the instance name.
Failover Cluster Parameters
Before installing a SQL Server Database Engine failover cluster instance, review Always On Failover Cluster Instances (SQL Server).
Test and adapt the following failover cluster installation scripts to your environment.
Integrated Install Failover Cluster Parameters
These parameters are for integrated failover cluster installations. For more information, see Always On Failover Cluster Instances (SQL Server).
Note: To add nodes later, use the Add Node action.
SQL Server Database Engine Component | Parameter | Details |
---|---|---|
Database Engine Setup Control | /ACTION Required |
Specifies the failover cluster installation workflow. Value must be InstallFailoverCluster . |
Database Engine Setup Control | /IACCEPTSQLSERVERLICENSETERMS Required, with /Q or /QS |
Acknowledges acceptance of the license terms. Review terms at aka.ms/useterms. |
Database Engine Setup Control | /ENU Optional |
Installs the English version on localized OS when the media contains language packs for both English and the OS language. |
Database Engine Setup Control | /FAILOVERCLUSTERGROUP Optional |
Name of the resource group for the SQL Server Database Engine failover cluster. Can be existing or new group name. Default: SQL Server (<instancename>)</instancename> . |
PolyBase Engine | /PBENGSVCACCOUNT Optional |
Account for PolyBase Engine service. Default: NT AUTHORITYNETWORK SERVICE . |
PolyBase Data Movement | /PBDMSSVCPASSWORD Optional |
Password for PolyBase Data Movement service account. Omit for managed, virtual, or built-in accounts. |
PolyBase Engine | /PBENGSVCSTARTUPTYPE Optional |
Startup mode for PolyBase Engine service. Values: Automatic (default), Disabled , Manual . |
PolyBase | /PBPORTRANGE Optional |
Port range (at least 6 ports) for PolyBase services. Example: /PBPORTRANGE=16450-16460 . |
PolyBase | /PBSCALEOUT Optional |
Whether the SQL Server Database Engine instance is part of a PolyBase Scale-out group. Values: True , False . |
Database Engine Setup Control | /UpdateEnabled Optional |
Enables or disables product update discovery and inclusion. Values: True /False or 1 /0 . Default: True (updates included). |
Database Engine Setup Control | /UpdateSource Optional |
Specifies the update source location. Values: "MU" (Microsoft Update), folder path, relative path (e.g., .MyUpdates ), or UNC share. Default: Microsoft Update or Windows Update Service via WSUS. |
Database Engine Setup Control | /CONFIGURATIONFILE Optional |
Specifies the ConfigurationFile to use. |
Database Engine Setup Control | /ERRORREPORTING Optional (SQL Server 2014 and earlier) |
Configures error feedback to Microsoft. See How to configure SQL Server 2016 (13.x) to send feedback. Values: 1 (enabled), 0 (disabled). Refer to SQL Server privacy supplement. |
Database Engine Setup Control | /FEATURES Required |
Specifies components to install. |
Database Engine Setup Control | /HELP or ? Optional |
Displays parameter usage options. |
Database Engine Setup Control | /INDICATEPROGRESS Optional |
Pipes verbose Setup log to the console. |
Database Engine Setup Control | /INSTALLSHAREDDIR Optional |
Non-default directory for 64-bit shared components. Default: %Program Files%Microsoft SQL Server . Cannot be %Program Files(x86)%Microsoft SQL Server . |
Database Engine Setup Control | /INSTALLSHAREDWOWDIR Optional |
Non-default directory for 32-bit shared components (64-bit systems only). Default: %Program Files(x86)%Microsoft SQL Server . Cannot be %Program Files%Microsoft SQL Server . |
Database Engine Setup Control | /INSTANCEDIR Optional |
Non-default installation directory for instance-specific components. |
Database Engine Setup Control | /INSTANCEID Optional |
Non-default InstanceID value. |
Database Engine Setup Control | /INSTANCENAME Required |
SQL Server Database Engine instance name. See Instance Configuration. |
Database Engine Setup Control | /PRODUCTCOVEREDBYSA Required, for AZUREEXTENSION (SQL Server 2022+) |
Specifies license coverage for SQL Server when installing Azure Extension. /PRODUCTCOVEREDBYSA=True (or just /PRODUCTCOVEREDBYSA ) for Software Assurance/Subscription. /PRODUCTCOVEREDBYSA=False (or omitted) for standard SQL Server license. |
Database Engine Setup Control | /PID Optional |
Product key for SQL Server edition. Evaluation edition used if omitted. Predefined for Express, Developer, and Evaluation editions. |
Database Engine Setup Control | /Q or /QUIET Optional |
Runs Setup in full quiet mode (no UI). Overrides /QS . |
Database Engine Setup Control | /QS or /QUIETSIMPLE Optional |
Runs Setup in quiet simple mode (progress UI, no input/errors). Only with /ACTION=INSTALL . |
Database Engine Setup Control | /SQMREPORTING Optional (SQL Server 2014 and earlier) |
Configures feature usage reporting. See How to configure SQL Server 2016 (13.x) to send feedback. Values: 1 (enabled), 0 (disabled). |
Database Engine Setup Control | /HIDECONSOLE Optional |
Hides or closes the console window. |
Database Engine Setup Control | /FAILOVERCLUSTERDISKS Optional |
List of shared disks for the SQL Server Database Engine failover cluster resource group. Default: first drive used for all databases. |
Database Engine Setup Control | /FAILOVERCLUSTERIPADDRESSES Required |
Encoded IP address. Semicolon-delimited format: ;. Supports DHCP, IPv4, IPv6. Multiple IPs space-separated. Examples: FAILOVERCLUSTERIPADDRESSES=DEFAULT , FAILOVERCLUSTERIPADDRESSES=IPv4;DHCP;ClusterNetwork1 , FAILOVERCLUSTERIPADDRESSES=IPv6;2041:0:1a0f::8a5b:131c . |
Database Engine Setup Control | /FAILOVERCLUSTERNETWORKNAME Required |
Network name for the new SQL Server Database Engine failover cluster. Used to identify the FCI on the network. |
SQL Server Agent | /AGTSVCACCOUNT Required |
Account for SQL Server Agent service. |
SQL Server Agent | /AGTSVCPASSWORD Required |
Password for SQL Server Agent service account. Omit for managed, virtual, or built-in accounts. |
Analysis Services | /ASBACKUPDIR Optional |
Directory for Analysis Services backup files. Defaults vary based on WOW mode. |
Analysis Services | /ASCOLLATION Optional |
Collation setting for Analysis Services. Default: Latin1_General_CI_AS . Windows collation only. |
Analysis Services | /ASCONFIGDIR Optional |
Directory for Analysis Services configuration files. Defaults vary based on WOW mode. |
Analysis Services | /ASDATADIR Optional |
Directory for Analysis Services data files. Defaults vary based on WOW mode. |
Analysis Services | /ASLOGDIR Optional |
Directory for Analysis Services log files. Defaults vary based on WOW mode. |
Analysis Services | /ASSYSADMINACCOUNTS Required |
Administrator credentials for Analysis Services. |
Analysis Services | /ASTEMPDIR Optional |
Directory for Analysis Services temporary files. Defaults vary based on WOW mode. |
Analysis Services | /ASPROVIDERMSOLAP Optional |
Whether MSOLAP provider can run in-process. Default: 1 (enabled). |
Analysis Services | /ASSERVERMODE Optional |
Server mode of the Analysis Services instance. Valid values in cluster: MULTIDIMENSIONAL , TABULAR . Case-sensitive, uppercase. See Install Analysis Services in Tabular Mode. |
SQL Server Database Engine | /INSTALLSQLDATADIR Required |
Data directory for SQL Server data files. Must be specified and on a shared cluster disk. |
SQL Server Database Engine | /SAPWD Required, if /SECURITYMODE=SQL |
Password for the SQL Server SA account when using SQL security mode. |
SQL Server Database Engine | /SECURITYMODE Optional |
Security mode for SQL Server. Default: Windows-only authentication. Value: SQL (mixed mode). |
SQL Server Database Engine | /SQLBACKUPDIR Optional |
Directory for backup files. Default: <installsqldatadir><sqlinstanceid>MSSQLBackup</sqlinstanceid></installsqldatadir> . |
SQL Server Database Engine | /SQLCOLLATION Optional |
Collation settings for SQL Server. Default: OS locale. See Collation and Unicode support. |
SQL Server Database Engine | /SQLSVCACCOUNT Required |
Startup account for SQL Server service. |
SQL Server Database Engine | /SQLSVCPASSWORD Required |
Password for SQLSVCACCOUNT . Omit for managed, virtual, or built-in accounts. |
SQL Server Database Engine | /SQLSYSADMINACCOUNTS Required |
Logins to provision as sysadmin role members. Required for non-Express editions. Required with /ADDCURRENTUSERASSQLADMIN or /SQLSYSADMINACCOUNTS . |
SQL Server Database Engine | /SQLUSERDBDIR Optional |
Directory for user database data files. Default: <installsqldatadir><sqlinstanceid>MSSQLData</sqlinstanceid></installsqldatadir> . |
SQL Server Database Engine | /SQLTEMPDBDIR Optional |
Directories for tempdb data files (space-separated for multiple directories). Default: <installsqldatadir><sqlinstanceid>MSSQLData</sqlinstanceid></installsqldatadir> . |
SQL Server Database Engine | /SQLTEMPDBLOGDIR Optional |
Directory for tempdb log file. Default: <installsqldatadir><sqlinstanceid>MSSQLData</sqlinstanceid></installsqldatadir> . |
SQL Server Database Engine | /SQLTEMPDBFILECOUNT Optional |
Number of tempdb data files. Default: 1 (Express), 8 or cores (other editions). Max: cores. Not supported for Express. |
SQL Server Database Engine | /SQLTEMPDBFILESIZE Optional (SQL Server 2016+) |
Initial size of each tempdb data file in MB. Default: 4MB (Express), 8MB (other). Min: 4MB/8MB, Max: 1024MB. |
SQL Server Database Engine | /SQLTEMPDBFILEGROWTH Optional |
File growth increment of tempdb data files in MB. 0 disables autogrowth. Default: 64MB. Range: 0-1024MB. |
SQL Server Database Engine | /SQLTEMPDBLOGFILESIZE Optional (SQL Server 2016+) |
Initial size of tempdb log file in MB. Max: 1024MB. Default: 4MB (Express), 8MB (other). Range: default-1024MB. |
SQL Server Database Engine | /SQLTEMPDBLOGFILEGROWTH Optional (SQL Server 2016+) |
File growth increment of tempdb log file in MB. 0 disables autogrowth. Default: 64MB. Range: 0-1024MB. |
SQL Server Database Engine | /SQLUSERDBLOGDIR Optional |
Directory for user database log files. Default: <installsqldatadir><sqlinstanceid>MSSQLData</sqlinstanceid></installsqldatadir> . |
Reporting Services | /RSINSTALLMODE Optional (SQL Server 2016 and earlier) |
Install mode for Reporting Services. Values: SharePointFilesOnlyMode , DefaultNativeMode , FilesOnlyMode . Default: DefaultNativeMode (with DB Engine), FilesOnlyMode (without DB Engine). |
FILESTREAM | /FILESTREAMLEVEL Optional |
Access level for FILESTREAM feature. Values: 0 (disable, default), 1 (Transact-SQL access), 2 (Transact-SQL and file I/O streaming access), 3 (remote client streaming access). |
FILESTREAM | /FILESTREAMSHARENAME Optional |
Windows share name for FILESTREAM data. Required if FILESTREAMLEVEL > 1. |
SQL Server Full Text | /FTSVCACCOUNT Optional |
Account for Full-Text filter launcher service. Ignored in Windows Server 2008+. Default: Local Service Account. |
SQL Server Full Text | /FTSVCPASSWORD Optional |
Password for Full-Text filter launcher service. Ignored in Windows Server 2008+. Omit for managed, virtual, or built-in accounts. |
Integration Services | /ISSVCACCOUNT Required |
Account for Integration Services. Default: NT AUTHORITYNETWORK SERVICE . |
Integration Services | /ISSVCPASSWORD Required |
Password for Integration Services. Omit for managed, virtual, or built-in accounts. |
Integration Services | /ISSVCStartupType Optional |
Startup mode for Integration Services service. |
Reporting Services | /RSSVCACCOUNT Required (SQL Server 2016 and earlier) |
Startup account for Reporting Services. |
Reporting Services | /RSSVCPASSWORD Required (SQL Server 2016 and earlier) |
Password for Reporting Services service account. Omit for managed, virtual, or built-in accounts. |
Reporting Services | /RSSVCStartupType Optional (SQL Server 2016 and earlier) |
Startup mode for Reporting Services. Values: Automatic , Disabled , Manual . |
We recommend using Service SIDs instead of domain groups for enhanced security.
Additional Notes for Failover Clusters
Only Database Engine and Analysis Services are cluster-aware. Other features lack high availability through failover.
Integrated Install Failover Cluster Syntax Example
To install a single-node SQL Server Database Engine failover cluster instance with Database Engine and Analysis Services (default instance):
setup.exe /q /ACTION=InstallFailoverCluster /InstanceName=MSSQLSERVER /INDICATEPROGRESS /ASSYSADMINACCOUNTS="<domainname>" /ASDATADIR=<drive>:OLAPData /ASLOGDIR=<drive>:OLAPLog /ASBACKUPDIR=<drive>:OLAPBackup /ASCONFIGDIR=<drive>:OLAPConfig /ASTEMPDIR=<drive>:OLAPTemp /FAILOVERCLUSTERDISKS="<cluster disk="" example="" for="" name="" network="" resource="" s:="">" /FAILOVERCLUSTERIPADDRESSES="IPv4;xx.xxx.xx.xx;Cluster Network;xxx.xxx.xxx.x" /FAILOVERCLUSTERGROUP="MSSQLSERVER" /Features=AS,SQL /ASSVCACCOUNT="<domainname>" /ASSVCPASSWORD="xxxxxxxxxxx" /AGTSVCACCOUNT="<domainname>" /AGTSVCPASSWORD="xxxxxxxxxxx" /INSTALLSQLDATADIR="<drive>:<path>MSSQLSERVER" /SQLCOLLATION="SQL_Latin1_General_CP1_CS_AS" /SQLSVCACCOUNT="<domainname>" /SQLSVCPASSWORD="xxxxxxxxxxx" /SQLSYSADMINACCOUNTS="<domainname> /IACCEPTSQLSERVERLICENSETERMS
Prepare Failover Cluster Parameters
These parameters are for the first step in advanced cluster installation: preparing failover cluster instances on all nodes. See Always On Failover Cluster Instances (SQL Server).
SQL Server Database Engine Component | Parameter | Description |
---|---|---|
Database Engine Setup Control | /ACTION Required |
Specifies the failover cluster prepare workflow. Value must be PrepareFailoverCluster . |
Database Engine Setup Control | /IACCEPTSQLSERVERLICENSETERMS Required, with /Q or /QS |
Acknowledges acceptance of the license terms. Review terms at aka.ms/useterms. |
Database Engine Setup Control | /ENU Optional |
Installs the English version on localized OS when the media contains language packs for both English and the OS language. |
Database Engine Setup Control | /UpdateEnabled Optional |
Enables or disables product update discovery and inclusion. Values: True /False or 1 /0 . Default: True (updates included). |
Database Engine Setup Control | /UpdateSource Optional |
Specifies the update source location. Values: "MU" (Microsoft Update), folder path, relative path (e.g., .MyUpdates ), or UNC share. Default: Microsoft Update or Windows Update Service via WSUS. |
Database Engine Setup Control | /CONFIGURATIONFILE Optional |
Specifies the ConfigurationFile to use. |
Database Engine Setup Control | /ERRORREPORTING Optional (SQL Server 2014 and earlier) |
Configures error feedback to Microsoft. See How to configure SQL Server 2016 (13.x) to send feedback. Values: 1 (enabled), 0 (disabled). Refer to SQL Server privacy supplement. |
Database Engine Setup Control | /FEATURES Required |
Specifies components to install. |
Database Engine Setup Control | /HELP or ? Optional |
Displays parameter usage options. |
Database Engine Setup Control | /INDICATEPROGRESS Optional |
Pipes verbose Setup log to the console. |
Database Engine Setup Control | /INSTALLSHAREDDIR Optional |
Non-default directory for 64-bit shared components. Default: %Program Files%Microsoft SQL Server . Cannot be %Program Files(x86)%Microsoft SQL Server . |
Database Engine Setup Control | /INSTALLSHAREDWOWDIR Optional |
Non-default directory for 32-bit shared components (64-bit systems only). Default: %Program Files(x86)%Microsoft SQL Server . Cannot be %Program Files%Microsoft SQL Server . |
Database Engine Setup Control | /INSTANCEDIR Optional |
Non-default installation directory for instance-specific components. |
Database Engine Setup Control | /INSTANCEID Optional |
Non-default InstanceID value. |
Database Engine Setup Control | /INSTANCENAME Required |
SQL Server Database Engine instance name. See Instance Configuration. |
Database Engine Setup Control | /PID Optional |
Product key for SQL Server edition. Evaluation edition used if omitted. Predefined for Express, Developer, and Evaluation editions. |
Database Engine Setup Control | /Q or /QUIET Optional |
Runs Setup in full quiet mode (no UI). Overrides /QS . |
Database Engine Setup Control | /QS or /QUIETSIMPLE Optional |
Runs Setup in quiet simple mode (progress UI, no input/errors). Only with /ACTION=INSTALL . |
Database Engine Setup Control | /SQMREPORTING Optional (SQL Server 2014 and earlier) |
Configures feature usage reporting. See How to configure SQL Server 2016 (13.x) to send feedback. Values: 1 (enabled), 0 (disabled). |
Database Engine Setup Control | /HIDECONSOLE Optional |
Hides or closes the console window. |
SQL Server Agent | /AGTSVCACCOUNT Required |
Account for SQL Server Agent service. |
SQL Server Agent | /AGTSVCPASSWORD Required |
Password for SQL Server Agent service account. Omit for managed, virtual, or built-in accounts. |
PolyBase Engine | /PBENGSVCACCOUNT Optional |
Account for PolyBase Engine service. Default: NT AUTHORITYNETWORK SERVICE . |
PolyBase Data Movement | /PBDMSSVCPASSWORD Optional |
Password for PolyBase Data Movement service account. Omit for managed, virtual, or built-in accounts. |
PolyBase Engine | /PBENGSVCSTARTUPTYPE Optional |
Startup mode for PolyBase Engine service. Values: Automatic (default), Disabled , Manual . |
PolyBase | /PBPORTRANGE Optional |
Port range (at least 6 ports) for PolyBase services. Example: /PBPORTRANGE=16450-16460 . |
PolyBase | /PBSCALEOUT Optional |
Whether the SQL Server Database Engine instance is part of a PolyBase Scale-out group. Values: True , False . |
Analysis Services | /ASSVCACCOUNT Required |
Account for Analysis Services service. |
Analysis Services | /ASSVCPASSWORD Required |
Password for Analysis Services service account. Omit for managed, virtual, or built-in accounts. |
SQL Server Database Engine | /SQLSVCACCOUNT Required |
Startup account for SQL Server service. |
SQL Server Database Engine | /SQLSVCPASSWORD Required |
Password for SQLSVCACCOUNT . Omit for managed, virtual, or built-in accounts. |
FILESTREAM | /FILESTREAMLEVEL Optional |
Access level for FILESTREAM feature. Values: 0 (disable, default), 1 (Transact-SQL access), 2 (Transact-SQL and file I/O streaming access), 3 (remote client streaming access). |
FILESTREAM | /FILESTREAMSHARENAME Optional |
Windows share name for FILESTREAM data. Required if FILESTREAMLEVEL > 1. |
SQL Server Full Text | /FTSVCACCOUNT Optional |
Account for Full-Text filter launcher service. Ignored in Windows Server 2008+. Default: Local Service Account. |
SQL Server Full Text | /FTSVCPASSWORD Optional |
Password for Full-Text filter launcher service. Ignored in Windows Server 2008+. Omit for managed, virtual, or built-in accounts. |
Integration Services | /ISSVCACCOUNT Required |
Account for Integration Services. Default: NT AUTHORITYNETWORK SERVICE . |
Integration Services | /ISSVCPASSWORD Required |
Password for Integration Services. Omit for managed, virtual, or built-in accounts. |
Integration Services | /ISSVCStartupType Optional |
Startup mode for Integration Services service. |
Reporting Services | /RSINSTALLMODE Optional (SQL Server 2016 and earlier) |
Install mode for Reporting Services. Values: SharePointFilesOnlyMode , DefaultNativeMode , FilesOnlyMode . Default: DefaultNativeMode (with DB Engine), FilesOnlyMode (without DB Engine). |
Reporting Services | /RSSVCACCOUNT Required (SQL Server 2016 and earlier) |
Startup account for Reporting Services. |
Reporting Services | /RSSVCPASSWORD Required (SQL Server 2016 and earlier) |
Password for Reporting Services service account. Omit for managed, virtual, or built-in accounts. |
Reporting Services | /RSSVCStartupType Optional (SQL Server 2016 and earlier) |
Startup mode for Reporting Services. Values: Automatic , Disabled , Manual . |
We recommend using Service SIDs instead of domain groups for enhanced security.
Prepare Failover Cluster Syntax Examples
To prepare a default instance for advanced failover cluster installation:
setup.exe /q /ACTION=PrepareFailoverCluster /InstanceName=MSSQLSERVER /Features=AS,SQL /INDICATEPROGRESS /ASSVCACCOUNT="<domainname>" /ASSVCPASSWORD="xxxxxxxxxxx" /SQLSVCACCOUNT="<domainname>" /SQLSVCPASSWORD="xxxxxxxxxxx" /AGTSVCACCOUNT="<domainname>" /AGTSVCPASSWORD="xxxxxxxxxxx" /IACCEPTSQLSERVERLICENSETERMS
For a named instance preparation:
setup.exe /q /ACTION=PrepareFailoverCluster /InstanceName="<insert instance="" name="">" /Features=AS,SQL /INDICATEPROGRESS /ASSVCACCOUNT="<domainname>" /ASSVCPASSWORD="xxxxxxxxxxx" /SQLSVCACCOUNT="<domainname>" /SQLSVCPASSWORD="xxxxxxxxxxx" /AGTSVCACCOUNT="<domainname>" /AGTSVCPASSWORD="xxxxxxxxxxx" /IACCEPTSQLSERVERLICENSETERMS
Complete Failover Cluster Parameters
These parameters are for the second step of advanced failover cluster install: completing the cluster on the node owning shared disks. See Always On Failover Cluster Instances (SQL Server).
SQL Server Database Engine Component | Parameter | Description |
---|---|---|
Database Engine Setup Control | /ACTION Required |
Specifies the failover cluster complete workflow. Value must be CompleteFailoverCluster . |
Database Engine Setup Control | /ENU Optional |
Installs the English version on localized OS when the media contains language packs for both English and the OS language. |
Database Engine Setup Control | /FAILOVERCLUSTERGROUP Optional |
Name of the resource group for the SQL Server Database Engine failover cluster. Can be existing or new group name. Default: SQL Server (<instancename>)</instancename> . |
Database Engine Setup Control | /CONFIGURATIONFILE Optional |
Specifies the ConfigurationFile to use. |
Database Engine Setup Control | /ERRORREPORTING Optional (SQL Server 2014 and earlier) |
Configures error feedback to Microsoft. See How to configure SQL Server 2016 (13.x) to send feedback. Values: 1 (enabled), 0 (disabled). Refer to SQL Server privacy supplement. |
Database Engine Setup Control | /HELP or ? Optional |
Displays parameter usage options. |
Database Engine Setup Control | /INDICATEPROGRESS Optional |
Pipes verbose Setup log to the console. |
Database Engine Setup Control | /INSTANCENAME Required |
SQL Server Database Engine instance name. See Instance Configuration. |
Database Engine Setup Control | /PID Optional |
Product key for SQL Server edition. Evaluation edition used if omitted. Predefined for Express, Developer, and Evaluation editions. |
Database Engine Setup Control | /Q or /QUIET Optional |
Runs Setup in full quiet mode (no UI). Overrides /QS . |
Database Engine Setup Control | /QS or /QUIETSIMPLE Optional |
Runs Setup in quiet simple mode (progress UI, no input/errors). Only with /ACTION=INSTALL . |
Database Engine Setup Control | /SQMREPORTING Optional (SQL Server 2014 and earlier) |
Configures feature usage reporting. See How to configure SQL Server 2016 (13.x) to send feedback. Values: 1 (enabled), 0 (disabled). |
Database Engine Setup Control | /HIDECONSOLE Optional |
Hides or closes the console window. |
Database Engine Setup Control | /FAILOVERCLUSTERDISKS Optional |
List of shared disks for the SQL Server Database Engine failover cluster resource group. Default: first drive used for all databases. |
Database Engine Setup Control | /FAILOVERCLUSTERIPADDRESSES Required |
Encoded IP address. Semicolon-delimited format: ;. Supports DHCP, IPv4, IPv6. Multiple IPs space-separated. Examples: FAILOVERCLUSTERIPADDRESSES=DEFAULT , FAILOVERCLUSTERIPADDRESSES=IPv4;DHCP;ClusterNetwork1 , FAILOVERCLUSTERIPADDRESSES=IPv6;2041:0:1a0f::8a5b:131c . |
Database Engine Setup Control | /FAILOVERCLUSTERNETWORKNAME Required |
Network name for the new SQL Server Database Engine failover cluster. Used to identify the FCI on the network. |
Database Engine Setup Control | /CONFIRMIPDEPENDENCYCHANGE Required |
Consent to set IP address resource dependency from OR to AND for multi-subnet failover clusters. See Add or Remove Nodes in a SQL Server Database Engine failover Cluster (Setup). Values: 0 (False, default), 1 (True). |
Analysis Services | /ASBACKUPDIR Optional |
Directory for Analysis Services backup files. Defaults vary based on WOW mode. |
Analysis Services | /ASCOLLATION Optional |
Collation setting for Analysis Services. Default: Latin1_General_CI_AS . Windows collation only. |
Analysis Services | /ASCONFIGDIR Optional |
Directory for Analysis Services configuration files. Defaults vary based on WOW mode. |
Analysis Services | /ASDATADIR Optional |
Directory for Analysis Services data files. Defaults vary based on WOW mode. |
Analysis Services | /ASLOGDIR Optional |
Directory for Analysis Services log files. Defaults vary based on WOW mode. |
Analysis Services | /ASSERVERMODE Optional |
Server mode of the Analysis Services instance. Valid values in cluster: MULTIDIMENSIONAL , TABULAR . Case-sensitive, uppercase. See Install Analysis Services in Tabular Mode. |
Analysis Services | /ASSYSADMINACCOUNTS Required |
Administrator credentials for Analysis Services. |
Analysis Services | /ASTEMPDIR Optional |
Directory for Analysis Services temporary files. Defaults vary based on WOW mode. |
Analysis Services | /ASPROVIDERMSOLAP Optional |
Whether MSOLAP provider can run in-process. Default: 1 (enabled). |
SQL Server Database Engine | /INSTALLSQLDATADIR Required |
Data directory for SQL Server data files. Must be specified and on a shared cluster disk. |
SQL Server Database Engine | /SAPWD Required, if /SECURITYMODE=SQL |
Password for the SQL Server SA account when using SQL security mode. |
SQL Server Database Engine | /SECURITYMODE Optional |
Security mode for SQL Server. Default: Windows-only authentication. Value: SQL (mixed mode). |
SQL Server Database Engine | /SQLBACKUPDIR Optional |
Directory for backup files. Default: <installsqldatadir><sqlinstanceid>MSSQLBackup</sqlinstanceid></installsqldatadir> . |
SQL Server Database Engine | /SQLCOLLATION Optional |
Collation settings for SQL Server. Default: OS locale. See Collation and Unicode support. |
SQL Server Database Engine | /SQLSYSADMINACCOUNTS Required |
Logins to provision as sysadmin role members. Required for non-Express editions. Required with /ADDCURRENTUSERASSQLADMIN or /SQLSYSADMINACCOUNTS . |
SQL Server Database Engine | /SQLUSERDBDIR Optional |
Directory for user database data files. Default: <installsqldatadir><sqlinstanceid>MSSQLData</sqlinstanceid></installsqldatadir> . |
SQL Server Database Engine | /SQLUSERDBLOGDIR Optional |
Directory for user database log files. Default: <installsqldatadir><sqlinstanceid>MSSQLData</sqlinstanceid></installsqldatadir> . |
Reporting Services | /RSINSTALLMODE Optional (SQL Server 2016 and earlier) |
Install mode for Reporting Services. Values: SharePointFilesOnlyMode , DefaultNativeMode , FilesOnlyMode . Default: DefaultNativeMode (with DB Engine), FilesOnlyMode (without DB Engine). |
SQL Server Database Engine | /SQLTEMPDBDIR Optional |
Directories for tempdb data files (space-separated for multiple directories). Default: <installsqldatadir><sqlinstanceid>MSSQLData</sqlinstanceid></installsqldatadir> . |
SQL Server Database Engine | /SQLTEMPDBLOGDIR Optional |
Directory for tempdb log file. Default: <installsqldatadir><sqlinstanceid>MSSQLData</sqlinstanceid></installsqldatadir> . |
SQL Server Database Engine | /SQLTEMPDBFILECOUNT Optional |
Number of tempdb data files. Default: 1 (Express), 8 or cores (other editions). Max: cores. Not supported for Express. |
SQL Server Database Engine | /SQLTEMPDBFILESIZE Optional (SQL Server 2016+) |
Initial size of each tempdb data file in MB. Default: 4MB (Express), 8MB (other). Min: 4MB/8MB, Max: 1024MB. |
SQL Server Database Engine | /SQLTEMPDBFILEGROWTH Optional |
File growth increment of tempdb data files in MB. 0 disables autogrowth. Default: 64MB. Range: 0-1024MB. |
SQL Server Database Engine | /SQLTEMPDBLOGFILESIZE Optional (SQL Server 2016+) |
Initial size of tempdb log file in MB. Max: 1024MB. Default: 4MB (Express), 8MB (other). Range: default-1024MB. |
SQL Server Database Engine | /SQLTEMPDBLOGFILEGROWTH Optional (SQL Server 2016+) |
File growth increment of tempdb log file in MB. 0 disables autogrowth. Default: 64MB. Range: 0-1024MB. |
Complete Failover Cluster Syntax Examples
To complete failover cluster installation for a default instance:
setup.exe /q /ACTION=CompleteFailoverCluster /InstanceName=MSSQLSERVER /INDICATEPROGRESS /ASSYSADMINACCOUNTS="<domainname>" /ASDATADIR=<drive>:OLAPData /ASLOGDIR=<drive>:OLAPLog /ASBACKUPDIR=<drive>:OLAPBackup /ASCONFIGDIR=<drive>:OLAPConfig /ASTEMPDIR=<drive>:OLAPTemp /FAILOVERCLUSTERDISKS="<cluster disk="" example="" for="" name="" resource="" s:="">:" /FAILOVERCLUSTERNETWORKNAME="<insert foi="" name="" network="">" /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>"
For a named instance completion:
setup.exe /q /ACTION=CompleteFailoverCluster /InstanceName="<insert instance="" name="">" /INDICATEPROGRESS /ASSYSADMINACCOUNTS="<domainname>" /ASDATADIR=<drive>:INSTANCEData /ASLOGDIR=<drive>:INSTANCELog /ASBACKUPDIR=<drive>:INSTANCEBackup /ASCONFIGDIR=<drive>:INSTANCEConfig /ASTEMPDIR=<drive>:INSTANCETemp /FAILOVERCLUSTERDISKS="<cluster disk="" example="" for="" name="" resource="" s:="">" /FAILOVERCLUSTERNETWORKNAME="CompNamedFOI" /FAILOVERCLUSTERIPADDRESSES="IPv4;xx.xxx.xx.xx;ClusterNetwork1;xxx.xxx.xxx.x" /FAILOVERCLUSTERGROUP="<insert group="" name="" new="">" /INSTALLSQLDATADIR="<drive>:<path>MSSQLSERVER_INSTANCE" /SQLCOLLATION="SQL_Latin1_General_CP1_CS_AS" /SQLSYSADMINACCOUNTS="<domainname>"
Upgrade Failover Cluster Parameters
These parameters are for upgrading SQL Server Database Engine failover clusters. See Upgrade a SQL Server Database Engine failover Cluster Instance (Setup) and Always On Failover Cluster Instances (SQL Server).
SQL Server Database Engine Component | Parameter | Description |
---|---|---|
Database Engine Setup Control | /ACTION Required |
Specifies the installation workflow. Value must be Upgrade . |
Database Engine Setup Control | /IACCEPTSQLSERVERLICENSETERMS Required, with /Q or /QS |
Acknowledges acceptance of the license terms. Review terms at aka.ms/useterms. |
Database Engine Setup Control | /ENU Optional |
Installs the English version on localized OS when the media contains language packs for both English and the OS language. |
Database Engine Setup Control | /UpdateEnabled Optional |
Enables or disables product update discovery and inclusion. Values: True /False or 1 /0 . Default: True (updates included). |
Database Engine Setup Control | /UpdateSource Optional |
Specifies the update source location. Values: "MU" (Microsoft Update), folder path, relative path (e.g., .MyUpdates ), or UNC share. Default: Microsoft Update or Windows Update Service via WSUS. |
Database Engine Setup Control | /CONFIGURATIONFILE Optional |
Specifies the ConfigurationFile to use. |
Database Engine Setup Control | /ERRORREPORTING Optional (SQL Server 2014 and earlier) |
Configures error feedback to Microsoft. See How to configure SQL Server 2016 (13.x) to send feedback. Values: 1 (enabled), 0 (disabled). Refer to SQL Server privacy supplement. |
Database Engine Setup Control | /HELP or ? Optional |
Displays parameter usage options. |
Database Engine Setup Control | /INDICATEPROGRESS Optional |
Pipes verbose Setup log to the console. |
Database Engine Setup Control | /INSTANCEDIR Optional |
Non-default installation directory for shared components. |
Database Engine Setup Control | /INSTANCEID Optional |
InstanceID. Required for upgrades from SQL Server 2008+. Optional from SQL Server 2005. |
Database Engine Setup Control | /INSTANCENAME Required |
SQL Server Database Engine instance name. See Instance Configuration. |
Database Engine Setup Control | /PID Optional |
Product key for SQL Server edition. Evaluation edition used if omitted. Predefined for Express, Developer, and Evaluation editions. |
Database Engine Setup Control | /Q or /QUIET Optional |
Runs Setup in full quiet mode (no UI). Overrides /QS . |
Database Engine Setup Control | /SQMREPORTING Optional (SQL Server 2014 and earlier) |
Configures feature usage reporting. See How to configure SQL Server 2016 (13.x) to send feedback. Values: 1 (enabled), 0 (disabled). |
Database Engine Setup Control | /HIDECONSOLE Optional |
Hides or closes the console window. |
Database Engine Setup Control | /FAILOVERCLUSTERROLLOWNERSHIP Required |
Failover behavior during upgrade. |
SQL Server Browser | /BROWSERSVCSTARTUPTYPE Optional |
Startup mode for SQL Server Browser service. Values: Automatic , Disabled , Manual . |
SQL Server Full-Text | /FTUPGRADEOPTION Optional |
Full-Text catalog upgrade option. Values: REBUILD , RESET , IMPORT . |
Integration Services | /ISSVCACCOUNT Required |
Account for Integration Services. Default: NT AUTHORITYNETWORK SERVICE . |
Integration Services | /ISSVCPASSWORD Required |
Password for Integration Services. Omit for managed, virtual, or built-in accounts. |
Integration Services | /ISSVCStartupType Optional |
Startup mode for Integration Services service. |
Reporting Services | /RSUPGRADEDATABASEACCOUNT Optional |
Account for SharePoint mode Report Server upgrade (version 2008 R2 or earlier). If omitted, default service account is used. Use with /RSUPGRADEPASSWORD . |
Reporting Services | /RSUPGRADEPASSWORD Optional |
Password for existing Report Server service account. Omit for managed, virtual, or built-in accounts. |
Add Node Parameters
Use these parameters to add nodes to an existing SQL Server failover cluster.
SQL Server Database Engine Component | Parameter | Description |
---|---|---|
Database Engine Setup Control | /ACTION Required |
Specifies the AddNode workflow. Value must be AddNode . |
Database Engine Setup Control | /IACCEPTSQLSERVERLICENSETERMS Required, with /Q or /QS |
Acknowledges acceptance of the license terms. Review terms at aka.ms/useterms. |
Database Engine Setup Control | /ENU Optional |
Installs the English version on localized OS when the media contains language packs for both English and the OS language. |
Database Engine Setup Control | /UpdateEnabled Optional |
Enables or disables product update discovery and inclusion. Values: True /False or 1 /0 . Default: True (updates included). |
Database Engine Setup Control | /UpdateSource Optional |
Specifies the update source location. Values: "MU" (Microsoft Update), folder path, relative path (e.g., .MyUpdates ), or UNC share. Default: Microsoft Update or Windows Update Service via WSUS. |
Database Engine Setup Control | /CONFIGURATIONFILE Optional |
Specifies the ConfigurationFile to use. |
Database Engine Setup Control | /HELP or ? Optional |
Displays parameter usage options. |
Database Engine Setup Control | /INDICATEPROGRESS Optional |
Pipes verbose Setup log to the console. |
Database Engine Setup Control | /INSTANCENAME Required |
SQL Server Database Engine instance name. See Instance Configuration. |
Database Engine Setup Control | /PID Optional |
Product key for SQL Server edition. Evaluation edition used if omitted. Predefined for Express, Developer, and Evaluation editions. |
Database Engine Setup Control | /Q or /QUIET Optional |
Runs Setup in full quiet mode (no UI). Overrides /QS . |
Database Engine Setup Control | /QS or /QUIETSIMPLE Optional |
Runs Setup in quiet simple mode (progress UI, no input/errors). Only with /ACTION=INSTALL . |
Database Engine Setup Control | /HIDECONSOLE Optional |
Hides or closes the console window. |
Database Engine Setup Control | /FAILOVERCLUSTERIPADDRESSES Required |
Encoded IP address. Semicolon-delimited format: ;. Supports DHCP, IPv4, IPv6. Multiple IPs space-separated. Examples: FAILOVERCLUSTERIPADDRESSES=DEFAULT , FAILOVERCLUSTERIPADDRESSES=IPv4;DHCP;ClusterNetwork1 , FAILOVERCLUSTERIPADDRESSES=IPv6;2041:0:1a0f::8a5b:131c . See Add or Remove Nodes in a SQL Server Database Engine failover Cluster (Setup). |
Database Engine Setup Control | /CONFIRMIPDEPENDENCYCHANGE Required |
Consent to set IP address resource dependency from OR to AND for multi-subnet failover clusters. See Add or Remove Nodes in a SQL Server Database Engine failover Cluster (Setup). Values: 0 (False, default), 1 (True). |
SQL Server Agent | /AGTSVCACCOUNT Required |
Account for SQL Server Agent service. |
SQL Server Agent | /AGTSVCPASSWORD Required |
Password for SQL Server Agent service account. Omit for managed, virtual, or built-in accounts. |
PolyBase Engine | /PBENGSVCACCOUNT Optional |
Account for PolyBase Engine service. Default: NT AUTHORITYNETWORK SERVICE . |
PolyBase Data Movement | /PBDMSSVCPASSWORD Optional |
Password for PolyBase Data Movement service account. Omit for managed, virtual, or built-in accounts. |
PolyBase Engine | /PBENGSVCSTARTUPTYPE Optional |
Startup mode for PolyBase Engine service. Values: Automatic (default), Disabled , Manual . |
PolyBase | /PBPORTRANGE Optional |
Port range (at least 6 ports) for PolyBase services. Example: /PBPORTRANGE=16450-16460 . |
PolyBase | /PBSCALEOUT Optional |
Whether the SQL Server Database Engine instance is part of a PolyBase Scale-out group. Values: True , False . |
Analysis Services | /ASSVCACCOUNT Required |
Account for Analysis Services service. |
Analysis Services | /ASSVCPASSWORD Required |
Password for Analysis Services service account. Omit for managed, virtual, or built-in accounts. |
SQL Server Database Engine | /SQLSVCACCOUNT Required |
Startup account for SQL Server service. |
SQL Server Database Engine | /SQLSVCPASSWORD Required |
Password for SQLSVCACCOUNT . Omit for managed, virtual, or built-in accounts. |
Integration Services | /ISSVCPASSWORD Required |
Password for Integration Services. Omit for managed, virtual, or built-in accounts. |
Reporting Services | /RSINSTALLMODE Optional (SQL Server 2016 and earlier) |
Install mode for Reporting Services. Values: SharePointFilesOnlyMode , DefaultNativeMode , FilesOnlyMode . Default: DefaultNativeMode (with DB Engine), FilesOnlyMode (without DB Engine). |
Reporting Services | /RSSVCPASSWORD Required (SQL Server 2016 and earlier) |
Password for Reporting Services service account. Omit for managed, virtual, or built-in accounts. |
Additional Notes for Add Node
Only Database Engine and Analysis Services are cluster-aware. Other features lack high availability through failover.
Add Node Syntax Example
To add a node to an existing failover cluster instance with Database Engine and Analysis Services:
setup.exe /q /ACTION=AddNode /INSTANCENAME="<insert instance="" name="">" /SQLSVCACCOUNT="<sql account="" is="" nodes="" on="" other="" that="" used="">" /SQLSVCPASSWORD="<password account="" for="" sql="">" /AGTSVCACCOUNT="<sql account="" agent="" is="" nodes="" on="" other="" server="" that="" used="">", /AGTSVCPASSWORD="<sql account="" agent="" password="" server="">" /ASSVCACCOUNT="<as account="" is="" nodes="" on="" other="" that="" used="">" /ASSVCPASSWORD="<password account="" as="" for="">" /INDICATEPROGRESS /IACCEPTSQLSERVERLICENSETERMS /FAILOVERCLUSTERIPADDRESSES="IPv4;xx.xxx.xx.xx;ClusterNetwork1;xxx.xxx.xxx.x" /CONFIRMIPDEPENDENCYCHANGE=0
Remove Node Parameters
Use these parameters to remove nodes from a SQL Server failover cluster. To uninstall a cluster, run RemoveNode on each node. See Always On Failover Cluster Instances (SQL Server).
SQL Server Database Engine Component | Parameter | Description |
---|---|---|
Database Engine Setup Control | /ACTION Required |
Specifies the RemoveNode workflow. Value must be RemoveNode . |
Database Engine Setup Control | /CONFIGURATIONFILE Optional |
Specifies the ConfigurationFile to use. |
Database Engine Setup Control | /HELP or ? Optional |
Displays parameter usage options. |
Database Engine Setup Control | /INDICATEPROGRESS Optional |
Pipes verbose Setup log to the console. |
Database Engine Setup Control | /INSTANCENAME Required |
SQL Server Database Engine instance name. See Instance Configuration. |
Database Engine Setup Control | /Q or /QUIET Optional |
Runs Setup in full quiet mode (no UI). Overrides /QS . |
Database Engine Setup Control | /QS or /QUIETSIMPLE Optional |
Runs Setup in quiet simple mode (progress UI, no input/errors). Only with /ACTION=INSTALL . |
Database Engine Setup Control | /HIDECONSOLE Optional |
Hides or closes the console window. |
Database Engine Setup Control | /CONFIRMIPDEPENDENCYCHANGE Required |
Consent to set IP address resource dependency from OR to AND for multi-subnet failover clusters. See Add or Remove Nodes in a SQL Server Database Engine failover Cluster (Setup). Values: 0 (False, default), 1 (True). |
Remove Node Syntax Example
To remove a node from an existing failover cluster instance with Database Engine and Analysis Services:
setup.exe /q /ACTION=RemoveNode /INSTANCENAME="<insert instance="" name="">" [/INDICATEPROGRESS] /CONFIRMIPDEPENDENCYCHANGE=0
Service Account Parameters
Configure SQL Server services using built-in, local, or domain accounts.
Note: Omit password parameters when using managed service accounts, virtual accounts, or built-in accounts. See Managed service accounts, group-managed service accounts, and virtual accounts.
For detailed service account configuration, see Configure Windows service accounts and permissions.
SQL Server Database Engine 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 |
Note: Reporting Services features are removed from SQL Server 2017 (14.x) onwards. Account parameters for Reporting Services are only applicable to prior versions.
Feature Parameters
Use /FEATURES
to install specific features, specifying parent or feature values from the table below.
For a list of features supported by SQL Server editions on Windows, see Editions and features of SQL Server 2022.
Parent Feature Parameter | Feature Parameter | Description |
---|---|---|
SQL | Installs Database Engine, Replication, Fulltext, and Data Quality Server. | |
SQLEngine | Installs only the SQL Server Database Engine. | |
Replication | Installs Replication component with Database Engine. | |
FullText | Installs FullText component with Database Engine. | |
DQ | Copies files for Data Quality Server installation (requires DQSInstaller.exe to complete). Installs Database Engine. | |
PolyBase | Installs PolyBase components. | |
PolyBaseCore | PolyBaseCore |
PolyBase technology for integrated querying across Oracle, Teradata, SQL Server. (SQL Server 2019+) |
PolyBaseJava | PolyBaseJava |
PolyBase Java Connector for integrated querying across HDFS data. (SQL Server 2019 only) |
AdvancedAnalytics | Installs SQL Server Machine Learning Services or SQL Server 2016 R Services (In-Database). | |
SQL_INST_MR | SQL_INST_MR |
Installs R Open and proprietary R packages with AdvancedAnalytics. (SQL Server Machine Learning Services/2016 R Services) |
SQL_INST_MPY | SQL_INST_MPY |
Installs Anaconda and proprietary Python packages with AdvancedAnalytics. (SQL Server Machine Learning Services) |
SQL_INST_JAVA | SQL_INST_JAVA |
Installs Java integration extensions with AdvancedAnalytics. (SQL Server Java Language Extension – 2019 only) |
AS | Installs all Analysis Services components. | |
RS | Installs all Reporting Services components. (SQL Server 2016 and earlier) | |
RS_SHP | RS_SHP |
Installs Reporting Services components for SharePoint. (SQL Server 2016 and earlier) |
RS_SHPWFE | RS_SHPWFE |
Installs Reporting Services Add-In for SharePoint products. (SQL Server 2016 and earlier) |
DQC | Installs Data Quality Client. | |
IS | Installs all Integration Services components. | |
IS_Master | IS_Master |
Includes Scale Out Master for Integration Services Scale Out. |
IS_Worker | IS_Worker |
Includes Scale Out Worker for Integration Services Scale Out. |
MDS | Installs Master Data Services. | |
SQL_SHARED_MPY | SQL_SHARED_MPY |
Installs Python packages for Machine Learning Server (Standalone) or R Server (Standalone). |
SQL_SHARED_MR | SQL_SHARED_MR |
Installs R packages for Machine Learning Server (Standalone) or R Server (Standalone). |
Tools | Installs client tools and SQL Server Books Online. (SQL Server 2019 and earlier) | |
BC | Installs backward compatibility components. (SQL Server 2019 and earlier) | |
Conn | Installs connectivity components. (SQL Server 2019 and earlier) | |
DREPLAY_CTLR | DREPLAY_CTLR |
Installs Distributed Replay controller. (SQL Server 2019 and earlier) |
DREPLAY_CLT | DREPLAY_CLT |
Installs Distributed Replay client. (SQL Server 2019 and earlier) |
SNAC_SDK | SNAC_SDK |
Installs SDK for SQL Server Native Client. (SQL Server 2019 and earlier) |
SDK | Installs the software development kit. (SQL Server 2019 and earlier) | |
LocalDB | LocalDB |
Installs LocalDB, SQL Server Express execution mode for program developers. |
Note: SQL Server Management Studio (SSMS) is now a separate installer. See Download SQL Server Management Studio (SSMS).
Feature Parameter Examples
Parameter and Values | Description |
---|---|
/FEATURES=SQLEngine |
Installs Database Engine without replication/full-text. |
/FEATURES=SQLEngine,FullText |
Installs Database Engine and full-text. |
/FEATURES=SQL |
Installs Database Engine, replication, and full-text. |
/FEATURES=SQLEngine,PolyBase |
Installs Database Engine and PolyBase engine. |
Role Parameters
The /ROLE
parameter installs preconfigured feature sets. SSAS roles install an SSAS instance in SharePoint farms (existing or new unconfigured). Choose only one role at a time. Feature selection for roles is fixed. See Install Power Pivot from the Command Prompt.
AllFeatures_WithDefaults
is default for SQL Server Express, reducing dialogs. Usable for non-Express editions from command line.
| Role | Description