Unattended installations

The following Public Properties are available for the Setup and Sync Tool:

Property	Value	Description
DBCREATE	YES or NO (default)	Specify if a new database should be created using the specified values. The default value is NO: leave out this property if you do not want to create a new Datastore.
DBTYPE	MSSQL, DB2*, ORACLE*, MYSQL or MSSQLAZURE	Specify the database type. Example: DBTYPE=MSSQL
DBSERVER	[SERVERNAME]	Specify the database server that hosts the Datastore. If the database server uses instances, use the format: server\instance. Unattended installations on instances in which this format isn't used, will fail. Example: DBSERVER=SQLServer01
DBNAME	[DATABASENAME]	Specify the name of the Datastore that you want to connect to or want to create. Example: DBNAME=IDDB
DBCREATEUSER	[USERNAME]	Specify the database user account that has the rights to create new databases and logins. This must be an existing SQL user. Use this property only when you create a new Datastore. Example: DBCREATEUSER=SA
DBCREATEPASSWORD	[PASSWORD]	Specify the plain text database password that should be used to create the new database. Use this property only when you create a new Datastore. Example: DBCREATEPASSWORD=SAPassword
DBUSER	[DBUSERNAME]	Specify the database user account that can connect to the database. Only needed when using SQL authentication. When you create a new Datastore, a new user account is created with this name. To configure Windows Authentication for the database connection, this property must have an empty value or not be included at all.. Example: DBUSER=IDUser
DBPASSWORD	[DBPASSWORD]	Specify the corresponding plain text password of DBUSER. Only needed when using SQL authentication. Example: DBPASSWORD=IDUserP@ssw0rd
DBPROTOCOLENCRYPTION	DISABLED, ENABLEDWITHOUTVALIDATECERTIFICATE, or ENABLEDWITHVALIDATECERTIFICATE (default) YES or NO are also supported, for backwards compatibility.	Specify if protocol encryption should be used (Microsoft SQL Server database systems only). The preferred, default value is ENABLEDWITHVALIDATECERTIFICATE, in which protocol encryption is used and the server’s certificate is validated; if the server does not present a valid certificate, the connection fails ENABLEDWITHOUTVALIDATECERTIFICATE and YES both use protocol encryption, but the connection succeeds even if the server does not present a valid certificate DISABLED and NO do not use protocol encryption
INITEMPTYDB	TRUE	Specify if the (existing) database you are connecting to is empty and must be initialized for use as an Identity DirectorDatastore. This property is not necessary if the database is being created during installation.
DBIMPORTLICENSE	[FILEPATH]	Specify a license file that should be imported after the Datastore has been created (optional). Example: DBIMPORTLICENSE="C:\TEMP\License.xml"

Examples, using data from the table above

• Install the Setup and Sync Tool and:
  • connect to an existing database;
  • use the default value for DBPROTOCOLENCRYPTION;
  • initialize the database for use as a Datastore
  • import a license
  
  msiexec /i "C:\TEMP\Identity Director Setup Sync Tool (x64) [version].msi" /q /l*v "C:\TEMP\Install-IDSST.log" DBTYPE=MSSQL DBSERVER=SQLServer01 DBNAME=IDDB DBUSER=IDUser DBPASSWORD=IDUserP@ssw0rd INITEMPTYDB=TRUE DBIMPORTLICENSE="C:\TEMP\License.xml"
  • If the database does not yet exist, it will NOT be created.
  • If the user (DBUSER) does not have sufficient permissions, the database will not be initialized
• Install the Setup and Sync Tool and:
  • connect to an existing Datastore;
  • use protocol encryption when connecting to the database, without validating the certificate
  
  msiexec /i "C:\TEMP\Identity Director Setup Sync Tool (x64) [version].msi" /q /l*v "C:\TEMP\Install-IDSST.log" DBTYPE=MSSQL DBSERVER=SQLServer01 DBNAME=IDDB DBUSER=IDUser DBPASSWORD=IDUserP@ssw0rd DBPROTOCOLENCRYPTION=enabledwithoutvalidatecertificate
  • If the database does not yet exist, it will NOT be created.
