Fortinet black logo

User Guide

Install the FortiMonitor Agent

24.1.0
Copy Link
Copy Doc ID af1daa65-c273-11ec-9fd1-fa163e15d75b:487136
Download PDF

Install the FortiMonitor Agent

Supported operating systems

The following Linux operating systems are supported:

  • Red Hat Enterprise Linux (RHEL) 7.0 or later

  • Ubuntu 18.04 or later

  • Debian Linux 9.0 or later

  • Amazon Linux

  • AlmaLinux 8.x to 9.x

  • AIX

  • FreeBSD/OSX

  • Solaris

Install an Agent on a new server

You can install the Agent on a server and it will automatically be added to your FortiMonitor account. This is a helpful option for installing the Agent on a number of servers at once to import into FortiMonitor.

Note: Python 3 is required for all Linux Agent installations. For Windows Agent installations, you need .NET 4.5 or higher. TLS 1.2 and 1.3. are supported on DotNet versions 4.5 or higher.

To install the Agent to a Windows or Linux server, perform the following steps:

  1. From the navigation menu, click Add.

  2. Select Linux FortiMonitor Agent or Windows Server FortiMonitor Agent.

  3. Select either Quick Install Instructions or Manual Install Instructions.
    Selecting Quick Install Instructions will generate a command that you can run manually on each of your servers or through your configuration management tool, like Chef or Puppet.

  4. Follow the on-screen instructions.

Script reusability

This script is generic for your account - you can use it on any new server you'd like to add to FortiMonitor and it will obtain its own distinct key during the installation process.

Python

Python is required on all Linux Agent installations for the script to work properly.

This command will install the Agent, obtain a server key, add the server to FortiMonitor, and begin reporting metrics.

Install the Agent on a server already in FortiMonitor

On the Instance Details page, select Install Agent to install the FortiMonitor Agent.

Clicking Install Agent will give you a few prompts. The first being to select the OS of the server on which you are installing the Agent.

After selecting the OS, you have the option to either do a Quick Install or a Manual Install. The Quick Install tab provides a quick script for you to run which will download the Agent from our repository and link the Agent to your account. It will start reporting metrics in minutes, which you will be able to see in the control panel. Selecting the Manual Install tab will provide several commands that you must run individually to download and install the Agent to your server.

This version of the script has a unique key for this one instance only! Do not use the same script to try to install other Agents. A key is generated for each server.

Installer parameters

FortiMonitor Linux Agent

The following parameters can be appended to the standalone installer command if you selected Linux and want to install the fm-agent:

Parameter

Argument Type

Description

-c

Customer key - Found in the Control Panel under My Account

Required

--customer_key

To obtain your customer key, select your avatar then select My Account.

-s

Server key - Unique server key

Optional

--server-key

Server key to use if one has already been assigned. Typically not needed except for a re-installation.

-a

URL

Optional

--aggregator-url

If you run a proxy or use a different aggregator. Not typically needed.

-g

Int

Optional

--server_group

Assign the instance to one or more instance groups.

-f

URL

Optional

--manifest-url

If you host a manifest file on your installation network, typically used when automating large installations.

-t

Int

Optional

--templates

Applies the defined template or templates to the instance.

-l

Comma-separated value, string

Optional

--tags

Applies the defined tags to the instance

-d

Takes no argument

Optional

--disable-server-match

Disable server matching.

This will prevent instances from getting merged when using the Agent one-liner installer for multiple servers.

-x

Takes no argument

Optional

--migrate

Used to migrate your configuration from the panopta-agent. For more information, see Migrating a Panopta Agent configuration to FortiMonitor Agent.

-y

Takes no argument

Optional

--skip

Used when automating migration.

For example, enter the following command:

curl -s https://repo.fortimonitor.com/install/fm_agent_install.sh | bash /dev/stdin -c <customer-key> -l linux,database,prod -g 23242 -t 2121,32323

The parameters and values will be inserted into the manifest file and subsequently be applied to the instance.

