Fortinet black logo

Database Connector

2.1.2

Database Connector v2.1.2

Overview

FortiSOAR™ provides you with a number of pre-installed connectors or built-ins, such as the Utilities or Database connectors that you can use within FortiSOAR™ playbooks, as a connector step, and perform automated operations. These connectors are bundled and named based on the type of operations the connectors can perform. For example, the Database connector would contain actions that you can perform with respect to the database like querying the database. It is easy to extend and enhance these connectors.

Apart from the FortiSOAR™ Built-in connectors, Fortinet also provides a number of connectors for popular integrations like SIEMs, such as FortiSIEM, Splunk, etc., and Ticketing systems such as Jira. You can see a list of published connectors on the FortiSOAR Connectors Documentation site.

The process of installing, configuring, and using connectors is defined in the Introduction to connectors chapter in the "Connectors Guide", which is part of the FortiSOAR™ documentation or see the Installing a connector and Configuring a connector articles.

FortiSOAR™ Built-in connectors are upgraded by default with a FortiSOAR™ upgrade. Use the Content Hub to upgrade your connectors to the latest version, in case you want to only upgrade the connectors and not FortiSOAR™. For more information on the connector store, see the Introduction to connectors chapter and see the FortiSOAR Built-in connectors article.

Important: Before you upgrade your FortiSOAR™ version, it is highly recommended that you take a backup of your FortiSOAR™ Built-in connector's (SSH, IMAP, Database, etc.) configuration since the configuration of your FortiSOAR™ Built-in connectors might be reset if there are changes to the configuration parameters across versions.

Database

Use this connector to connect to a database and then query the database and retrieve data. You can connect to multiple databases by setting up multiple configurations.

Version information

Connector Version: 2.1.2

Authored By: Fortinet.

Certified: Yes

Release Notes for version 2.1.2

Following enhancements have been made to the Database connector in version 2.1.2:

  • Added the 'Documentation' link on the Connector configuration popup, which opens the documentation for this version of the connector.

NOTE: For more information on previous releases of the Database connector, see the Database Connector v2.1.1 document.

Configuration parameters

In FortiSOAR™, on the Content Hub (or Connector Store) page, click the Manage tab, and then click the Database connector card. On the connector popup, click the Configurations tab to enter the required configuration details.

Parameter Description
Host Specify the Hostname of the database server to which you will connect and perform the automated operations.
Port Specify the Port number used for connecting to the database server.
Engine Select the type of database engine to which you will connect and perform the automated operations. You can choose between postgresql, mssql, or mysql.
Note: If you have externalized your PostgreSQL Database, then you will require to update the host information and the credentials in the database connector configuration page, based on the credentials that you have specified for your externalized PostgreSQL database. For more information on the externalization of the PostgreSQL Database, see the Externalization of your FortiSOAR™ PostgreSQL database chapter in the "Administration Guide", which is part of the FortiSOAR™ documentation.
Database Specify the name of the database to which you will connect and perform automated operations.
Username Specify the username to access the database to which you will connect and perform automated operations.
Password Specify the password to access the database to which you will connect and perform automated operations.

Actions supported by the connector

The following automated operations can be included in playbooks:

Function Description
Query DB Performs a query on the configured database based on the query string you have specified.

operation: Query DB

Input parameters

Parameter Description
Query String Specify the query that you want to run on the configured database for retrieving the required data.
Previous
Next

Overview

FortiSOAR™ provides you with a number of pre-installed connectors or built-ins, such as the Utilities or Database connectors that you can use within FortiSOAR™ playbooks, as a connector step, and perform automated operations. These connectors are bundled and named based on the type of operations the connectors can perform. For example, the Database connector would contain actions that you can perform with respect to the database like querying the database. It is easy to extend and enhance these connectors.

Apart from the FortiSOAR™ Built-in connectors, Fortinet also provides a number of connectors for popular integrations like SIEMs, such as FortiSIEM, Splunk, etc., and Ticketing systems such as Jira. You can see a list of published connectors on the FortiSOAR Connectors Documentation site.

The process of installing, configuring, and using connectors is defined in the Introduction to connectors chapter in the "Connectors Guide", which is part of the FortiSOAR™ documentation or see the Installing a connector and Configuring a connector articles.

FortiSOAR™ Built-in connectors are upgraded by default with a FortiSOAR™ upgrade. Use the Content Hub to upgrade your connectors to the latest version, in case you want to only upgrade the connectors and not FortiSOAR™. For more information on the connector store, see the Introduction to connectors chapter and see the FortiSOAR Built-in connectors article.

Important: Before you upgrade your FortiSOAR™ version, it is highly recommended that you take a backup of your FortiSOAR™ Built-in connector's (SSH, IMAP, Database, etc.) configuration since the configuration of your FortiSOAR™ Built-in connectors might be reset if there are changes to the configuration parameters across versions.

Database

Use this connector to connect to a database and then query the database and retrieve data. You can connect to multiple databases by setting up multiple configurations.

Version information

Connector Version: 2.1.2

Authored By: Fortinet.

Certified: Yes

Release Notes for version 2.1.2

Following enhancements have been made to the Database connector in version 2.1.2:

NOTE: For more information on previous releases of the Database connector, see the Database Connector v2.1.1 document.

Configuration parameters

In FortiSOAR™, on the Content Hub (or Connector Store) page, click the Manage tab, and then click the Database connector card. On the connector popup, click the Configurations tab to enter the required configuration details.

Parameter Description
Host Specify the Hostname of the database server to which you will connect and perform the automated operations.
Port Specify the Port number used for connecting to the database server.
Engine Select the type of database engine to which you will connect and perform the automated operations. You can choose between postgresql, mssql, or mysql.
Note: If you have externalized your PostgreSQL Database, then you will require to update the host information and the credentials in the database connector configuration page, based on the credentials that you have specified for your externalized PostgreSQL database. For more information on the externalization of the PostgreSQL Database, see the Externalization of your FortiSOAR™ PostgreSQL database chapter in the "Administration Guide", which is part of the FortiSOAR™ documentation.
Database Specify the name of the database to which you will connect and perform automated operations.
Username Specify the username to access the database to which you will connect and perform automated operations.
Password Specify the password to access the database to which you will connect and perform automated operations.

Actions supported by the connector

The following automated operations can be included in playbooks:

Function Description
Query DB Performs a query on the configured database based on the query string you have specified.

operation: Query DB

Input parameters

Parameter Description
Query String Specify the query that you want to run on the configured database for retrieving the required data.
Previous
Next