• Install the Setup and Sync Tool and:
  • create a new Datastore;
  • use Windows authentication and the default value for DBPROTOCOLENCRYPTION when connecting to the database;
  • import a license
  
  msiexec /i "C:\TEMP\Identity Director Setup Sync Tool (x64) [version].msi" /q /l*v "C:\TEMP\Install-IDSST.log" DBCREATE=yes DBTYPE=MSSQL DBSERVER=SQLServer01 DBNAME=IDDB DBCREATEUSER=SA DBCREATEPASSWORD=SAPassword DBUSER= DBIMPORTLICENSE="C:\TEMP\License.xml"

You can also perform the actions listed above after installation of the Setup and Sync Tool. See Command-line options.

The following Public Properties are available for the Transaction Engine:

Property	Value	Description
DBTYPE	MSSQL, DB2*, ORACLE*, MYSQL or MSSQLAZURE	Specify the database type. Example: DBTYPE=MSSQL
DBSERVER	[SERVERNAME]	Specify the database server that hosts the Datastore. If the database server uses instances, use the format: server\instance. Unattended installations on instances in which this format isn't used, will fail. Example: DBSERVER=SQLServer01
DBNAME	[DATABASENAME]	Specify the name of the Datastore that you want to connect to or want to create. Example: DBNAME=IDDB
DBUSER	[DBUSERNAME]	Specify the database user account that can connect to the database. Only needed when using SQL authentication. Example: DBUSER=IDUser
DBPASSWORD	[DBPASSWORD]	Specify the corresponding plain text password of DBUSER. Only needed when using SQL authentication. Example: DBPASSWORD=IDUserP@ssw0rd
DBPROTOCOLENCRYPTION	DISABLED, ENABLEDWITHOUTVALIDATECERTIFICATE, or ENABLEDWITHVALIDATECERTIFICATE (default) YES or NO are also supported, for backwards compatibility.	Specify if protocol encryption should be used (Microsoft SQL Server database systems only). The preferred, default value is ENABLEDWITHVALIDATECERTIFICATE, in which protocol encryption is used and the server’s certificate is validated; if the server does not present a valid certificate, the connection fails ENABLEDWITHOUTVALIDATECERTIFICATE and YES both use protocol encryption, but the connection succeeds even if the server does not present a valid certificate DISABLED and NO do not use protocol encryption

Example, using data from the table above

Install the Transaction Engine, and:

• connect to the database;
• use SQL authentication
• use the default value for DBPROTOCOLENCRYPTION

Msiexec /i "C:\TEMP\Identity Director Transaction Engine (x64) [version].msi" /q /l*v "C:\TEMP\Install-IDTE.log" DBTYPE=MSSQL DBSERVER=SQLServer01 DBNAME=IDDB DBUSER=IDUser DBPASSWORD=IDUserP@ssw0rd

The following Public Properties are available for the Web Portal:

Property	Value	Description
DBTYPE	MSSQL, DB2*, ORACLE*, MYSQL or MSSQLAZURE	Specify the database type. Example: DBTYPE=MSSQL
DBSERVER	[SERVERNAME]	Specify the database server that hosts the Datastore. If the database server uses instances, use the format: server\instance. Unattended installations on instances in which this format isn't used, will fail. Example: DBSERVER=SQLServer01
DBNAME	[DATABASENAME]	Specify the name of the Datastore that you want to connect to or want to create. Example: DBNAME=IDDB
DBUSER	[DBUSERNAME]	Specify the database user account that can connect to the database. Only needed when using SQL authentication. Example: DBUSER=IDUser
DBPASSWORD	[DBPASSWORD]	Specify the corresponding plain text password of DBUSER. Only needed when using SQL authentication. Example: DBPASSWORD=IDUserP@ssw0rd
DBPROTOCOLENCRYPTION	DISABLED, ENABLEDWITHOUTVALIDATECERTIFICATE, or ENABLEDWITHVALIDATECERTIFICATE (default) YES or NO are also supported, for backwards compatibility.	Specify if protocol encryption should be used (Microsoft SQL Server database systems only). The preferred, default value is ENABLEDWITHVALIDATECERTIFICATE, in which protocol encryption is used and the server’s certificate is validated; if the server does not present a valid certificate, the connection fails ENABLEDWITHOUTVALIDATECERTIFICATE and YES both use protocol encryption, but the connection succeeds even if the server does not present a valid certificate DISABLED and NO do not use protocol encryption
The following Properties are only needed if the 'RES' site is not yet configured in IIS:
HOST_SSL	[IDENTITYDIRECTORHOST]	Specifies the host name that is used by the Web Portal. The host name that you provide must be known on your internal and external DNS servers. Example: HOST_SSL="ID.EXAMPLE.COM"
PORT_SSL	[IDENTITYDIRECTORPORT]	Specify the port of the Web Portal. The default port is 443: leave out this property if you do not want to use a different port. Example: PORT_SSL="222"
SELECT_CERTIFICATE	INSTALLED or SELFSIGNED	Specify if you want to use a certificate you installed earlier, or a self-signed certificate. There is no default value; if the parameter is missing, the installation will fail. This property was introduced in Identity Director 2020.1
SSL_CERTIFICATE_ THUMBPRINT	[CERTIFICATE]	Specify the production certificate that the Web Portal should use. You can find the certificates on the web server, in IIS. You do not need to use quotes to specify the certificate. Example: SSL_CERTIFICATE_THUMBPRINT= b34b25c35e5b6ba4cc943a69f53ca1f0cb9eb8f5

