MySQL is the one of the most popular Open Source Relational SQL Database Management System. MySQL is used for developing various web-based software applications. The MySQL database server manages the databases and tables, controls user access, and processes the SQL queries.
This document provides information about the MySQL connector, which facilitates automated interactions, with a MySQL server using FortiSOAR™ playbooks. Add the MySQL connector as a step in FortiSOAR™ playbooks and perform automated operations, such as executing a query on MySQL database and listing table and column names present in the database.
Connector Version: 1.0.1
FortiSOAR™ Version Tested on: 7.6.1-5275
Authored By: Fortinet
Certified: Yes
Following enhancements have been made to the MySQL connector in version 1.0.1:
caching_sha2_password was not supported.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-mysql
For the procedure to configure a connector, click here.
In FortiSOAR™, on the Connectors page, select the MySQL connector and click Configure to configure the following parameters:
| Parameter | Description |
|---|---|
| Server URL | Hostname or IP Address of the instance on which you have installed the MySQL database server to which you will connect and perform automated operations. |
| Database | Database name that is used while connecting to the MySQL server. This would be the database to which you will connect and perform automated operations |
| Username | (Optional) Username to access the MySQL database to which you will connect and perform automated operations. |
| Password | (Optional) Password to access the MySQL database to which you will connect and perform automated operations. |
The following automated operations can be included in playbooks, and you can also use the annotations to access operations from FortiSOAR™ release 4.10.0 onwards:
| Function | Description | Annotation and Category |
|---|---|---|
| Run Query | Executes a query on the MySQL database. You can execute any valid SQL query such as Create, Update, Delete, Insert or Select. |
run_query Investigation |
| List Tables | Lists the names of all tables that are available in the MySQL database. | list_tables Investigation |
| List Columns | Lists the names and details of the table that you specified retrieved from the MySQL database, based on the table name you have specified. | list_columns Investigation |
| Parameter | Description |
|---|---|
| Query | Query that you want to trigger on the MySQL database. You can perform all sorts of operations such as Create, Update, Delete, Insert, or Select, on the MySQL database using this query. For example, CREATE TABLE Student(Id Int, Name Varchar(20); |
No output schema is available at this time.
None
No output schema is available at this time.
| Parameter | Description |
|---|---|
| Table Name | Specify the name of the table whose list of columns you want to retrieve from the MySQL database. |
The output contains the following populated JSON schema:
[
{
"Type": "",
"Field": "",
"Extra": "",
"Default": "",
"Key": "",
"Null": ""
}
]
The Sample - MySQL - 1.0.1 playbook collection comes bundled with the MySQL connector. This playbook contains steps using which you can perform all supported actions. You can see the bundled playbooks in the Automation > Playbooks section in FortiSOAR™ after importing the MySQL 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.
MySQL is the one of the most popular Open Source Relational SQL Database Management System. MySQL is used for developing various web-based software applications. The MySQL database server manages the databases and tables, controls user access, and processes the SQL queries.
This document provides information about the MySQL connector, which facilitates automated interactions, with a MySQL server using FortiSOAR™ playbooks. Add the MySQL connector as a step in FortiSOAR™ playbooks and perform automated operations, such as executing a query on MySQL database and listing table and column names present in the database.
Connector Version: 1.0.1
FortiSOAR™ Version Tested on: 7.6.1-5275
Authored By: Fortinet
Certified: Yes
Following enhancements have been made to the MySQL connector in version 1.0.1:
caching_sha2_password was not supported.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-mysql
For the procedure to configure a connector, click here.
In FortiSOAR™, on the Connectors page, select the MySQL connector and click Configure to configure the following parameters:
| Parameter | Description |
|---|---|
| Server URL | Hostname or IP Address of the instance on which you have installed the MySQL database server to which you will connect and perform automated operations. |
| Database | Database name that is used while connecting to the MySQL server. This would be the database to which you will connect and perform automated operations |
| Username | (Optional) Username to access the MySQL database to which you will connect and perform automated operations. |
| Password | (Optional) Password to access the MySQL database to which you will connect and perform automated operations. |
The following automated operations can be included in playbooks, and you can also use the annotations to access operations from FortiSOAR™ release 4.10.0 onwards:
| Function | Description | Annotation and Category |
|---|---|---|
| Run Query | Executes a query on the MySQL database. You can execute any valid SQL query such as Create, Update, Delete, Insert or Select. |
run_query Investigation |
| List Tables | Lists the names of all tables that are available in the MySQL database. | list_tables Investigation |
| List Columns | Lists the names and details of the table that you specified retrieved from the MySQL database, based on the table name you have specified. | list_columns Investigation |
| Parameter | Description |
|---|---|
| Query | Query that you want to trigger on the MySQL database. You can perform all sorts of operations such as Create, Update, Delete, Insert, or Select, on the MySQL database using this query. For example, CREATE TABLE Student(Id Int, Name Varchar(20); |
No output schema is available at this time.
None
No output schema is available at this time.
| Parameter | Description |
|---|---|
| Table Name | Specify the name of the table whose list of columns you want to retrieve from the MySQL database. |
The output contains the following populated JSON schema:
[
{
"Type": "",
"Field": "",
"Extra": "",
"Default": "",
"Key": "",
"Null": ""
}
]
The Sample - MySQL - 1.0.1 playbook collection comes bundled with the MySQL connector. This playbook contains steps using which you can perform all supported actions. You can see the bundled playbooks in the Automation > Playbooks section in FortiSOAR™ after importing the MySQL 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.