Fortinet Document Library

Version:


Table of Contents

6.1.0
Download PDF
Copy Link

Fresh Installation

This section describes how to install FortiSIEM for the current release.

Pre-Installation Checklist

Before you begin, check the following:

  • Ensure that your system can connect to the internet
  • Deployment type – Enterprise or Service Provider. The Service Provider deployment provides multi-tenancy.
  • Whether FIPS should be enabled
  • Install type:
    • All-in-one with Supervisor only, or
    • Cluster with Supervisor and Workers
  • Storage type
    • Online – Local or NFS or Elasticsearch
    • Archive – NFS or HDFS
  • Before beginning FortiSIEM deployment, you must configure external storage
  • Determine hardware requirements and choose AWS instance type accordingly:
Node vCPU RAM Local Disks
Supervisor (All in one) Minimum – 16
Recommended - 32

Minimum

  • without UEBA – 24GB
  • with UEBA - 64GB

Recommended

  • without UEBA – 32GB
  • with UEBA - 64GB

OS – 25GB

OPT – 100GB

CMDB – 60GB

SVN – 60GB

Local Event database – based on need

Supervisor (Cluster) Minimum – 16
Recommended - 32

Minimum

  • without UEBA – 24GB
  • with UEBA - 64GB

Recommended

  • without UEBA – 32GB
  • with UEBA - 64GB

OS – 25GB

OPT – 100GB

CMDB – 60GB

SVN – 60GB

 

Workers Minimum – 8
Recommended - 8

Minimum – 16GB

Recommended – 24GB

OS – 25GB

OPT – 100GB

Collector Minimum – 4
Recommended – 8 ( based on load)

Minimum – 4GB

Recommended – 8GB

OS – 25GB

OPT – 100GB

Note: compared to FortiSIEM 5.x, you need one more disk (OPT) which provides a cache for FortiSIEM.

Before proceeding to FortiSIEM deployment, you must configure the external storage.

  • For NFS deployment, see FortiSIEM - NFS Storage Guide here.
  • For Elasticsearch deployment, see FortiSIEM - Elasticsearch Storage Guide here.

All-in-one Installation

This is the simplest installation with a single Virtual Appliance. If storage is external, then you must configure external storage before proceeding with installation.

Launch an Instance Using FortiSIEM 6.1.0 AMI

  1. Navigate to the EC2 AMIs page and find FortiSIEM 6.1 AMI (or in AWS Marketplace after the GA release).
  2. Launch FortiSIEM-6.1.0.0112.

  3. Go to Step 3: Configure Instance Details in AWS Services. Configure instance details such as VPC, Subnet, IP, etc. Click Next.

  4. In Step 4: Add Storage, add additional disks in the Add Storage page. These will be used for the additional partitions in the virtual appliance. An All In One deployment requires the following additional partitions. Then click Next.

    Use these partition values:

    Volume Name Size Disk Name
    EBS Volume 2 100GB

    /opt

    EBS Volume 3 60GB /cmdb
    EBS Volume 4 60GB /svn
    EBS Volume 5 60GB+ /data (see the following note)

    Note on EBS Volume 5:

    • Add a 5th EBS Volume if using local storage in an All In One deployment. Otherwise, a separate NFS share or Elasticsearch cluster must be used for event storage.
    • 60GB is the minimum event DB disk size for small deployments, provision significantly more event storage for higher EPS deployments. See the FortiSIEM Sizing Guide for additional information.
    • NFS or Elasticsearch event DB storage is mandatory for multi-node cluster deployments.
    • Choose GP2 volume type for all volumes. For the CMDB partition, you can choose to modify your volume type and IOPS based on your system workload if you see the consistently high IOPS requirement in your deployment.
  5. In Step 5: Add Tags: click click to add a new Name Tag and provide a name for the instance. Click Next.

    Add a new Name Tag.

  6. In Step 6: Configure Security Group, add the allowed inbound protocols for your instance. You will need ssh and https to begin with. Depending on whether this node will receive syslog or other inbound data, you may need to open additional protocols/ports. Click Review and Launch.

  7. In Step 7: Review Instance Launch, click Launch.

  8. Select an existing key pair or create a new key pair, then click Launch Instances.

  9. Select the instance that you just created and click Connect.

  10. Using the example above in the Connect popup, ssh to the instance you created. Replace root user with ec2-user. Once logged in, you can execute the sudo su - command to become root user

Configure FortiSIEM via GUI