Example, using data from the table above

Install the Web Portal and:

• connect to the database;
• use Windows authentication and the default value for DBPROTOCOLENCRYPTION when connecting to the database;
• create a binding for the 'RES' site in IIS, which will be reachable at hostname ID.EXAMPLE.COM over port 222, using the specified certificate

msiexec /i "C:\TEMP\Identity Director Web Portal [version].msi" /q /l*v "C:\TEMP\Install-IDWP.log" DBTYPE=MSSQL DBSERVER=SQLServer01 DBNAME=IDDB DBUSER= HOST_SSL="ID.EXAMPLE.COM" PORT_SSL="222" SSL_CERTIFICATE_THUMBPRINT=b34b25c35e5b6ba4cc943a69f53ca1f0cb9eb8f5

The following Public Properties are available for the Management Portal:

Property	Value	Description
DBTYPE	MSSQL, DB2*, ORACLE*, MYSQL or MSSQLAZURE	Specify the database type. Example: DBTYPE=MSSQL
DBSERVER	[SERVERNAME]	Specify the database server that hosts the Datastore. If the database server uses instances, use the format: server\instance. Unattended installations on instances in which this format isn't used, will fail. Example: DBSERVER=SQLServer01
DBNAME	[DATABASENAME]	Specify the name of the Datastore that you want to connect to or want to create. Example: DBNAME=IDDB
DBUSER	[DBUSERNAME]	Specify the database user account that can connect to the database. Only needed when using SQL authentication. Example: DBUSER=IDUser
DBPASSWORD	[DBPASSWORD]	Specify the corresponding plain text password of DBUSER. Only needed when using SQL authentication. Example: DBPASSWORD=IDUserPassword
DBPROTOCOLENCRYPTION	DISABLED, ENABLEDWITHOUTVALIDATECERTIFICATE, or ENABLEDWITHVALIDATECERTIFICATE (default) YES or NO are also supported, for backwards compatibility.	Specify if protocol encryption should be used (Microsoft SQL Server database systems only). The preferred, default value is ENABLEDWITHVALIDATECERTIFICATE, in which protocol encryption is used and the server’s certificate is validated; if the server does not present a valid certificate, the connection fails ENABLEDWITHOUTVALIDATECERTIFICATE and YES both use protocol encryption, but the connection succeeds even if the server does not present a valid certificate DISABLED and NO do not use protocol encryption
ENABLEAPI	YES or NO (default)	Specify if you want to enable the public API. The default value is NO. You can leave out this property if you do not want to enable the API.
The following Properties are only needed if the 'RES' site is not yet configured in IIS:
HOST_SSL	[IDENTITYDIRECTORHOST]	Specifies the host name that is used by the Management Portal. The host name that you provide must be known on your internal and external DNS servers. Example: HOST_SSL="ID.EXAMPLE.COM"
PORT_SSL	[IDENTITYDIRECTORPORT]	Specify the port of the Management Portal. The default port is 443: leave out this property if you do not want to use a different port. Example: PORT_SSL="222"
SSL_CERTIFICATE_ THUMBPRINT	[CERTIFICATE]	Specify the production certificate that the Management Portal should use. You can find the certificates on the web server, in IIS. You do not need to use quotes to specify the certificate. Example: SSL_CERTIFICATE_THUMBPRINT= b34b25c35e5b6ba4cc943a69f53ca1f0cb9eb8f5

