Fortinet black logo

XML Reference Guide

UI settings

UI settings

User interface related information are contained inside the <ui> </ui> XML tags.

<forticlient_configuration>

<system>

<ui>

<ads>0</ads>

<disable_backup>0</disable_backup>

<default_tab>AV</default_tab>

<flashing_system_tray_icon>1</flashing_system_tray_icon>

<hide_system_tray_icon>0</hide_system_tray_icon>

<suppress_admin_prompt>0</suppress_admin_prompt>

<password>Encrypted/NonEncrypted_PasswordString</password>

<culture-code>os-default</culture-code>

<show_passcode>0</show_passcode>

<gpu_rendering>0</gpu_rendering>

<replacement_messages>

<quarantine>

<title>

<title>

<![CDATA[]]>

</title>

</title>

<statement>

<remediation>

<![CDATA[]]>

</remediation>

</statement>

<remediation>

<remediation>

<![CDATA[]]>

</remediation>

</remediation>

</quarantine>

</replacement_messages>

<avatars>

<enabled>[0|1]</enabled>

<providers>

<google>

<clientid>

<![CDATA[]]>

</clientid>

<clientsecret>

<![CDATA[]]>

</clientsecret>

<redirecturl>

<![CDATA[]]>

</redirecturl>

</google>

<linkedin>

<clientid>

<![CDATA[]]>

</clientid>

<clientsecret>

<![CDATA[]]>

</clientsecret>

<redirecturl>

<![CDATA[]]>

</redirecturl>

</linkedin>

<salesforce>

<clientid>

<![CDATA[]]>

</clientid>

<clientsecret>

<![CDATA[]]>

</clientsecret>

<redirecturl>

<![CDATA[]]>

</redirecturl>

</salesforce>

</providers>

</avatars>

</ui>

</system>

</forticlient_configuration>

The following table provides the XML tags for UI settings, as well as the descriptions and default values where applicable.

XML Tag

Description

Default Value

<ads>

Advertisements (dashboard banner) in the FortiClient console do not display, even when set to 1. FortiClient ignores this setting.

Boolean value: [0 | 1]

1

<disable_backup>

Enable or disable configuration backup from the FortiClient console.

Boolean value: [0 | 1]

1

<default_tab>

The tab selected by default in the FortiClient console. Enter one of the following:

  • AV: Anti Virus
  • WF: Parental Control/Web Filtering
  • FW: Application Firewall
  • VPN: Remote Access
  • VULN: Vulnerability Scan

AV

<flashing_system_tray_icon>

Enable or disable the flashing system tray icon. The system tray flashes while FortiClient background processes are running.

Boolean value: [0 | 1]

1

<hide_system_tray_icon>

Hide or display the system tray icon.

Boolean value: [0 | 1]

0

<suppress_admin_prompt>

Do not ask for an administrator password for tasks that require superuser permissions to complete.

Boolean value: [0 | 1]

0

<password>

Enter a password to set the configuration lock upon connecting with a FortiGate.

Either encrypted or non-encrypted password.

<culture-code>

The localized language used by the FortiClient console. Enter one of the following:

  • os-default: Defaults to the operating system language
  • de-de: German
  • en-us: English (United States)
  • es-es: Spanish (Spain)
  • fr-fr: French (France)
  • ja-jp: Japanese
  • pt-br: Portuguese (Brazil)
  • kr-kr: Korean
  • zh-cn: Simplified Chinese
  • zh-tw: Traditional Chinese

os-default

<show_passcode>

Display Passcode instead of Password in the VPN tab on the FortiClient console.

Boolean value: [0 | 1]

0

<gpu_rendering>

Enable or disable GPU rendering.

Boolean value: [0 | 1]

0

<replacement_messages>

Displays a message in FortiClient when the endpoint is quarantined. You can customize the message.

<avatars>

Contains the elements for configuring whether FortiClient retrieves an avatar picture for the endpoint user from web applications, such as Google, LinkedIn, or Salesforce.

<enabled>

Enable or disable FortiClient to retrieve an avatar picture for the user from web applications, such as Google, LinkedIn, or Salesforce.

Boolean value: [0 | 1]

<providers>

Identifies which cloud applications FortiClient uses to retrieve an avatar picture for the endpoint users.

<google>

Settings that allow FortiClient uses to retrieve an avatar picture from Google. Integration with Google requires a Google API Console project.

<clientid>

Enter the client ID for your Google API Console project.

<clientsecret>

Enter the client secret for your Google API Console project.

<redirecturl>

Enter the redirect URL for your Google API Console project.

<linkedin>

Settings that allow FortiClient uses to retrieve an avatar picture from LinkedIn. Integration with LinkedIn requires LinkedIn Developers knowledge.

<clientid>

Enter the client ID for LinkedIn.

<clientsecret>

Enter the client secret for LinkedIn.

<redirecturl>

Enter the redirect URL for LinkedIn.

<salesforce>

Settings that allow FortiClient uses to retrieve an avatar picture from Salesforce. Integration with Salesforce requires knowledge of Salesforce Developer.

<clientid>

Enter the client ID for Salesforce.

<clientsecret>

Enter the client secret for Salesforce.

<redirecturl>

Enter the redirect URL for Salesforce.

Following is an example replacement message:

<replacement_messages>

<quarantine>

<title>

<![CDATA[Quarantined]]>

</title>

<statement>

<![CDATA[Your system has been quarantined by %FortiGate% %serial number% (%ip address%).]]>

</statement>

<remediation>

<![CDATA[Contact your system administrator for assistance.]]>

</remediation>

</quarantine>