Follow these steps to configure FortiSIEM by using a simple GUI.

  1. At the root command prompt, go to /usr/local/bin and enter configFSM.sh, for example:

    # configFSM.sh

  2. In VM console, select 1 Set Timezone and then press Next.

  3. Select your Location, and press Next.

  4. Select your Continent, and press Next.

  5. Select the Country and City for your timezone, and press Next.

  6. Select 1 Supervisor. Press Next.

    note icon

    Regardless of whether you select Supervisor, Worker, or Collector, you will see the same series of screens.

  7. If you want to enable FIPS, then choose 2 install_with_fips. Otherwise, choose 1 install_without_fips. You have the option of enabling FIPS (option 3) or disabling FIPS (option 4) later.

  8. Configure the network by entering the following fields. Press Next.

    Option Description
    Host Name The Supervisor's host name
    IPv4 Address The Supervisor's IPv4 address
    NetMask The Supervisor's subnet
    Gateway Network gateway address
    FQDN Fully-qualified domain name
    DNS1, DNS2 Addresses of the DNS servers

  9. Test connectivity by connecting to a well-known public internet site, as shown in the following dialog box. Press Next.

  10. The final configuration confirmation is displayed. Verify that the parameters are correct. If they are not, then press Back to return to previous dialog boxes to correct any errors. If everything is OK, then press Run.

    The options are described in the following table.

    Option Description
    -r The FortiSIEM component being configured
    -z The time zone being configured
    -i IPv4-formatted address
    -m Address of the subnet mask
    -g Address of the gateway server used
    --host Host name
    -f FQDN address: fully-qualified domain name
    -t The IP type. The values can be either 4 (for ipv4) or 6 (for v6) Note: the 6 value is not currently supported.

    --dns1, --dns2

    Addresses of the DNS server 1 and DNS server 2.

    -o

    Installation option (install_without_fips, install_with_fips, enable_fips, disable_fips, change_ip, or migrate_6_1_0)

    -z Time zone. Possible values are US/Pacific, Asia/Shanghai, Europe/London, or Africa/Tunis

    --testpinghost

    The URL used to test connectivity

  11. It will take some time to complete the FortiSIEM installation. If the installation is successful, then the VM will reboot automatically. Otherwise, the VM will stop at the failed task.

    You can inspect the ansible.log file located at /usr/local/fresh-install/logs if you encounter any issues during FortiSIEM installation.

    After installation completes, ensure that the phMonitor is up and running, for example:

    # phstatus

    The response should be similar to the following:

Upload the FortiSIEM License

note icon

Before proceeding, make sure that you have obtained valid FortiSIEM license from Forticare. For more information, see the Licensing Guide.

You will now be asked to input a license.

  1. Open a Web browser and log in to the FortiSIEM UI.
  2. The License Upload dialog box will open.

  3. Click Browse and upload the license file.

    Make sure that the Hardware ID shown in the License Upload page matches the license.

  4. For User ID and Password, choose any Full Admin credentials.

    For the first time installation, enter admin as the user and admin*1 as the password. You will then be asked to create a new password for GUI access.

  5. Choose License type as Enterprise or Service Provider.

    This option is available only for a first time installation. Once the database is configured, this option will not be available.

Choose an Event Database

For a fresh installation, you will be taken to the Event Database Storage page. You will be asked to choose between Local Disk, NFS or Elasticsearch options. For more details, see Configuring Storage.

Cluster Installation

For larger installations, you can choose Worker nodes, Collector nodes, and external storage (NFS or Elasticsearch).

Install Supervisor

Follow the steps in All-in-one Install with two differences:

  • Setting up hardware - you do not need to add an EBS Volume 5 for Event database.
  • Setting up an Event database - Configure the cluster for either NFS or Elasticsearch.

    NFS

    Elasticsearch

You must choose external storage listed in Choose an Event Database.

Install Workers

Once the Supervisor is installed, follow the same steps in All-in-one Install to install a Worker except you need to only choose OS and OPT disks. The recommended settings for Worker node are:

  • CPU = 8
  • Memory = 24 GB
  • Two hard disks:
    • OS – 25GB
    • OPT – 100GB

 

Register Workers

Once the Worker is up and running, add the Worker to the Supervisor node.

  1. Go to ADMIN > License > Nodes.
  2. Select Worker from the drop-down list and enter the Worker's IP address. Click Add.

  3. See ADMIN > Health > Cloud Health to ensure that the Workers are up, healthy, and properly added to the system.

Install Collectors

Once Supervisor and Workers are installed, follow the same steps in All-in-one Install to install a Collector except in Edit FortiSIEM Hardware Settings, you need to only choose OS and OPT disks. The recommended settings for Collector node are:

  • CPU = 4
  • Memory = 8GB
  • Two hard disks:
    • OS – 25GB
    • OPT – 100GB