[agent]

customer_key = 13232-32342-2323

tags = linux,database,prod

server_group = 23242

templates = 2121,32323

FortiMonitor Windows Agent

The following parameters can be appended to the standalone installer command if you selected the MSI installer option:

Parameter

Type

Description

customer_key


Required

To obtain your customer key, select your avatar then select My Account.

server_group

Int

Assign the instance to one or more instance groups.

templates

Int

Applies the defined template or templates to the instance.

tags

Comma-separated value, string

Applies the defined tags to the instance

disable-server-match

Disable server matching.

This will prevent instances from getting merged when using the Agent one-liner installer for multiple servers. A true|false argument is needed after the -disable_server_match flag.

For example: Invoke-WebRequest https://repo.fortimonitor.com/install/win/fortimonitor_agent_windows.ps1 -OutFile fortimonitor_agent_windows.ps1; .\fortimonitor_agent_windows.ps1 -customer_key xxxx-xxxx-xxxx-xxxx -countermeasures -disable_server_match true

autoupdate

Enables the Windows Agent auto-update feature.

scheduled_update HH:MM

Set a specific time for the Agent to update. This should be in

military-time format; for example, 2:09 PM would be set as 14:09. The agent will query/attempt an update at this time.

If this flag is not used, the Agent will select a random time within 24 hours of its startup to check for a download; this should be logged in the Agent log.

force_thread_culture

Set the current thread culture to English.

For example, enter the following command:

Invoke-WebRequest https://repo.fortimonitor.com/install/win/fortimonitor_agent_windows.ps1 -OutFile fortimonitor_agent_windows.ps1; .\fortimonitor_agent_windows.ps1 -customer_key xxxx-xxxx-xxxx-xxxx-server_key aaaa-bbbb-xxxx-yyyy -tags windows,database,prod -server_group 23222 -templates 2121,32323 -countermeasures

The parameters and values will be inserted into the manifest file and subsequently be applied to the instance.

[agent]
customer_key = 1122-1212-1111-2222
tags = windows,database,prod
server_group = 23222
templates = 2121,32323

Install the FortiMonitor Agent

Supported operating systems

The following Linux operating systems are supported:

  • Red Hat Enterprise Linux (RHEL) 7.0 or later

  • Ubuntu 18.04 or later

  • Debian Linux 9.0 or later

  • Amazon Linux

  • AlmaLinux 8.x to 9.x

  • AIX

  • FreeBSD/OSX

  • Solaris

Install an Agent on a new server

You can install the Agent on a server and it will automatically be added to your FortiMonitor account. This is a helpful option for installing the Agent on a number of servers at once to import into FortiMonitor.

Note: Python 3 is required for all Linux Agent installations. For Windows Agent installations, you need .NET 4.5 or higher. TLS 1.2 and 1.3. are supported on DotNet versions 4.5 or higher.

To install the Agent to a Windows or Linux server, perform the following steps:

  1. From the navigation menu, click Add.

  2. Select Linux FortiMonitor Agent or Windows Server FortiMonitor Agent.

  3. Select either Quick Install Instructions or Manual Install Instructions.
    Selecting Quick Install Instructions will generate a command that you can run manually on each of your servers or through your configuration management tool, like Chef or Puppet.

  4. Follow the on-screen instructions.

Script reusability

This script is generic for your account - you can use it on any new server you'd like to add to FortiMonitor and it will obtain its own distinct key during the installation process.

Python

Python is required on all Linux Agent installations for the script to work properly.

This command will install the Agent, obtain a server key, add the server to FortiMonitor, and begin reporting metrics.

Install the Agent on a server already in FortiMonitor

On the Instance Details page, select Install Agent to install the FortiMonitor Agent.

Clicking Install Agent will give you a few prompts. The first being to select the OS of the server on which you are installing the Agent.