Example, using data from the table above

Install the Management Portal and:

• connect to the database;
• use Windows authentication and the default value for DBPROTOCOLENCRYPTION when connecting to the database;
• create a binding for the 'RES' site in IIS, which will be reachable at hostname ID.EXAMPLE.COM over port 222, using the specified certificate

msiexec /i "C:\TEMP\Identity Director Management Portal [version].msi" /q /l*v "C:\TEMP\Install-IDMP.log" DBTYPE=MSSQL DBSERVER=SQLServer01 DBNAME=IDDB DBUSER=IDUser DBPASSWORD=IDUserP@ssw0rd HOST_SSL="ID.EXAMPLE.COM" PORT_SSL="222" SSL_CERTIFICATE_THUMBPRINT=b34b25c35e5b6ba4cc943a69f53ca1f0cb9eb8f5

The following Public Properties are available for the Mobile Gateway:

Property	Value	Description
DBTYPE	MSSQL, DB2*, ORACLE*, MYSQL or MSSQLAZURE	Specify the database type. Example: DBTYPE=MSSQL
DBSERVER	[SERVERNAME]	Specify the database server that hosts the Datastore. If the database server uses instances, use the format: server\instance. Unattended installations on instances in which this format isn't used, will fail. Example: DBSERVER=SQLServer01
DBNAME	[DATABASENAME]	Specify the name of the Datastore that you want to connect to or want to create. Example: DBNAME=IDDB
DBUSER	[DBUSERNAME]	Specify the database user account that can connect to the database. Only needed when using SQL authentication. Example: DBUSER=IDUser
DBPASSWORD	[DBPASSWORD]	Specify the corresponding plain text password of DBUSER. Only needed when using SQL authentication. Example: DBPASSWORD=IDUserP@ssw0rd
DBPROTOCOLENCRYPTION	DISABLED, ENABLEDWITHOUTVALIDATECERTIFICATE, or ENABLEDWITHVALIDATECERTIFICATE (default) YES or NO are also supported, for backwards compatibility.	Specify if protocol encryption should be used (Microsoft SQL Server database systems only). The preferred, default value is ENABLEDWITHVALIDATECERTIFICATE, in which protocol encryption is used and the server’s certificate is validated; if the server does not present a valid certificate, the connection fails ENABLEDWITHOUTVALIDATECERTIFICATE and YES both use protocol encryption, but the connection succeeds even if the server does not present a valid certificate DISABLED and NO do not use protocol encryption
The following Properties are only needed if the 'RES' site is not yet configured in IIS:
HOST_SSL	[IDENTITYDIRECTORHOST]	Specifies the host name that is used by the Web Portal. The host name that you provide must be known on your internal and external DNS servers. Example: HOST_SSL="ID.EXAMPLE.COM"
PORT_SSL	[IDENTITYDIRECTORPORT]	Specify the port of the Web Portal. The default port is 443: leave out this property if you do not want to use a different port. Example: PORT_SSL="222"
SSL_CERTIFICATE_ THUMBPRINT	[CERTIFICATE]	Specify the production certificate that the Web Portal should use. You can find the certificates on the web server, in IIS. You do not need to use quotes to specify the certificate. Example: SSL_CERTIFICATE_THUMBPRINT= b34b25c35e5b6ba4cc943a69f53ca1f0cb9eb8f5

Example, using data from the table above

Install the Mobile Gateway on a server where the RES site is already available, and:

• connect to the database;
• use Windows authentication and the default value for DBPROTOCOLENCRYPTION when connecting to the database;

msiexec /i "C:\TEMP\Identity Director Mobile Gateway [version].msi" /q /l*v "C:\TEMP\Install-IDMG.log" DBTYPE=MSSQL DBSERVER=SQLServer01 DBNAME=IDDB DBUSER=IDUser DBPASSWORD=IDUserP@ssw0rd

