Fortinet Document Library

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:


Table of Contents

EMS Administration Guide

Installing FortiClient EMS using the CLI

Installing FortiClient EMS using the CLI allows you to enable certain options during installation, such as customizing the EMS installation directory, using custom port numbers, and so on.

You may need to wrap certain CLI option values in double quotation marks. For example, if the backup directory path includes a space, you must wrap the path in double quotation marks, such as: BackupDir="\\WIN-0888 AHAMILTON\Backup". Do not use single quotation marks.

The following table provides a description of all options available when installing FortiClient EMS using the CLI. These options are case-sensitive:

Option

Description

AllowedWebHostnames

The default value is localhost, 127.0.0.1. To clear this value, first enter AllowedWebHostnames=*, then enter the desired AllowedWebHostnames value. Otherwise, the value that you enter is appended to [localhost, 127.0.0.1], so that AllowedWebHostNames=localhost, 127.0.01, <new_value>.

ApacheServerAdminEmail

Enter the Apache Server administrator's email address. By default, this is admin@yourcompany.com.

BackupDir

Enter the desired backup directory UNC path for SQL Server.

ClientDownloadPort

Enter the HTTP port number. The default is 80.

RemoteManagementPort

Enter the HTTPS port number. The default is 443.

InstallFolder

Specify the directory to install EMS to.

InstallSQL

Controls whether the installer installfs SQL Server Express on the same server as FortiClient EMS. Enter 1 to install SQL Server Express. Otherwise, enter 0. By default, the EMS installation also installs SQL Server Express.

ScriptDB

Controls where the installer attempts to create the database from db scripts. Enter 1 to create the database from db scripts. You should only enter 0 if you have already set up databases on the server and you are only installing EMS components locally.

ServerHostname

Enter the preferred hostname (the remote hostname). The default is the local host.

SQLAuthType

Enter sql.

SQLCmdlineOptions="/INSTANCEDIR"

Enter the desired directory to install SQL Server Express to.

SQLCmdlineOptions="/INSTANCENAME"

Enter the SQL Server instance name.

SQLEncryptConnection

(Optional) Enter yes to encrypt the connection to SQL Server. Otherwise, enter no. The default is yes.

SQLPort

Enter the port number the remote SQL Server instance is listening on. You should configure SQL Server to use a static port number.

SQLServer

If using an instance with a custom name, enter the DSN name of the computer where SQL Server is already installed.

SQLServerInstance

Enter the SQL Server instance name.

SQLService

If using a default database instance, enter the instance name. If using a named database instance, enter mssql$<instance_name>. For example, if your instance is named "database000", enter mssql$database000.

SQLTrustServerCertificate

(Optional) Enter yes to trust the SQL Server certificate on the machine where FortiClient EMS is installed. If entering no, you must install the issuing CA certificate of SQL Server's certificate onto the machine you are connecting FortiClient EMS from.

SQLUser

Enter the SQL username used to connect to the database instance. You must preconfigure this user in SQL Server.

SQLUserPassword

Enter the SQL password used to connect to the database instance.

WindowsUser

Enter the Windows username that EMS services, once installed, uses to connect to the database instance. You must preconfigure this user in SQL Server.

WindowsUserPassword

Enter the Windows password that EMS services, once installed, uses to connect to the database instance.

DBInitialSize

Enter the database initial size. The default value is 30 MB. This option is used exclusively during installation and can be used to override SQL Server model database settings.

DBInitialLogSize

Enter the database initial log size. The default value is 3 MB. This option is used exclusively during installation and can be used to override SQL Server model database settings.

DBGrowth

Enter the database growth value. The default value is 10 MB. This option is used exclusively during installation and can be used to override SQL Server model database settings.

DBLogGrowth

Enter the database log growth rate. The default value is 10%. This option is used exclusively during installation and can be used to override SQL Server model database settings.

DBLoginTimeout

Enter the database login timeout value in seconds.

This option is only useful for remote databases. You must increase DBLoginTimeout if there is ephemerally higher than expected latency between the EMS server and the remote SQL server. However, if this latency is always high, then it is likely that EMS will not perform well. In that case, the latency should be fixed. The default value for this option is 30.

The installer only uses this option when creating/scripting the EMS databases. This option is unused once EMS is installed.

DBQueryTimeout

Enter the database query timeout value in seconds. During installation, a SQL query is used to instruct SQL Server to create a database. The default value for this option is 60. It can take a long time to create the actual database file system due to a slow hard drive.

The installer only uses this option when creating/scripting the EMS databases. This option is unused once EMS is installed.

EPCPort

Enter the default listening port that endpoints connect to. The default value for this option is 8013.

StartServices

The default value of this option is 1. Setting this option to 0 results in the installer not starting EMS services when installation is complete.

SQLServerCheck

The default value of this option is 1. Setting this option to 0 results in the installer skipping its initial SQL server accessibility test. Skipping this test may result in installation or upgrade rollbacks, if the SQL server cannot be reached during installation.

