Fortinet Document Library

Version:


Table of Contents

Installing a connector

0.0.0
Copy Link

Installing a FortiSOAR™ connector using the Connector Store

Use the 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.

Important: You must ensure that update.cybersponse.com is reachable from your FortiSOAR™ instance. Otherwise, you will see a blank page when you click the Connector Store link. 

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

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

  • To upgrade or configure a connector, you must be assigned a role that has a minimum of Update and Read access to the Connectors module and Read access to the Playbooks module.

  • To uninstall a connector, you must be assigned a role that has a minimum of Delete and Read access to the Connectors module and Read access to the Playbooks module.

  • To view connectors and to use the connector as a step in the playbooks, you must be assigned a role that has a minimum of Read access to the Connectors and Playbooks module. 

To go to the connector store, click Automation > Connectors. On the Connectors page, click the Connector Store button. The Connector Store page appears as shown in the following image:

You can search for a connector by connector name in the Search by connector name box.

The Connector Store page has been enhanced in FortiSOAR™ 5.0.1 to include a filter for installed and not installed connectors. You can filter connectors by clicking the Filter drop-down list and choosing between All, Installed or Not Installed filters. The chosen filter applies only to the Connector Store page. 

Connectors that you can install appear with a Install (blue) icon as shown in the above image. To install a connector, click the connector card of the connector that you want to install, for example, AlienValult OTX, which opens a popup with the connector name:

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

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

Once the installation is complete, FortiSOAR™ displays the "Connector Installed successfully" message, Active is displayed on the popup, and on the main connectors page you will see the installed connectors number increase by 1. 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 Connectors 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 Connector icon, in the connector popup. FortiSOAR™ displays a Confirmation dialog, click Confirm to uninstall the connector. FortiSOAR™ displays the "Connector uninstalled successfully" message and the installed connectors number decreases by 1.

If any connector that is installed and configured on your system has an upgraded version, for example, if you have version 1.0.0 of the PagerDuty connector installed on your system and FortiSOAR™ has released a newer version of this connector, i.e., version 2.0.0 of the PagerDuty connector, then the Updates button will display 1. To update a connector that you have installed and configured on your system, click the Updates button and install the updated connector.

Importing a connector in FortiSOAR™

  1. Log on to FortiSOAR™.

  2. On the left navigation pane, click Automation > Connectors.

  3. Click the + (Add Connector) icon to import a connector (.tgz) file into FortiSOAR™, which displays the Add 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™. You must check that all the connector dependencies are available or install the dependencies additional to ensure that the connector functions as expected.
  4. 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 update.cybersponse.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 update.cybersponse.com as the main repository for the python packages also. You can switch the main repository to update.cybersponse.com so by editing the pip.conf file located at: /opt/cyops-integrations/.env/pip.conf as follows:  
index-url=https://update.cybersponse.com/cybersponse/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 Connector Store

Use the 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.

Important: You must ensure that update.cybersponse.com is reachable from your FortiSOAR™ instance. Otherwise, you will see a blank page when you click the Connector Store link. 

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

To go to the connector store, click Automation > Connectors. On the Connectors page, click the Connector Store button. The Connector Store page appears as shown in the following image:

You can search for a connector by connector name in the Search by connector name box.

The Connector Store page has been enhanced in FortiSOAR™ 5.0.1 to include a filter for installed and not installed connectors. You can filter connectors by clicking the Filter drop-down list and choosing between All, Installed or Not Installed filters. The chosen filter applies only to the Connector Store page. 

Connectors that you can install appear with a Install (blue) icon as shown in the above image. To install a connector, click the connector card of the connector that you want to install, for example, AlienValult OTX, which opens a popup with the connector name:

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

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

Once the installation is complete, FortiSOAR™ displays the "Connector Installed successfully" message, Active is displayed on the popup, and on the main connectors page you will see the installed connectors number increase by 1. 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 Connectors 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 Connector icon, in the connector popup. FortiSOAR™ displays a Confirmation dialog, click Confirm to uninstall the connector. FortiSOAR™ displays the "Connector uninstalled successfully" message and the installed connectors number decreases by 1.

If any connector that is installed and configured on your system has an upgraded version, for example, if you have version 1.0.0 of the PagerDuty connector installed on your system and FortiSOAR™ has released a newer version of this connector, i.e., version 2.0.0 of the PagerDuty connector, then the Updates button will display 1. To update a connector that you have installed and configured on your system, click the Updates button and install the updated connector.

Importing a connector in FortiSOAR™

  1. Log on to FortiSOAR™.

  2. On the left navigation pane, click Automation > Connectors.

  3. Click the + (Add Connector) icon to import a connector (.tgz) file into FortiSOAR™, which displays the Add 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™. You must check that all the connector dependencies are available or install the dependencies additional to ensure that the connector functions as expected.
  4. 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 update.cybersponse.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 update.cybersponse.com as the main repository for the python packages also. You can switch the main repository to update.cybersponse.com so by editing the pip.conf file located at: /opt/cyops-integrations/.env/pip.conf as follows:  
index-url=https://update.cybersponse.com/cybersponse/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