Database connector can be used to connect, query, and retrieve data from a database. You can connect to multiple databases by setting up multiple configurations.
This document provides information about the Database Connector, which facilitates automated interactions, with a Database server using FortiSOAR™ playbooks. Add the Database Connector as a step in FortiSOAR™ playbooks and perform automated operations with Database.
Connector Version: 2.2.1
FortiSOAR™ Version Tested on: 7.5.0-4015
Authored By: Fortinet
Certified: Yes
Following enhancements have been made to the Database Connector in version 2.2.1:
@.Use the Content Hub to install the connector. For the detailed procedure to install a connector, click here.
You can also use the yum command as a root user to install the connector:
yum install cyops-connector-database
For the procedure to configure a connector, click here
In FortiSOAR™, on the Connectors page, click the Database connector row (if you are in the Grid view on the Connectors page) and in the Configurations tab enter the required configuration details:
| Parameter | Description |
|---|---|
| Host | Specify the hostname of the database server to connect and perform automated operations. |
| Port | Specify the port number to connect to the database server and perform automated operations. |
| Engine | Select the database engine type of the database to connect and perform automated operations. You can choose from the following options:
NOTE: If you have externalized your PostgreSQL Database, update the host information and the credentials of the external PostgreSQL database server on the database connector's configuration page. For more information on the externalization of the PostgreSQL Database, see the Externalization of your FortiSOAR™ PostgreSQL database chapter in the FortiSOAR™ Administration Guide. |
| Database | Specify the name of the database to connect and perform automated operations. |
| Username | Specify the username to access the database and perform automated operations. |
| Password | Specify the password to access the database and perform automated operations. |
The following automated operations can be included in playbooks and you can also use the annotations to access operations:
| Function | Description | Annotation and Category |
|---|---|---|
| Query DB | Executes a query on the configured database based on the query string that you have specified. | db_query |
| Parameter | Description |
|---|---|
| Query String | Specify the query to run on the configured database for retrieving data. |
The output contains a non-dictionary value.
The Sample - Database - 2.2.1 playbook collection comes bundled with the Database connector. These playbooks contain steps using which you can perform all supported actions. You can see bundled playbooks in the Automation > Playbooks section in FortiSOAR™ after importing the Database connector.
Note: If you are planning to use any of the sample playbooks in your environment, ensure that you clone those playbooks and move them to a different collection since the sample playbook collection gets deleted during connector upgrade and delete.
Database connector can be used to connect, query, and retrieve data from a database. You can connect to multiple databases by setting up multiple configurations.
This document provides information about the Database Connector, which facilitates automated interactions, with a Database server using FortiSOAR™ playbooks. Add the Database Connector as a step in FortiSOAR™ playbooks and perform automated operations with Database.
Connector Version: 2.2.1
FortiSOAR™ Version Tested on: 7.5.0-4015
Authored By: Fortinet
Certified: Yes
Following enhancements have been made to the Database Connector in version 2.2.1:
@.Use the Content Hub to install the connector. For the detailed procedure to install a connector, click here.
You can also use the yum command as a root user to install the connector:
yum install cyops-connector-database
For the procedure to configure a connector, click here
In FortiSOAR™, on the Connectors page, click the Database connector row (if you are in the Grid view on the Connectors page) and in the Configurations tab enter the required configuration details:
| Parameter | Description |
|---|---|
| Host | Specify the hostname of the database server to connect and perform automated operations. |
| Port | Specify the port number to connect to the database server and perform automated operations. |
| Engine | Select the database engine type of the database to connect and perform automated operations. You can choose from the following options:
NOTE: If you have externalized your PostgreSQL Database, update the host information and the credentials of the external PostgreSQL database server on the database connector's configuration page. For more information on the externalization of the PostgreSQL Database, see the Externalization of your FortiSOAR™ PostgreSQL database chapter in the FortiSOAR™ Administration Guide. |
| Database | Specify the name of the database to connect and perform automated operations. |
| Username | Specify the username to access the database and perform automated operations. |
| Password | Specify the password to access the database and perform automated operations. |
The following automated operations can be included in playbooks and you can also use the annotations to access operations:
| Function | Description | Annotation and Category |
|---|---|---|
| Query DB | Executes a query on the configured database based on the query string that you have specified. | db_query |
| Parameter | Description |
|---|---|
| Query String | Specify the query to run on the configured database for retrieving data. |
The output contains a non-dictionary value.
The Sample - Database - 2.2.1 playbook collection comes bundled with the Database connector. These playbooks contain steps using which you can perform all supported actions. You can see bundled playbooks in the Automation > Playbooks section in FortiSOAR™ after importing the Database connector.
Note: If you are planning to use any of the sample playbooks in your environment, ensure that you clone those playbooks and move them to a different collection since the sample playbook collection gets deleted during connector upgrade and delete.