Register Collectors

Collectors can be deployed in Enterprise or Service Provider environments.

Enterprise Deployments

For Enterprise deployments, follow these steps.

  1. Log in to Supervisor with 'Admin' privileges.
  2. Go to ADMIN > Settings > System > Event Worker and enter the IP of the Supervisor node. Click Save.
  3. Go to ADMIN > Setup > Collectors and add a Collector by entering:
    1. Name – Collector Name
    2. Guaranteed EPS – this is the EPS that Collector will always be able to send. It could send more if there is excess EPS available.
    3. Start Time and End Time – set to Unlimited.
  4. SSH to the Collector and run following script to register Collectors:

    phProvisionCollector --add <user> <password> <Super IP or Host> <Organization> <CollectorName>

    1. Set user and password use the admin User Name and password for the Supervisor.
    2. Set Super IP or Host as the Supervisor's IP address.
    3. Set Organization. For Enterprise deployments, the default name is Super.
    4. Set CollectorName from Step 2a.

      The Collector will reboot during the Registration.

  5. Go to ADMIN > Health > Collector Health for the status.

Service Provider Deployments

For Service Provider deployments, follow these steps.

  1. Log in to Supervisor with 'Admin' privileges.
  2. Go to ADMIN > Settings > System > Event Worker and enter the IP of the Worker node. Click OK.

  3. Go to ADMIN > Setup > Organizations and click New to add an Organization.

  4. Enter the Organization Name, Admin User, Admin Password, and Admin Email.
  5. Under Collectors, click New.
  6. Enter the Collector Name, Guaranteed EPS, Start Time, and End Time.

    The last two values could be set as Unlimited. Guaranteed EPS is the EPS that the Collector will always be able to send. It could send more if there is excess EPS available.

  7. SSH to the Collector and run following script to register Collectors:

    phProvisionCollector --add <user> <password> <Super IP or Host> <Organization> <CollectorName>

    1. Set user and password use the admin User Name and password for the Supervisor.
    2. Set Super IP or Host as the Supervisor's IP address.
    3. Set Organization as the name of an organization created on the Super.
    4. Set CollectorName from Step 6.

      The Collector will reboot during the Registration.

  8. Go to ADMIN > Health > Collector Health and check the status.

 

Fresh Installation

This section describes how to install FortiSIEM for the current release.

Pre-Installation Checklist

Before you begin, check the following:

  • Ensure that your system can connect to the internet
  • Deployment type – Enterprise or Service Provider. The Service Provider deployment provides multi-tenancy.
  • Whether FIPS should be enabled
  • Install type:
    • All-in-one with Supervisor only, or
    • Cluster with Supervisor and Workers
  • Storage type
    • Online – Local or NFS or Elasticsearch
    • Archive – NFS or HDFS
  • Before beginning FortiSIEM deployment, you must configure external storage
  • Determine hardware requirements and choose AWS instance type accordingly:
Node vCPU RAM Local Disks
Supervisor (All in one) Minimum – 16
Recommended - 32

Minimum

  • without UEBA – 24GB
  • with UEBA - 64GB

Recommended

  • without UEBA – 32GB
  • with UEBA - 64GB

OS – 25GB

OPT – 100GB

CMDB – 60GB

SVN – 60GB

Local Event database – based on need

Supervisor (Cluster) Minimum – 16
Recommended - 32

Minimum

  • without UEBA – 24GB
  • with UEBA - 64GB

Recommended

  • without UEBA – 32GB
  • with UEBA - 64GB

OS – 25GB

OPT – 100GB

CMDB – 60GB

SVN – 60GB

 

Workers Minimum – 8
Recommended - 8

Minimum – 16GB

Recommended – 24GB

OS – 25GB

OPT – 100GB

Collector Minimum – 4
Recommended – 8 ( based on load)

Minimum – 4GB

Recommended – 8GB

OS – 25GB

OPT – 100GB

Note: compared to FortiSIEM 5.x, you need one more disk (OPT) which provides a cache for FortiSIEM.

Before proceeding to FortiSIEM deployment, you must configure the external storage.

  • For NFS deployment, see FortiSIEM - NFS Storage Guide here.
  • For Elasticsearch deployment, see FortiSIEM - Elasticsearch Storage Guide here.

All-in-one Installation

This is the simplest installation with a single Virtual Appliance. If storage is external, then you must configure external storage before proceeding with installation.

