Fortinet Document Library

Table of Contents

Installing a connector

Copy Link

Installing a FortiSOAR™ connector using the Content Hub

Use the Content Hub (Connector Store) to easily view, search, install, upgrade, and uninstall connectors that are part of the FortiSOAR™ repository. Therefore, you can now perform these operations using the FortiSOAR™ UI instead of the required CLI access.
Note:  The Content Hub contains all out-of-the-box reference material and product add-ons such as connectors, widgets, and solution packs; whereas the Connector Store has been filtered to display only Connectors.

Important: You must ensure that repo.fortisoar.fortinet.com is reachable from your FortiSOAR™ instance. Otherwise, you will see a blank page when you click Content Hub or Automation > Connectors in the left navigation.

Following are the permissions that you must be assigned to perform operations for connectors:

  • To work with connectors, i.e., view the connectors listed in the Content Hub and changes made to the Content Hub, you must be assigned a role that has a minimum of Read access on the ApplicationConnectorsPlaybooks, and Content Hub modules, a minimum of CreateReadUpdate permissions on the Solution Packs module.
  • To install a connector from the Content Hub or to upload a connector to the Content Hub you must be assigned a role that has a minimum of Read permission on the Security module.
  • Apart from the above, to work with connectors, you need appropriate permissions on the Connectors and Playbooks modules. For example, install a connector or create a new custom connector, you must be assigned a role that has a minimum of Create and Read access on the Connectors module and Read access on the Playbooks modules, or to upgrade or configure a connector, you must be assigned a role that has a minimum of Update and Read access on the Connectors module and Read access on the Playbooks module.

To open the Connector Store, go to Automation > Connectors, or to go to Content Hub, click Content Hub in the left menu. The Connector Store is filtered to display only connectors, whereas the Content Hub displays all the add-ons. In this article, the screenshots included are from the Content Hub page; similar screens are displayed on the Connector Store page.
The Discover tab displays all the add-ons, i.e., Connectors, Widgets, and Solution Packs, available in the Content Hub. Use the Filter panel to filter the connectors by clicking the > arrow in the Content Type list and then selecting Connectors:

You can search for a connector by its name in the Search field and sort the content alphabetically (A-Z) or by date. Using the Filters panel, you can filter the connectors displayed in all the tabs based on varied criteria. For more information on Content Hub, see the Content Hub chapter in the "User Guide.' Connectors that are installed appear with a tick on their card. For example, the Active Directory connector in the above image.
To install a connector, click the connector card of the connector that you want to install, for example, AbuseIPDB, which opens a popup with the connector name:

The connector popup contains details such as the name and version of the connector, whether the connector is certified or not, who is the publisher of the connector, and the link to the connector documentation. The Summary tab contains a brief description of the connector, and the Contents tab contains a list of actions the connector can perform.

Click Install in the connector name popup to begin the installation of the connector after confirmation, as shown in the following image:

Once installation is complete, FortiSOAR displays the "Connector Installed successfully" message, and the connector gets added to the Manage page. After installing the connector, you must configure the connector by entering the required configuration details in the connector popup:

You can also configure the connector on the Manage page by clicking the connector name card, which will also display the same connector popup. For the procedure to configure a connector, click here.

To uninstall a connector, click the Uninstall button, in the connector popup. FortiSOAR displays a Confirmation dialog, click Confirm to uninstall the connector. FortiSOAR displays the "Connector uninstalled successfully" message and the connector is removed from the Manage page. To uninstall a connector, you must be assigned a role that has a minimum of Delete access to the Connectors module

If any connector that is installed and configured on your system has an upgraded version, for example, if you have version 5.0.0 of the Fortinet FortiGate connector installed on your system and FortiSOAR™ has released a newer version of this connector, i.e., version 5.1.0, then you can see an Update Available link on the connector card:

When you click on a connector that has an updated version, you will see a 'What's new?' section on the configuration page, besides the Update to <version number> button. Clicking the What's New? link displays the highlights of the new version, which you can view to understand what you can expect when you upgrade your connector version. Click the Update to <version number> button to upgrade your connector:

Importing a connector in FortiSOAR™

  1. Log on to FortiSOAR™.

  2. On the left navigation pane, click Content Hub.

  3. Click the Manage tab.

  4. On the Manage page, click Upload > Upload Connector to display the Upload Connector popup as shown in the following image:

    You can drag and drop the connector .tgz file onto the popup or browse to the .tgz file to install the connector in FortiSOAR. If you have an existing version of the connector on your system, then you can click the Replace existing version checkbox, to replace that version of the connector.
    You must check that all the connector dependencies are available or install the dependencies additional to ensure that the connector functions as expected.
  5. Once the connector is imported successfully into FortiSOAR™, you can configure the connector. For the procedure to configure a connector, click here