After selecting the OS, you have the option to either do a Quick Install or a Manual Install. The Quick Install tab provides a quick script for you to run which will download the Agent from our repository and link the Agent to your account. It will start reporting metrics in minutes, which you will be able to see in the control panel. Selecting the Manual Install tab will provide several commands that you must run individually to download and install the Agent to your server.

This version of the script has a unique key for this one instance only! Do not use the same script to try to install other Agents. A key is generated for each server.

Installer parameters

FortiMonitor Linux Agent

The following parameters can be appended to the standalone installer command if you selected Linux and want to install the fm-agent:

Parameter

Argument Type

Description

-c

Customer key - Found in the Control Panel under My Account

Required

--customer_key

To obtain your customer key, select your avatar then select My Account.

-s

Server key - Unique server key

Optional

--server-key

Server key to use if one has already been assigned. Typically not needed except for a re-installation.

-a

URL

Optional

--aggregator-url

If you run a proxy or use a different aggregator. Not typically needed.

-g

Int

Optional

--server_group

Assign the instance to one or more instance groups.

-f

URL

Optional

--manifest-url

If you host a manifest file on your installation network, typically used when automating large installations.

-t

Int

Optional

--templates

Applies the defined template or templates to the instance.

-l

Comma-separated value, string

Optional

--tags

Applies the defined tags to the instance

-d

Takes no argument

Optional

--disable-server-match

Disable server matching.

This will prevent instances from getting merged when using the Agent one-liner installer for multiple servers.

-x

Takes no argument

Optional

--migrate

Used to migrate your configuration from the panopta-agent. For more information, see Migrating a Panopta Agent configuration to FortiMonitor Agent.

-y

Takes no argument

Optional

--skip

Used when automating migration.

For example, enter the following command:

curl -s https://repo.fortimonitor.com/install/fm_agent_install.sh | bash /dev/stdin -c <customer-key> -l linux,database,prod -g 23242 -t 2121,32323

The parameters and values will be inserted into the manifest file and subsequently be applied to the instance.

[agent]

customer_key = 13232-32342-2323

tags = linux,database,prod

server_group = 23242

templates = 2121,32323

FortiMonitor Windows Agent

The following parameters can be appended to the standalone installer command if you selected the MSI installer option:

Parameter

Type

Description

customer_key


Required

To obtain your customer key, select your avatar then select My Account.

server_group

Int

Assign the instance to one or more instance groups.

templates

Int

Applies the defined template or templates to the instance.

tags

Comma-separated value, string

Applies the defined tags to the instance

disable-server-match

Disable server matching.

This will prevent instances from getting merged when using the Agent one-liner installer for multiple servers. A true|false argument is needed after the -disable_server_match flag.

For example: Invoke-WebRequest https://repo.fortimonitor.com/install/win/fortimonitor_agent_windows.ps1 -OutFile fortimonitor_agent_windows.ps1; .\fortimonitor_agent_windows.ps1 -customer_key xxxx-xxxx-xxxx-xxxx -countermeasures -disable_server_match true

autoupdate

Enables the Windows Agent auto-update feature.

scheduled_update HH:MM

Set a specific time for the Agent to update. This should be in

military-time format; for example, 2:09 PM would be set as 14:09. The agent will query/attempt an update at this time.

If this flag is not used, the Agent will select a random time within 24 hours of its startup to check for a download; this should be logged in the Agent log.

force_thread_culture

Set the current thread culture to English.

For example, enter the following command:

Invoke-WebRequest https://repo.fortimonitor.com/install/win/fortimonitor_agent_windows.ps1 -OutFile fortimonitor_agent_windows.ps1; .\fortimonitor_agent_windows.ps1 -customer_key xxxx-xxxx-xxxx-xxxx-server_key aaaa-bbbb-xxxx-yyyy -tags windows,database,prod -server_group 23222 -templates 2121,32323 -countermeasures

The parameters and values will be inserted into the manifest file and subsequently be applied to the instance.

[agent]
customer_key = 1122-1212-1111-2222
tags = windows,database,prod
server_group = 23222
templates = 2121,32323