The following Public Properties are available for the Windows Client:

Property	Value	Description
MOBILEGATEWAYHOST	[MobileGatewayUrl]	Specify the URL for the Mobile Gateway. This will usually be the hostname configured in the IIS binding for the 'RES' site, followed by /Mobile Example: MOBILEGATEWAYHOST="HTTPS://ID.EXAMPLE.COM/Mobile"
WEBPORTALSHAREDACCESSKEY	[primary_or_secondary_key]	Specify the primary or secondary shared access key that you configured at the Web Portal shared access policy. Example: WEBPORTALSHAREDACCESSKEY="f8QBIxWH93iRire/VW9I1g=="

Example, using data from the table above

Install the Windows Client:
msiexec /i "C:\TEMP\Identity Director Client (x64) [version].msi" /q /l*v "C:\TEMP\Install-IDClient.log" MOBILEGATEWAYHOST="HTTPS://ID.EXAMPLE.COM/Mobile" WEBPORTALSHAREDACCESSKEY="f8QBIxWH93iRire/VW9I1g=="

The following Public Properties are available for the Identity Broker:

Property	Value	Description
DBSERVER	[SERVERNAME]	Specify the database server that hosts the Datastore. If the database server uses instances, use the format: server\instance. Unattended installations on instances in which this format isn't used will fail. Example: DBSERVER=SQLServer01
DBUSER	[DBUSERNAME]	Specify the database user account that can connect to the database. Example: DBUSER=IBUser
DBPASSWORD	[DBPASSWORD]	Specify the corresponding plain text password of DBUSER. Example: DBPASSWORD=IBUserPassword
DBNAME	[DATABASENAME]	Specify the name of the Datastore that you want to connect to. Example: DBNAME=IBDB
DBAUTHTYPE	1 (default) or 2	Specify if the connection to the database should use SQL authentication (1) or Windows authentication (2).
IDBURL	[BASE-URL]	Specify the base-URL for Identity Broker, without protocol (https) or trailing slash (/) Example: IDBURL=SERVER.EXAMPLE.COM
RUNADAUTH	YES	Specify if you want to install the Identity BrokerActive Directory Authentication provider.
RUNWINAUTH	YES	Specify if you want to install the Identity Broker Windows Authentication provider.
The following Properties are only needed if the 'RES' site is not yet configured in IIS:
SELECT_CERTIFICATE	INSTALLED or SELFSIGNED	Specify if you want to use a certificate you installed earlier, or a self-signed certificate. There is no default value; if the parameter is missing, this installation will fail.
TLS_CERTIFICATE_ THUMBPRINT	[THUMBPRINT]	Specify the thumbprint of the installed certificate that Identity Broker should use. Only needed when using SELECT_CERTIFICATE=INSTALLED. Example: TLS_CERTIFICATE_THUMBPRINT= b34b25c35e5b6ba4cc943a69f53ca1f0cb9eb8f5
PORT_TLS	[PORTNUMBER]	Specify the port used for the SSL binding of the Identity Broker. The default port is 443; leave out this property if you do not want to use a different port. Example: PORT_SSL=222

Examples, using data from the table above:

• Install the Identity Broker with:
  • the Active Directory Authentication provider;
  • using SQL authentication for the Identity Broker database;
  • with a site binding using the default port (443) and a self-signed certificate
  
  msiexec /qn /i "C:\TEMP\Identity Broker [version].msi" DBSERVER=SQLServer01 DBUSER=IBUser DBAUTHTYPE=2 DBNAME=IBDB IDBURL=TESTSERVER.EXAMPLE.COM RUNADAUTH=YES SELECT_CERTIFICATE=SELFSIGNED