</replacement_messages>

UI settings

User interface related information are contained inside the <ui> </ui> XML tags.

<forticlient_configuration>

<system>

<ui>

<ads>0</ads>

<disable_backup>0</disable_backup>

<default_tab>AV</default_tab>

<flashing_system_tray_icon>1</flashing_system_tray_icon>

<hide_system_tray_icon>0</hide_system_tray_icon>

<suppress_admin_prompt>0</suppress_admin_prompt>

<password>Encrypted/NonEncrypted_PasswordString</password>

<culture-code>os-default</culture-code>

<show_passcode>0</show_passcode>

<gpu_rendering>0</gpu_rendering>

<replacement_messages>

<quarantine>

<title>

<title>

<![CDATA[]]>

</title>

</title>

<statement>

<remediation>

<![CDATA[]]>

</remediation>

</statement>

<remediation>

<remediation>

<![CDATA[]]>

</remediation>

</remediation>

</quarantine>

</replacement_messages>

<avatars>

<enabled>[0|1]</enabled>

<providers>

<google>

<clientid>

<![CDATA[]]>

</clientid>

<clientsecret>

<![CDATA[]]>

</clientsecret>

<redirecturl>

<![CDATA[]]>

</redirecturl>

</google>

<linkedin>

<clientid>

<![CDATA[]]>

</clientid>

<clientsecret>

<![CDATA[]]>

</clientsecret>

<redirecturl>

<![CDATA[]]>

</redirecturl>

</linkedin>

<salesforce>

<clientid>

<![CDATA[]]>

</clientid>

<clientsecret>

<![CDATA[]]>

</clientsecret>

<redirecturl>

<![CDATA[]]>

</redirecturl>

</salesforce>

</providers>

</avatars>

</ui>

</system>

</forticlient_configuration>

The following table provides the XML tags for UI settings, as well as the descriptions and default values where applicable.

XML Tag

Description

Default Value

<ads>

Advertisements (dashboard banner) in the FortiClient console do not display, even when set to 1. FortiClient ignores this setting.

Boolean value: [0 | 1]

1

<disable_backup>

Enable or disable configuration backup from the FortiClient console.

Boolean value: [0 | 1]

1

<default_tab>

The tab selected by default in the FortiClient console. Enter one of the following:

  • AV: Anti Virus
  • WF: Parental Control/Web Filtering
  • FW: Application Firewall
  • VPN: Remote Access
  • VULN: Vulnerability Scan

AV

<flashing_system_tray_icon>

Enable or disable the flashing system tray icon. The system tray flashes while FortiClient background processes are running.

Boolean value: [0 | 1]

1

<hide_system_tray_icon>

Hide or display the system tray icon.

Boolean value: [0 | 1]

0

<suppress_admin_prompt>

Do not ask for an administrator password for tasks that require superuser permissions to complete.

Boolean value: [0 | 1]

0

<password>

Enter a password to set the configuration lock upon connecting with a FortiGate.

Either encrypted or non-encrypted password.

<culture-code>

The localized language used by the FortiClient console. Enter one of the following:

  • os-default: Defaults to the operating system language
  • de-de: German
  • en-us: English (United States)
  • es-es: Spanish (Spain)
  • fr-fr: French (France)
  • ja-jp: Japanese
  • pt-br: Portuguese (Brazil)
  • kr-kr: Korean
  • zh-cn: Simplified Chinese
  • zh-tw: Traditional Chinese

os-default

<show_passcode>

Display Passcode instead of Password in the VPN tab on the FortiClient console.

Boolean value: [0 | 1]

0

<gpu_rendering>

Enable or disable GPU rendering.

Boolean value: [0 | 1]

0

<replacement_messages>

Displays a message in FortiClient when the endpoint is quarantined. You can customize the message.

<avatars>

Contains the elements for configuring whether FortiClient retrieves an avatar picture for the endpoint user from web applications, such as Google, LinkedIn, or Salesforce.

<enabled>

Enable or disable FortiClient to retrieve an avatar picture for the user from web applications, such as Google, LinkedIn, or Salesforce.

Boolean value: [0 | 1]

<providers>

Identifies which cloud applications FortiClient uses to retrieve an avatar picture for the endpoint users.

<google>

Settings that allow FortiClient uses to retrieve an avatar picture from Google. Integration with Google requires a Google API Console project.

<clientid>

Enter the client ID for your Google API Console project.

<clientsecret>

Enter the client secret for your Google API Console project.

<redirecturl>

Enter the redirect URL for your Google API Console project.

<linkedin>

Settings that allow FortiClient uses to retrieve an avatar picture from LinkedIn. Integration with LinkedIn requires LinkedIn Developers knowledge.

<clientid>

Enter the client ID for LinkedIn.

<clientsecret>

Enter the client secret for LinkedIn.

<redirecturl>

Enter the redirect URL for LinkedIn.

<salesforce>

Settings that allow FortiClient uses to retrieve an avatar picture from Salesforce. Integration with Salesforce requires knowledge of Salesforce Developer.

<clientid>

Enter the client ID for Salesforce.

<clientsecret>

Enter the client secret for Salesforce.

<redirecturl>

Enter the redirect URL for Salesforce.

Following is an example replacement message:

<replacement_messages>

<quarantine>

<title>

<![CDATA[Quarantined]]>

</title>

<statement>

<![CDATA[Your system has been quarantined by %FortiGate% %serial number% (%ip address%).]]>

</statement>

<remediation>

<![CDATA[Contact your system administrator for assistance.]]>

</remediation>

</quarantine>

</replacement_messages>