Parameters

To view the list of parameters for PrepareServer.exe, launch it without any parameters.

Parameter

Required/Optional

Description

Deploy!RootPath Required The root drive or folder in which the Communications Manager installation will be created.
Deploy!Docker Optional Boolean flag that specifies whether special configuration for Docker will be used. If omitted, defaults to False.
Internal!HostName Required The internal host name of the Communications Manager server. This must match with the Subject Alternative Name of the internal certificate.
InternalPorts!StartAt Required The starting point for the ports that must be opened on the internal Communications Manager network.
PrivatePorts!StartAt Required The starting point for the ports that do not need to be opened on any network.
Services!User Required The user account to run the Windows services of Communications Manager. You can specify a domain user account or a local user account.

When specifying a local user, place a period and backslash (.\) at the beginning.

Example: .\AdminUser.

Services!Password Required The password for the Communications Manager services user account.
Webserver!ServiceUser Optional. When omitted, the web services account is not configured. The user account to run the web applications of Communications Manager. You can specify a domain user account or a local user account.

When specifying a local user, place a period and backslash (.\) at the beginning of the parameter.

Example: .\WebUser.

Webserver!ServicePassword Required when Webserver!ServiceUser has a value. Not permitted otherwise. The password for the account to run the web applications of Communications Manager.
Java!Home Optional. When omitted, the Java installation is not configured. The folder in which Java is installed in your system, either as JRE or JDK. This Java installation is used for the Communications Manager web applications.
Tomcat!Home Optional. When omitted, the Tomcat installation is not configured. The folder in which Tomcat is installed in your system. This Tomcat installation is used for the Communications Manager web applications.
Security!TLSVersions Optional The versions of the TLS protocol that are supported for encrypted connections. Possible values are:
  • TLS_11_12_13. Allows TLS 1.1, TLS 1.2 and TLS 1.3 .
  • TLS_11_12. Allows TLS 1.1 and TLS 1.2 .
  • TLS_13. Allows TLS 1.3 .

    At the moment, Microsoft Word does not support TLS 1.3. If you use TLS 1.3 only, you cannot open Word documents in Communication Manager Designer.

When omitted, defaults to TLS_11_12_13.

TLS 1.3 requires support in Java, and support in .NET on the server OS. If you choose to use TLS_13 only, make sure that these requirements are met.
Security!TrustInternalServers Optional If True, the certificate chain validation for connections between Communications Manager components and the host name validation are suppressed. This way you can enable encrypted internal SSL connections without validating the identity of the internal server through the server certificate.

The parameter's default value is False.

PublicCertificate!KeystoreFile Optional. When omitted, the public certificate is not configured. The location of the SSL certificate file for securing connections to the Contract Manager.
PublicCertificate!KeystorePassword Required when PublicCertificate!KeystoreFile has a value. Not permitted otherwise. The password of the SSL certificate file for the Contract Manager.
PublicPorts!ContractManager Optional. When omitted, the Contract Manager port is not configured. The main access port for the Contract Manager to use.
PublicPorts!ControlCenter Optional. When omitted, Communications Manager Control Center is not configured.

Should be omitted, if Deploy!Docker is set to True.

The port for Communications Manager Control Center.
InternalCertificate!KeystoreFile Required. Should be omitted, if Deploy!Docker is set to True. The location of the internal SSL certificate file. For more information about internal certificates, refer to the following topic: Generate self-signed internal certificates.
InternalCertificate!KeystorePassword Required. Should be omitted, if Deploy!Docker is set to True. The password of the internal SSL certificate file. For more information about internal certificates, refer to the following topic: Generate self-signed internal certificates.
InternalCertificate!Thumbprint Required. Should be omitted, if Deploy!Docker is set to True. The thumbprint of the internal SSL certificate in the Windows certificate store. For more information about internal certificates, refer to the following topic: Generate self-signed internal certificates.