• Install the Identity Broker with:
  • the Active Directory and Windows Authentication providers;
  • using Windows authentication for the Identity Broker database;
  • with a site binding using port 222 and an installed certificate
  
  msiexec /qn /i "C:\TEMP\Identity Broker [version].msi" DBSERVER=SQLServer01 DBUSER=IBUser DBPASSWORD=IBUserPassword DBAUTHTYPE=1 DBNAME=IBDB IDBURL=SERVER.EXAMPLE.COM RUNADAUTH=YES RUNWINAUTH=YES SELECT_CERTIFICATE=INSTALLED TLS_CERTIFICATE_THUMBPRINT=b34b25c35e5b6ba4cc943a69f53ca1f0cb9eb8f5 PORT_TLS=222

Unattended installation of the Identity Broker does not pre-configure the settings in either Identity Director or Identity Broker. That is only possible using the Identity Director installer (Identity Director Installer [version].exe).

Below is a sample script for a full installation of Identity Director, including Identity Broker:

• Setup & Sync Tool x64
• Transaction Engine x64
• Web Portal (self-signed certificate)
• Management Portal
• Mobile Gateway
• Client x64
• Identity Broker

@echo off

set dbServer=%1

set dbName=%2

set dbAdminUser=%3

set dbAdminPassword=%4

set dbIDUser=%5

set dbIDPassword=%6

echo

echo #####################################################

echo Starting installation...

echo #####################################################

echo Starting installation for Identity Director Setup and Sync Tool

start /wait msiexec /i "Identity Director Setup Sync Tool (x64) [VERSION NUMBER].msi" /q /l*v "Install-IDSST.log" DBCREATE=YES DBCREATEUSER=%dbAdminUser% DBCREATEPASSWORD=%dbAdminPassword% DBTYPE=MSSQL DBSERVER=%dbServer% DBNAME=%dbName% DBUSER=%dbIDUser% DBPASSWORD=%dbIDPassword% DBPROTOCOLENCRYPTION=DISABLED

echo Done!

echo Starting installation for Identity Director Transaction Engine

start /wait msiexec /i "Identity Director Transaction Engine (x64) [VERSION NUMBER].msi" /q /l*v "Install-IDTE.log" DBTYPE=MSSQL DBSERVER=%dbServer% DBNAME=%dbName% DBUSER=%dbIDUser% DBPASSWORD=%dbIDPassword% DBPROTOCOLENCRYPTION=DISABLED

echo Done!

echo Starting installation for Identity Director Web Portal

start /wait msiexec /i "Identity Director Web Portal [VERSION NUMBER].msi" /q /l*v "Install-IDWP.log" DBTYPE=MSSQL DBSERVER=%dbServer% DBNAME=%dbName% DBUSER=%dbIDUser% DBPASSWORD=%dbIDPassword% HOST_SSL="localhost" PORT_SSL="443" SELECT_CERTIFICATE="SELFSIGNED" DBPROTOCOLENCRYPTION=DISABLED

echo Done!

echo Starting installation for Identity Director Management Portal

start /wait msiexec /i "Identity Director Management Portal [VERSION NUMBER].msi" /q /l*v "Install-IDMP.log" DBTYPE=MSSQL DBSERVER=%dbServer% DBNAME=%dbName% DBUSER=%dbIDUser% DBPASSWORD=%dbIDPassword% DBPROTOCOLENCRYPTION=DISABLED

echo Done!

echo Starting installation for Identity Director Mobile Gateway

start /wait msiexec /i "Identity Director Mobile Gateway [VERSION NUMBER].msi" /q /l*v "Install-IDMG.log" DBTYPE=MSSQL DBSERVER=%dbServer% DBNAME=%dbName% DBUSER=%dbIDUser% DBPASSWORD=%dbIDPassword% DBPROTOCOLENCRYPTION=DISABLED

echo Done!

echo Starting installation for Identity Director Windows Client

start /wait msiexec /i "Identity Director Client (x64) [VERSION NUMBER].msi" /q /l*v "Install-IDClient.log" MOBILEGATEWAYHOST="https://localhost/mobile"

echo Done!

echo Starting installation for Identity Broker

start /wait msiexec /i "Identity Broker [VERSION NUMBER].msi" /q /l*v "Install-IB.log" DBSERVER=%dbServer% DBUSER=%dbIDUser% DBPASSWORD=%dbIDPassword% DBAUTHTYPE=1 DBNAME=%dbName% IDBURL=localhost

echo Done!

echo #####################################################

echo Installation finished successfully!

echo #####################################################