FineBuild Run Time Parameters

Previous Tools Parameters	FineBuild Setup Parameters Next

This page lists the parameters that may be required when running SQL FineBuild.

This list is divided into three sections:

• Common Run Time Parameters
• Vol Parameters
• Less Frequent Run Time Parameters

Common Run Time Parameters

It is normal for some of the parameters below to be required:

Parameter	Usage
/AGTSVCAccount:	See SQL Service Accounts
/AGTSVCPassword:	See SQL Service Accounts
/ASSVCAccount:	See SQL Service Accounts
/ASSVCPassword:	See SQL Service Accounts
/ClusterTCP:	See Cluster IP Address Allocation
/CmdShellAccount:	See Configure xp_cmdshell Proxy Account
/CmdShellPassword:	See Configure xp_cmdshell Proxy Account
/Debug:	Turns on debug facilities. Default: NO
/GroupDBA:	Windows group for DBAs with Sysadmin access. Default: GBGGDBAS01
/GroupDBANonSA:	Windows group for DBAs who do not have Sysadmin access. Default: GBGGDBAN01
/IAcceptLicenseTerms	The use of this parameter means you accept the license conditions of FineBuild and the license conditions of all products installed by FineBuild.
/Instance:	SQL Server instance name. Default: MSSQLSERVER
/ISSVCAccount:	SQL Service Accounts
/ISSVCPassword:	SQL Service Accounts
/ManagementServer:	See Configure Management Data Warehouse
/PID:	PID for the SQL Server edition being installed
/Restart:	Process Id to restart at after a failure. /Restart:Yes will restart at point of failure
/RSEMail:	Sending Email Address for SSRS Reports
/RSSVCAccount:	See SQL Service Accounts
/RSSVCPassword:	See SQL Service Accounts
/SAPwd:	Password for the sa account
/SQLEmail:	Sending Email Address for SQL DBMail
/SQLSVCAccount:	See SQL Service Accounts
/SQLSVCPassword:	See SQL Service Accounts
/SqlTempdbFileCount:	Number of files for tempdb
/SqlTempdbFileSize:	Size of each tempdb Data File
/SqlTempdbLogFileSize:	Size of tempdb Log File
/SSISPassword:	Password for SSIS Catalog DB
/Type:	Type of SQL FineBuild build. Can be Client, Full, FullProg, Workstation, Fix
/UseFreeSSMS:	Use Free Standalone SSMS for SQL2014 or below

Top

---

Vol Parameters

The /Vol... parameters are used to describe the volumes to be used in the SQL Server install process. Each of the standard builds (Server, Workstation, Client) has its own list of Vol... keywords that can be included in any of the BuildServer, BuildWorkstation or BuildClient nodes in the Config file, or specified as run-time parameters. The same volume can be used in multiple Vol... keywords, but SQL Server performance can be maximised spreading the expected I-O load across as many volumes as possible.

The /Vol... parameters use a system of inherited default values. This both allows the minimum number of these parameters to be supplied, and provides full flexibility in assigning the volumes which are to be used. The table below shows the full list of /Vol... parameters, along with their inheritance tree and description.

In order to maintain compatibility with older versions of SQL FineBuild, the parameter syntax /Drvxxx (eg /DrvSys) can also be used.

In the table below, a single volume should be given for each parameter used, except where noted otherwise. If a given /Vol... parameter is not supplied, it will take the value of the first volume given to its parent parameter in the hierarchy. This means that if no /Vol... parameters are supplied, all files will be installed on to the Windows System volume.

Parameter	Default	Usage
/VolSys:	System Drive	Will always be the Windows System Drive
/VolProg:	VolSys	SQL Server program files
/VolBackup:	VolProg	Database backup files
/VolBackupAS	VolBackup	SQL AS database backup files
/VolData:	VolProg	SQL DB database data (MDF) files. See Note 1
/VolDataAS:	VolData	SQL AS database data files
/VolDataFS:	VolData	SQL Server Filestream files
/VolDataFT:	VolData	SQL Server Full Text files
/VolSysDB:	VolData	System DB Files
/VolLog:	VolData	SQL DB database log (LDF) files
/VolLogAS:	VolLog	SQL AS database log files
/VolLogTemp:	VolLog	SQL tempdb log files
/VolTemp:	VolData	SQL tempdb data files. See Note 1
/VolTempAS:	VolTemp	AS temporary files
/VolBPE:	VolTemp	SQL Bufferpool Extension File
/VolDBA:	VolProg	DBA Miscellaneous files
/VolDTC:	(none)	DTC Cluster files (Only relevant for cluster install)
/VolDRU:	VolDBA	Distributed Replay files
/VolTempWin:	VolProg	Windows \Temp folder

Note 1: Multiple values can be given for these parameters where Drive Letters or CSVs are used. Multiple CSVs must be separated by a comma, but this is optional where Drive Letters are used (e.g. /VolData:K,J or /VolData:KJ)

