Microsoft SQL Server is a relational database management system, or RDBMS, developed by Microsoft. Its primary function is of storing and retrieving data as requested by other software applications—which may run either on the same computer or on another computer across a network.
This document provides information about the Microsoft SQL Server connector, which facilitates automated interactions with Microsoft SQL Server using FortiSOAR™ playbooks. Add the Microsoft SQL Server connector as a step in FortiSOAR™ playbooks and run queries on a Microsoft SQL Server.
Connector Version: 2.0.0
FortiSOAR™ Version Tested on: 5.1.0-464
Authored By: Fortinet
Certified: Yes
Following enhancements have been made to the Microsoft SQL Server connector in version 2.0.0:
From FortiSOAR™ 5.0.0 onwards, use the Connector Store to install the connector. For the detailed procedure to install a connector, click here.
You can also use the yum command to install connectors. Connectors provided by FortiSOAR™ are delivered using a FortiSOAR™ repository. Therefore, you must set up your FortiSOAR™ repository and run the yum command as a root user to install connectors:
yum install cyops-connector-microsoft-sql-server
For the detailed procedure to install a connector, click here
For the procedure to configure a connector, click here
In FortiSOAR™, on the Connectors page, click the Microsoft SQL Server 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 |
---|---|
Server Name | Name of the Microsoft SQL Server server to which you will connect and perform automated operations. |
Database Name | Name of the database to which you will connect and perform automated operations. |
Username | Username to connect to the SQL server database to which you will connect and perform automated operations. |
Password | Password to connect to the SQL server 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 and onwards:
Function | Description | Annotation and Category |
---|---|---|
Select Query | Executes the specified SELECT query on the connected Microsoft SQL Server. |
run_query Investigation |
Run Query | Runs the specified SQL query in the connected Microsoft SQL Server. | run_query Investigation |
Get Table List | Retrieves a list containing all table names from the Microsoft SQL database. | list_tables Investigation |
Get Columns | Retrieves the list of all the columns from the Microsoft SQL database based on the table name you have specified. | list_columns Investigation |
Parameter | Description |
---|---|
SQL Query | The Select SQL query that you want to run on the connected Microsoft SQL Server. |
No output schema is available at this time.
Parameter | Description |
---|---|
SQL Query | The SQL query that you want to run on the connected Microsoft SQL Server. Examples of SQL queries that you can run are: Create , Update , Delete , Insert , etc. |
The output contains a non-dictionary value.
None.
The output contains the following populated JSON schema:
[]
Parameter | Description |
---|---|
Table Name | Name of the table whose columns you want to retrieve from the Microsoft SQL database. |
The output contains the following populated JSON schema:
[]
The Sample - Microsoft SQL Server - 2.0.0
playbook collection comes bundled with the Microsoft SQL Server 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 Microsoft SQL Server 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.
Microsoft SQL Server is a relational database management system, or RDBMS, developed by Microsoft. Its primary function is of storing and retrieving data as requested by other software applications—which may run either on the same computer or on another computer across a network.
This document provides information about the Microsoft SQL Server connector, which facilitates automated interactions with Microsoft SQL Server using FortiSOAR™ playbooks. Add the Microsoft SQL Server connector as a step in FortiSOAR™ playbooks and run queries on a Microsoft SQL Server.
Connector Version: 2.0.0
FortiSOAR™ Version Tested on: 5.1.0-464
Authored By: Fortinet
Certified: Yes
Following enhancements have been made to the Microsoft SQL Server connector in version 2.0.0:
From FortiSOAR™ 5.0.0 onwards, use the Connector Store to install the connector. For the detailed procedure to install a connector, click here.
You can also use the yum command to install connectors. Connectors provided by FortiSOAR™ are delivered using a FortiSOAR™ repository. Therefore, you must set up your FortiSOAR™ repository and run the yum command as a root user to install connectors:
yum install cyops-connector-microsoft-sql-server
For the detailed procedure to install a connector, click here
For the procedure to configure a connector, click here
In FortiSOAR™, on the Connectors page, click the Microsoft SQL Server 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 |
---|---|
Server Name | Name of the Microsoft SQL Server server to which you will connect and perform automated operations. |
Database Name | Name of the database to which you will connect and perform automated operations. |
Username | Username to connect to the SQL server database to which you will connect and perform automated operations. |
Password | Password to connect to the SQL server 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 and onwards:
Function | Description | Annotation and Category |
---|---|---|
Select Query | Executes the specified SELECT query on the connected Microsoft SQL Server. |
run_query Investigation |
Run Query | Runs the specified SQL query in the connected Microsoft SQL Server. | run_query Investigation |
Get Table List | Retrieves a list containing all table names from the Microsoft SQL database. | list_tables Investigation |
Get Columns | Retrieves the list of all the columns from the Microsoft SQL database based on the table name you have specified. | list_columns Investigation |
Parameter | Description |
---|---|
SQL Query | The Select SQL query that you want to run on the connected Microsoft SQL Server. |
No output schema is available at this time.
Parameter | Description |
---|---|
SQL Query | The SQL query that you want to run on the connected Microsoft SQL Server. Examples of SQL queries that you can run are: Create , Update , Delete , Insert , etc. |
The output contains a non-dictionary value.
None.
The output contains the following populated JSON schema:
[]
Parameter | Description |
---|---|
Table Name | Name of the table whose columns you want to retrieve from the Microsoft SQL database. |
The output contains the following populated JSON schema:
[]
The Sample - Microsoft SQL Server - 2.0.0
playbook collection comes bundled with the Microsoft SQL Server 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 Microsoft SQL Server 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.