Silent installing
When running a silent installation, Qlik Sense is installed with no dialogs at all. This means all features, properties and user selections have to be known before performing a silent installation. All setup options that are available in the user interface of the installer can be performed with silent operations.
Do the following:
-
Select Start > All Programs > Accessories > Command Prompt.
The Command Prompt window is displayed.
-
In the Command Prompt window, navigate to the folder containing the Qlik_Sense_setup.exe file.
-
Enter Qlik_Sense_setup.exe followed by the silent installation syntax preferred.
Syntax
Qlik_Sense_setup.exe [-silent] [-uninstall] {-log path\filename} {layout=path} {accepteula=1|0} {desktopshortcut=1|0} {skipstartservices=1|0} {installdir=path} {userwithdomain=domain\user} {userpassword=password} {dbpassword=password} {hostname=www.machinename.domain.com} {cleanup=1|0} {sharedpersistenceconfig="configfilepath"} {senddata=1|0} {skipvalidation=1|0} {databasedumpfile=path} | - |
---|---|
Qlik_Sense_setup.exe -? or -h | Brings up the on-screen silent setup help. |
Commands
Command | Type | Purpose |
---|---|---|
-silent (or -s) | - | Command line-driven setup without UI (mandatory). |
-uninstall | - | Uninstall the product silently. It must be used with -silent command. |
-log (or -l) | [log file name with path] |
Log file directory and log file name. Information noteThe user must have access to this directory.
|
-layout | [destination directory] |
Extracts files (including .msi files) to the destination directory.
Information noteThis argument should not be combined with other command line arguments.
|
Arguments
Arguments are separated by a space and presented in the form [Argument]="[Value]". The double quotes can normally be omitted but may be needed, for example, when a path contains spaces.
The default values are the same as those used in the setup user interface.
Argument | Values | Purpose |
---|---|---|
accepteula | 1|0 |
Accepts the Qlik User License Agreement. Warning noteThis argument is mandatory when installing or upgrading, and you must accept the QULA to install successfully.
|
desktopshortcut | 1|0 (defaults to 1 on clean installs) | Installs desktop shortcuts. |
skipstartservices | 1|0 (defaults to 0 on clean installs, otherwise the current state.) |
Skips starting services after the installation has finished. |
installdir | [path to custom install directory] | Defines the directory if the default install directory will not be used (%ProgramFiles%\Qlik\Sense). |
userwithdomain | [domain\username] | Adds the username to run the Qlik Sense services. |
userpassword | [password] | Adds the password torun the services. |
dbpassword | [password] | Adds the password for the database superuser that creates the user that runs the database. |
hostname | [address of the central node] | Define the address for the central node. The central node uses certificates to communicate securely with other servers. Leave blank to use the default. |
cleanup | 1|0 (defaults to 0 on uninstall) |
Deletes Qlik Sense certificates and any files in the ProgramData\Qlik\Sense directory after the uninstall is completed. Information noteThis argument must be used with the silent install commands.
Example: -silent -uninstall cleanup=1. |
sharedpersistenceconfig (or spc) | [path to configuration file including the filename] |
Activates setup of shared persistence as storage method. All settings for shared persistence must be in the configuration file referenced here. Warning noteThis is a parameter must be configured to install successfully.
|
senddata | 1|0 (defaults to 0) | Shares system data with Qlik in anonymous form. |
skipvalidation | 1|0 (defaults to 0) | Skips password validation process for service user and shared folder access. For silent installation, database connection tests are also skipped. |
databasedumpfile | [path to database dump file] | Sets path database backup dump file. |
bundleinstall | dashboard,visualization | Includes the dashboard and visualization bundles. |
Example 1: To install Qlik Sense
Qlik_Sense_setup.exe -s spc="\\configpath\spc.cfg" userwithdomain=mydomain\myUser userpassword=myPassword dbpassword=mydbpassword accepteula=1
Example 2: To install Qlik Sense while redirecting the installation and log files to a different location
Qlik_Sense_setup.exe -s -l c:\mylogpath spc="\\configpath\spc.cfg" installdir=c:\mycustompath userwithdomain=mydomain\myUser userpassword=myPassword dbpassword=mydbpassword accepteula=1
Shared persistence configuration file syntax
Configure the shared persistence storage model using the sharedpersistenceconfig argument and point to a configuration file that contains the settings to be used in the installation.
Example:
Qlik_Sense_setup.exe -s spc="\\configpath\spc.cfg" userwithdomain=domain\yourserviceuser userpassword=yourserviceuserpassword dbpassword=yoursuperuserpassword accepteula=1
The configuration file is in XML format. You need to create the file according to the example described here.
<?xml version="1.0"?>
<SharedPersistenceConfiguration xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<DbUserName>username</DbUserName>
<DbUserPassword>password</DbUserPassword>
<DbHost>IP or Hostname</DbHost>
<DbPort>4432</DbPort>
<RootDir>\\server\share</RootDir>
<StaticContentRootDir>\\server\share\StaticContent</StaticContentRootDir>
<ArchivedLogsDir>\\server\share\ArchivedLogs</ArchivedLogsDir>
<AppsDir>\\server\share\Apps</AppsDir>
<CreateCluster>true</CreateCluster>
<InstallLocalDb>false</InstallLocalDb>
<ConfigureDbListener>true</ConfigureDbListener>
<ListenAddresses>*</ListenAddresses>
<IpRange>0.0.0.0/0,::/0</IpRange>
<MaxConnections>100</MaxConnections>
<!--<JoinCluster>true</JoinCluster>-->
<HttpPortNumber>80</HttpPortNumber>
<HttpsPortNumber>443</HttpsPortNumber>
<EnableHttpPort>false</EnableHttpPort>
<DbMaximumConnectionPoolSize>90</DbMaximumConnectionPoolSize>
</SharedPersistenceConfiguration>
Configuration file syntax
Setting | Description |
---|---|
DbUserName | User name of the repository database user. |
DbUserPassword | Password of the repository database user. |
DbHost | Hostname of the machine running the repository database. |
DbPort | Port used to communicate with the repository database. |
RootDir | Root directory for the file share to use as content storage. We recommend that you keep the content in this folder's sub-directories, but this can be changed in the StaticContentRootDir and ArchivedLogsDir settings. |
AppsDir | Directory to store apps in. |
StaticContentRootDir | Root directory for all static content of the site. |
ArchivedLogsDir | Directory to save archived log files in. |
CreateCluster
JoinCluster |
Set CreateCluster to true if you want to create a new cluster, or set JoinCluster to true if you want to join an existing cluster. You can only use one of these settings in the configuration file. The other setting needs to be removed, or commented out like <!--<JoinCluster>true</JoinCluster>-->. |
InstallLocalDb | Set to true if you want to install a local PostgreSQL database on the node when you create a new cluster. This setting can only be used together with the CreateCluster setting. |
ConfigureDbListener |
Set to true if you want to configure the PostgreSQL database installed by Qlik Sense to listen to database connections from other nodes. You need to configure the ListenAddresses and IpRange settings. |
ListenAddresses |
Addresses that the database service should listen to. You can supply a comma separated list of IPv4 or IPv6 addresses, or 0.0.0.0 (for all IPv4 addresses), ::/0 (for all IPv6 addresses) or * (for all addresses). |
IpRange | Subnet specification that covers the IP addresses of all nodes in your site. Either add one row for each node, using /32 as suffix for each address, or add a subnet that covers all addresses using, for example, /24 as suffix. To allow all servers to access the repository database, use 0.0.0.0/0. If entering multiple IP addresses or ranges, use a comma separated list. A range can be either IPv4 or IPv6. |
MaxConnections | Specify the maximum number of concurrent connections to the database. The default value is 100. If you have a multi-node site multiple this value by the number of nodes in the cluster. For example, <MaxConnections>100</MaxConnections> is a single server deployment. |
HttpPortNumber | Listening port when using http. Default port: 80. |
HttpsPortNumber | Listening port when using https.Default port: 443. |
EnableHttpPort | By default, the https port is used. Select EnableHttpPort to use the http port. |
DbMaximumConnectionPoolSize | Maximum connection pool size for the repository database. Minimum value: 90, maximum value:1000. |
Deprecated command line arguments
The use of the following command line arguments is no longer recommended.
Argument | Purpose |
---|---|
rimnode | Determines the Repository role. |
-rimnodetype (or -rnt) |
Installs all the features required for the rim node type selected. The node type can be any one of: Complete, Proxy, Engine, Scheduler. |
SetupLocalLoggingDb | Centralized logging |
QLogsWriterPassword | Centralized logging |
QLogsReaderPassword | Centralized logging |
QLogsHostname | Centralized logging |
QLogsPort | Centralized logging |