The value that can be given to a /Vol... parameter will depend on the version of SQL Server that is being installed. SQL FineBuild supports all of the following types of volumes in the install process, but will fail if a volume type is specified that is not valid for the SQL Server version (e.g. SQL Server 2005 cannot be installed to a Network Share)

Volume types should not be mixed for a given parameter, but different parameters can specify different volume types.

Volume Type	Comment
Drive Letter	Windows drive letters. Specify individual letters, without the : suffix
CSV	Cluster Shared Volume. Specify the full path to the required folder
Share	Network Share. Specify the share name and any required path
URL	URL. Specify the URL name only

Top

---

Less Frequent Run Time Parameters

The parameters in the list below are not often required.

Parameter	Usage
/Action:	See SQL Server Cluster Install
/AgtDomainGroup:	See BOL for details
/AGTSVCStartupType:	See BOL for details. Default: Automatic
/ASDomainGroup:	See BOL for details
/BrowserSVCAccount:	See SQL Service Accounts
/BrowserSVCPassword:	See SQL Service Accounts
/CatalogServer:	Server\Instance name where RS Catalog is found. Default: current instance
/CltSVCAccount:	See Setup Distributed Replay
/CltSVCPassword:	See Setup Distributed Replay
/CltStartupType:	See Setup Distributed Replay
/ClusASIPSuffix:	See Cluster IP Address Allocation
/ClusDBIPSuffix:	See Cluster IP Address Allocation
/ClusDTCIPSuffix:	See Cluster IP Address Allocation
/ClusterPassive:	See Service Pack documentation for details
/Config:	Name of FineBuild Configuration file. Default: SQL....Config.xml
/CtlrSVCAccount:	See Setup Distributed Replay
/CtlrSVCPassword:	See Setup Distributed Replay
/CtlrStartuptype:	See Setup Distributed Replay
/DBAEmail:	Email address for the SQL Alerts mailbox. Default: GroupDBA value
/DistributorPassword:	See Install Replication Distributor
/DrvSizex:	Minimum size required for drive x. Value may be given in MB, GB or TB. E.G. /DrvSizeG:500MB
/DrvSpacex:	Minimum free space required for drive x. Value may be given in MB, GB or TB. E.G. /DrvSpaceJ:50GB
/ENU:	See BOL for details
/FailoverClusterRollOwnership:	See BOL for details
/FarmAccount:	See BOL for details
/FarmPassword:	See BOL for details
/FarmAdminIPort:	See BOL for details
/FileStreamShareName:	See BOL for details. Default: FS_instancename_
/FTSVCAccount:	See SQL Service Accounts
/FTSVCPassword:	See SQL Service Accounts
/FTUpgradeOption:	See BOL for details
/LabelPrefix:	Prefix to add to Volume Labels
/Mailserver:	See Configure Database Mail
/MaxDop:	See Configure SQL Instance Advanced Properties
/MDWAccount:	See Configure Management Data Warehouse
/MDWPassword:	See Configure Management Data Warehouse
/NetNameSource:	Switch to base Network Names on existing Cluster or Server names
/Passphrase:	See BOL for details
/PathAddComp:	See SQL Media Alternative Folder Names
/PathSQLMedia:	See SQL Media Alternative Folder Names
/PathSQLSP:	See SQL Media Alternative Folder Names
/PreferredOwner:	See SQL FineBuild Cluster Overview
/Role:	See BOL for details
/RSExecAccount:	See Configure Reporting Services Unattended Execution Account
/RSExecPassword:	See Configure Reporting Services Unattended Execution Account
/RSUpgradeDatabaseAccount:	See BOL for details
/RSUpgradeDatabasePassword:	See BOL for details
/saName:	See Configure SA Account
/SecurityMode:	See Configure SQL Instance Security Properties
/SPLevel:	Service Pack to be installed. Default: Most recent SP at time of FineBuild release
/SPCULevel:	Cumulative Update to be installed. Default: Most recent CU at time of FineBuild release
/SQLDomainGroup:	See BOL for details
/SQLTempdbFileCount:	Number of data files for tempdb
/SSISRetention:	Number of days to retain information in SSISDB
/StopAt:	Process Id to force a stop. Normally only used for debugging
/UserLogin01:	to /UserLogin99: see Configure User Accounts
/UserPassword01:	to /UserPassword99: see Configure User Accounts
/UseSysDB:	See BOL for details
/Validate:	Controls FineBuild validation. Use a value of NO to suppress validation
/WinLogin01:	to /WinLogin99: see Configure User Accounts
/X86:	See BOL for details. Also required by FineBuild for SQL 2005 when installing x86 media on a 64-bit server

Copyright FineBuild Team © 2014 - 2021. License and Acknowledgements

Previous Tools Parameters	Top	FineBuild Setup Parameters Next