Installing FortiClient EMS using the CLI

Installing FortiClient EMS using the CLI allows you to enable certain options during installation, such as customizing the EMS installation directory, using custom port numbers, and so on.

You may need to wrap certain CLI option values in double quotation marks. For example, if the backup directory path includes a space, you must wrap the path in double quotation marks, such as: BackupDir="\\WIN-0888 AHAMILTON\Backup". Do not use single quotation marks.

The following table provides a description of all options available when installing FortiClient EMS using the CLI. These options are case-sensitive:

Option

Description

AllowedWebHostnames

The default value is localhost, 127.0.0.1. To clear this value, first enter AllowedWebHostnames=*, then enter the desired AllowedWebHostnames value. Otherwise, the value that you enter is appended to [localhost, 127.0.0.1], so that AllowedWebHostNames=localhost, 127.0.01, <new_value>.

ApacheServerAdminEmail

Enter the Apache Server administrator's email address. By default, this is admin@yourcompany.com.

BackupDir

Enter the desired backup directory UNC path for SQL Server.

ClientDownloadPort

Enter the HTTP port number. The default is 80.

RemoteManagementPort

Enter the HTTPS port number. The default is 443.

InstallFolder

Specify the directory to install EMS to.

InstallSQL

Controls whether the installer installfs SQL Server Express on the same server as FortiClient EMS. Enter 1 to install SQL Server Express. Otherwise, enter 0. By default, the EMS installation also installs SQL Server Express.

ScriptDB

Controls where the installer attempts to create the database from db scripts. Enter 1 to create the database from db scripts. You should only enter 0 if you have already set up databases on the server and you are only installing EMS components locally.

ServerHostname

Enter the preferred hostname (the remote hostname). The default is the local host.

SQLAuthType

Enter sql.

SQLCmdlineOptions="/INSTANCEDIR"

Enter the desired directory to install SQL Server Express to.

SQLCmdlineOptions="/INSTANCENAME"

Enter the SQL Server instance name.

SQLEncryptConnection

(Optional) Enter yes to encrypt the connection to SQL Server. Otherwise, enter no. The default is yes.

SQLPort

Enter the port number the remote SQL Server instance is listening on. You should configure SQL Server to use a static port number.

SQLServer

If using an instance with a custom name, enter the DSN name of the computer where SQL Server is already installed.

SQLServerInstance

Enter the SQL Server instance name.

SQLService

If using a default database instance, enter the instance name. If using a named database instance, enter mssql$<instance_name>. For example, if your instance is named "database000", enter mssql$database000.

SQLTrustServerCertificate

(Optional) Enter yes to trust the SQL Server certificate on the machine where FortiClient EMS is installed. If entering no, you must install the issuing CA certificate of SQL Server's certificate onto the machine you are connecting FortiClient EMS from.

SQLUser

Enter the SQL username used to connect to the database instance. You must preconfigure this user in SQL Server.

SQLUserPassword

Enter the SQL password used to connect to the database instance.

WindowsUser

Enter the Windows username that EMS services, once installed, uses to connect to the database instance. You must preconfigure this user in SQL Server.

WindowsUserPassword

Enter the Windows password that EMS services, once installed, uses to connect to the database instance.

DBInitialSize

Enter the database initial size. The default value is 30 MB. This option is used exclusively during installation and can be used to override SQL Server model database settings.

DBInitialLogSize

Enter the database initial log size. The default value is 3 MB. This option is used exclusively during installation and can be used to override SQL Server model database settings.

DBGrowth

Enter the database growth value. The default value is 10 MB. This option is used exclusively during installation and can be used to override SQL Server model database settings.

DBLogGrowth

Enter the database log growth rate. The default value is 10%. This option is used exclusively during installation and can be used to override SQL Server model database settings.

DBLoginTimeout

Enter the database login timeout value in seconds.

This option is only useful for remote databases. You must increase DBLoginTimeout if there is ephemerally higher than expected latency between the EMS server and the remote SQL server. However, if this latency is always high, then it is likely that EMS will not perform well. In that case, the latency should be fixed. The default value for this option is 30.

The installer only uses this option when creating/scripting the EMS databases. This option is unused once EMS is installed.

DBQueryTimeout

Enter the database query timeout value in seconds. During installation, a SQL query is used to instruct SQL Server to create a database. The default value for this option is 60. It can take a long time to create the actual database file system due to a slow hard drive.

The installer only uses this option when creating/scripting the EMS databases. This option is unused once EMS is installed.

EPCPort

Enter the default listening port that endpoints connect to. The default value for this option is 8013.

StartServices

The default value of this option is 1. Setting this option to 0 results in the installer not starting EMS services when installation is complete.

SQLServerCheck

The default value of this option is 1. Setting this option to 0 results in the installer skipping its initial SQL server accessibility test. Skipping this test may result in installation or upgrade rollbacks, if the SQL server cannot be reached during installation.