Launch an Instance Using FortiSIEM 6.1.0 AMI

  1. Navigate to the EC2 AMIs page and find FortiSIEM 6.1 AMI (or in AWS Marketplace after the GA release).
  2. Launch FortiSIEM-6.1.0.0112.

  3. Go to Step 3: Configure Instance Details in AWS Services. Configure instance details such as VPC, Subnet, IP, etc. Click Next.

  4. In Step 4: Add Storage, add additional disks in the Add Storage page. These will be used for the additional partitions in the virtual appliance. An All In One deployment requires the following additional partitions. Then click Next.

    Use these partition values:

    Volume Name Size Disk Name
    EBS Volume 2 100GB

    /opt

    EBS Volume 3 60GB /cmdb
    EBS Volume 4 60GB /svn
    EBS Volume 5 60GB+ /data (see the following note)

    Note on EBS Volume 5:

    • Add a 5th EBS Volume if using local storage in an All In One deployment. Otherwise, a separate NFS share or Elasticsearch cluster must be used for event storage.
    • 60GB is the minimum event DB disk size for small deployments, provision significantly more event storage for higher EPS deployments. See the FortiSIEM Sizing Guide for additional information.
    • NFS or Elasticsearch event DB storage is mandatory for multi-node cluster deployments.
    • Choose GP2 volume type for all volumes. For the CMDB partition, you can choose to modify your volume type and IOPS based on your system workload if you see the consistently high IOPS requirement in your deployment.
  5. In Step 5: Add Tags: click click to add a new Name Tag and provide a name for the instance. Click Next.

    Add a new Name Tag.

  6. In Step 6: Configure Security Group, add the allowed inbound protocols for your instance. You will need ssh and https to begin with. Depending on whether this node will receive syslog or other inbound data, you may need to open additional protocols/ports. Click Review and Launch.

  7. In Step 7: Review Instance Launch, click Launch.

  8. Select an existing key pair or create a new key pair, then click Launch Instances.

  9. Select the instance that you just created and click Connect.

  10. Using the example above in the Connect popup, ssh to the instance you created. Replace root user with ec2-user. Once logged in, you can execute the sudo su - command to become root user

Configure FortiSIEM via GUI

Follow these steps to configure FortiSIEM by using a simple GUI.

  1. At the root command prompt, go to /usr/local/bin and enter configFSM.sh, for example:

    # configFSM.sh

  2. In VM console, select 1 Set Timezone and then press Next.

  3. Select your Location, and press Next.

  4. Select your Continent, and press Next.

  5. Select the Country and City for your timezone, and press Next.

  6. Select 1 Supervisor. Press Next.

    note icon

    Regardless of whether you select Supervisor, Worker, or Collector, you will see the same series of screens.

  7. If you want to enable FIPS, then choose 2 install_with_fips. Otherwise, choose 1 install_without_fips. You have the option of enabling FIPS (option 3) or disabling FIPS (option 4) later.

  8. Configure the network by entering the following fields. Press Next.

    Option Description
    Host Name The Supervisor's host name
    IPv4 Address The Supervisor's IPv4 address
    NetMask The Supervisor's subnet
    Gateway Network gateway address
    FQDN Fully-qualified domain name
    DNS1, DNS2 Addresses of the DNS servers

  9. Test connectivity by connecting to a well-known public internet site, as shown in the following dialog box. Press Next.

  10. The final configuration confirmation is displayed. Verify that the parameters are correct. If they are not, then press Back to return to previous dialog boxes to correct any errors. If everything is OK, then press Run.

    The options are described in the following table.

    Option Description
    -r The FortiSIEM component being configured
    -z The time zone being configured
    -i IPv4-formatted address
    -m Address of the subnet mask
    -g Address of the gateway server used
    --host Host name
    -f FQDN address: fully-qualified domain name
    -t The IP type. The values can be either 4 (for ipv4) or 6 (for v6) Note: the 6 value is not currently supported.

    --dns1, --dns2

    Addresses of the DNS server 1 and DNS server 2.

    -o

    Installation option (install_without_fips, install_with_fips, enable_fips, disable_fips, change_ip, or migrate_6_1_0)

    -z Time zone. Possible values are US/Pacific, Asia/Shanghai, Europe/London, or Africa/Tunis

    --testpinghost

    The URL used to test connectivity

  11. It will take some time to complete the FortiSIEM installation. If the installation is successful, then the VM will reboot automatically. Otherwise, the VM will stop at the failed task.

    You can inspect the ansible.log file located at /usr/local/fresh-install/logs if you encounter any issues during FortiSIEM installation.

    After installation completes, ensure that the phMonitor is up and running, for example:

    # phstatus

    The response should be similar to the following:

Upload the FortiSIEM License

note icon

Before proceeding, make sure that you have obtained valid FortiSIEM license from Forticare. For more information, see the Licensing Guide.

You will now be asked to input a license.

  1. Open a Web browser and log in to the FortiSIEM UI.
  2. The License Upload dialog box will open.

  3. Click Browse and upload the license file.

    Make sure that the Hardware ID shown in the License Upload page matches the license.

  4. For User ID and Password, choose any Full Admin credentials.

    For the first time installation, enter admin as the user and admin*1 as the password. You will then be asked to create a new password for GUI access.

  5. Choose License type as Enterprise or Service Provider.

    This option is available only for a first time installation. Once the database is configured, this option will not be available.

Choose an Event Database

For a fresh installation, you will be taken to the Event Database Storage page. You will be asked to choose between Local Disk, NFS or Elasticsearch options. For more details, see Configuring Storage.

Cluster Installation

For larger installations, you can choose Worker nodes, Collector nodes, and external storage (NFS or Elasticsearch).

Install Supervisor

Follow the steps in All-in-one Install with two differences:

  • Setting up hardware - you do not need to add an EBS Volume 5 for Event database.
  • Setting up an Event database - Configure the cluster for either NFS or Elasticsearch.

    NFS

    Elasticsearch

You must choose external storage listed in Choose an Event Database.

Install Workers

Once the Supervisor is installed, follow the same steps in All-in-one Install to install a Worker except you need to only choose OS and OPT disks. The recommended settings for Worker node are:

  • CPU = 8
  • Memory = 24 GB
  • Two hard disks:
    • OS – 25GB
    • OPT – 100GB

 

Register Workers

Once the Worker is up and running, add the Worker to the Supervisor node.

  1. Go to ADMIN > License > Nodes.
  2. Select Worker from the drop-down list and enter the Worker's IP address. Click Add.

  3. See ADMIN > Health > Cloud Health to ensure that the Workers are up, healthy, and properly added to the system.

Install Collectors

Once Supervisor and Workers are installed, follow the same steps in All-in-one Install to install a Collector except in Edit FortiSIEM Hardware Settings, you need to only choose OS and OPT disks. The recommended settings for Collector node are:

  • CPU = 4
  • Memory = 8GB
  • Two hard disks:
    • OS – 25GB
    • OPT – 100GB

Register Collectors

Collectors can be deployed in Enterprise or Service Provider environments.

Enterprise Deployments

For Enterprise deployments, follow these steps.

  1. Log in to Supervisor with 'Admin' privileges.
  2. Go to ADMIN > Settings > System > Event Worker and enter the IP of the Supervisor node. Click Save.
  3. Go to ADMIN > Setup > Collectors and add a Collector by entering:
    1. Name – Collector Name
    2. Guaranteed EPS – this is the EPS that Collector will always be able to send. It could send more if there is excess EPS available.
    3. Start Time and End Time – set to Unlimited.
  4. SSH to the Collector and run following script to register Collectors:

    phProvisionCollector --add <user> <password> <Super IP or Host> <Organization> <CollectorName>

    1. Set user and password use the admin User Name and password for the Supervisor.
    2. Set Super IP or Host as the Supervisor's IP address.
    3. Set Organization. For Enterprise deployments, the default name is Super.
    4. Set CollectorName from Step 2a.

      The Collector will reboot during the Registration.

  5. Go to ADMIN > Health > Collector Health for the status.

Service Provider Deployments

For Service Provider deployments, follow these steps.

  1. Log in to Supervisor with 'Admin' privileges.
  2. Go to ADMIN > Settings > System > Event Worker and enter the IP of the Worker node. Click OK.

  3. Go to ADMIN > Setup > Organizations and click New to add an Organization.

  4. Enter the Organization Name, Admin User, Admin Password, and Admin Email.
  5. Under Collectors, click New.
  6. Enter the Collector Name, Guaranteed EPS, Start Time, and End Time.

    The last two values could be set as Unlimited. Guaranteed EPS is the EPS that the Collector will always be able to send. It could send more if there is excess EPS available.

  7. SSH to the Collector and run following script to register Collectors:

    phProvisionCollector --add <user> <password> <Super IP or Host> <Organization> <CollectorName>

    1. Set user and password use the admin User Name and password for the Supervisor.
    2. Set Super IP or Host as the Supervisor's IP address.
    3. Set Organization as the name of an organization created on the Super.
    4. Set CollectorName from Step 6.

      The Collector will reboot during the Registration.

  8. Go to ADMIN > Health > Collector Health and check the status.