Installing a FortiSOAR™ connector using the yum command

All connectors provided by  FortiSOAR™ are delivered using a FortiSOAR™ repository. Therefore, you must set up your FortiSOAR™ repository and use the yum command to install connectors as a root user.

Important: The recommended way to install a connector is by using the Connector Store. 

To install a connector, you must be assigned a role that has a minimum of Read and Create access to the Connectors module. 

To install a FortiSOAR™-provided connector use the following command:

yum install cyops-connector-<connectorname>

For example, yum install cyops-connector-symantec-atp
Note: After you install a connector using the yum command the new connector is not reflected until you refresh the Connectors page.   

To update a FortiSOAR™-provided connector use the following command:

yum update cyops-connector-<connectorname>

For example, yum update cyops-connector-symantec-atp 

To remove a  FortiSOAR™-provided connector use the following command:

yum remove cyops-connector-<connectorname>

For example, yum remove cyops-connector-symantec-atp 

Note: If you delete a FortiSOAR™-provided connector using the Connector page in FortiSOAR™ then you cannot reinstall the RPM of the same connector because the RPM of the connector does not get deleted. Therefore, to remove a FortiSOAR™-provided connector, you must use the following command:
yum remove cyops-connector-<connectorName> command.

Points to note:

Some of the connectors have dependencies on additional python packages. During connector installation, these dependencies are also installed using pip. The default pip settings point to the pypi.python.org repository for downloading these packages. We have also added an alternate repository on repo.fortisoar.fortinet.com to host the connector dependencies. If your instance restricts access to pypi.python.org, the installer fallbacks to this alternate repository for installing the dependencies. However, the connector installation might take a considerable amount of time, if there are multiple dependencies since it first tries to fetch each of those from pypi.python.org. In such a case, it is recommended to switch to repo.fortisoar.fortinet.com as the main repository for the python packages also. You can switch the main repository to repo.fortisoar.fortinet.com so by editing the pip.conf file located at: /opt/cyops-integrations/.env/pip.conf as follows:  
index-url=https://repo.fortisoar.fortinet.com/connectors/deps/simple/

You can also change other relevant pip settings such as altering the timeout or retry count setting. See https://pip.pypa.io/en/stable/user_guide/#config-file for a listing of the relevant pip settings. 
For example, to increase the timeout value add the following in the pip.conf file: timeout = 60

Installing a FortiSOAR™ connector using the Content Hub

Use the Content Hub (Connector Store) to easily view, search, install, upgrade, and uninstall connectors that are part of the FortiSOAR™ repository. Therefore, you can now perform these operations using the FortiSOAR™ UI instead of the required CLI access.
Note:  The Content Hub contains all out-of-the-box reference material and product add-ons such as connectors, widgets, and solution packs; whereas the Connector Store has been filtered to display only Connectors.

Important: You must ensure that repo.fortisoar.fortinet.com is reachable from your FortiSOAR™ instance. Otherwise, you will see a blank page when you click Content Hub or Automation > Connectors in the left navigation.

Following are the permissions that you must be assigned to perform operations for connectors:

To open the Connector Store, go to Automation > Connectors, or to go to Content Hub, click Content Hub in the left menu. The Connector Store is filtered to display only connectors, whereas the Content Hub displays all the add-ons. In this article, the screenshots included are from the Content Hub page; similar screens are displayed on the Connector Store page.
The Discover tab displays all the add-ons, i.e., Connectors, Widgets, and Solution Packs, available in the Content Hub. Use the Filter panel to filter the connectors by clicking the > arrow in the Content Type list and then selecting Connectors:

You can search for a connector by its name in the Search field and sort the content alphabetically (A-Z) or by date. Using the Filters panel, you can filter the connectors displayed in all the tabs based on varied criteria. For more information on Content Hub, see the Content Hub chapter in the "User Guide.' Connectors that are installed appear with a tick on their card. For example, the Active Directory connector in the above image.
To install a connector, click the connector card of the connector that you want to install, for example, AbuseIPDB, which opens a popup with the connector name:

The connector popup contains details such as the name and version of the connector, whether the connector is certified or not, who is the publisher of the connector, and the link to the connector documentation. The Summary tab contains a brief description of the connector, and the Contents tab contains a list of actions the connector can perform.

Click Install in the connector name popup to begin the installation of the connector after confirmation, as shown in the following image:

Once installation is complete, FortiSOAR displays the "Connector Installed successfully" message, and the connector gets added to the Manage page. After installing the connector, you must configure the connector by entering the required configuration details in the connector popup:

You can also configure the connector on the Manage page by clicking the connector name card, which will also display the same connector popup. For the procedure to configure a connector, click here.

To uninstall a connector, click the Uninstall button, in the connector popup. FortiSOAR displays a Confirmation dialog, click Confirm to uninstall the connector. FortiSOAR displays the "Connector uninstalled successfully" message and the connector is removed from the Manage page. To uninstall a connector, you must be assigned a role that has a minimum of Delete access to the Connectors module

If any connector that is installed and configured on your system has an upgraded version, for example, if you have version 5.0.0 of the Fortinet FortiGate connector installed on your system and FortiSOAR™ has released a newer version of this connector, i.e., version 5.1.0, then you can see an Update Available link on the connector card:

When you click on a connector that has an updated version, you will see a 'What's new?' section on the configuration page, besides the Update to <version number> button. Clicking the What's New? link displays the highlights of the new version, which you can view to understand what you can expect when you upgrade your connector version. Click the Update to <version number> button to upgrade your connector:

Importing a connector in FortiSOAR™

  1. Log on to FortiSOAR™.

  2. On the left navigation pane, click Content Hub.

  3. Click the Manage tab.

  4. On the Manage page, click Upload > Upload Connector to display the Upload Connector popup as shown in the following image:

    You can drag and drop the connector .tgz file onto the popup or browse to the .tgz file to install the connector in FortiSOAR. If you have an existing version of the connector on your system, then you can click the Replace existing version checkbox, to replace that version of the connector.
    You must check that all the connector dependencies are available or install the dependencies additional to ensure that the connector functions as expected.
  5. Once the connector is imported successfully into FortiSOAR™, you can configure the connector. For the procedure to configure a connector, click here

Installing a FortiSOAR™ connector using the yum command

All connectors provided by  FortiSOAR™ are delivered using a FortiSOAR™ repository. Therefore, you must set up your FortiSOAR™ repository and use the yum command to install connectors as a root user.

Important: The recommended way to install a connector is by using the Connector Store. 

To install a connector, you must be assigned a role that has a minimum of Read and Create access to the Connectors module. 

To install a FortiSOAR™-provided connector use the following command:

yum install cyops-connector-<connectorname>

For example, yum install cyops-connector-symantec-atp
Note: After you install a connector using the yum command the new connector is not reflected until you refresh the Connectors page.   

To update a FortiSOAR™-provided connector use the following command:

yum update cyops-connector-<connectorname>

For example, yum update cyops-connector-symantec-atp 

To remove a  FortiSOAR™-provided connector use the following command:

yum remove cyops-connector-<connectorname>

For example, yum remove cyops-connector-symantec-atp 

Note: If you delete a FortiSOAR™-provided connector using the Connector page in FortiSOAR™ then you cannot reinstall the RPM of the same connector because the RPM of the connector does not get deleted. Therefore, to remove a FortiSOAR™-provided connector, you must use the following command:
yum remove cyops-connector-<connectorName> command.

Points to note:

Some of the connectors have dependencies on additional python packages. During connector installation, these dependencies are also installed using pip. The default pip settings point to the pypi.python.org repository for downloading these packages. We have also added an alternate repository on repo.fortisoar.fortinet.com to host the connector dependencies. If your instance restricts access to pypi.python.org, the installer fallbacks to this alternate repository for installing the dependencies. However, the connector installation might take a considerable amount of time, if there are multiple dependencies since it first tries to fetch each of those from pypi.python.org. In such a case, it is recommended to switch to repo.fortisoar.fortinet.com as the main repository for the python packages also. You can switch the main repository to repo.fortisoar.fortinet.com so by editing the pip.conf file located at: /opt/cyops-integrations/.env/pip.conf as follows:  
index-url=https://repo.fortisoar.fortinet.com/connectors/deps/simple/

You can also change other relevant pip settings such as altering the timeout or retry count setting. See https://pip.pypa.io/en/stable/user_guide/#config-file for a listing of the relevant pip settings. 
For example, to increase the timeout value add the following in the pip.conf file: timeout = 60