Fortinet Document Library

Version:


Table of Contents

Microsoft SQL Server

1.0.0
Copy Link

About the connector

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.

Version information

Connector Version: 1.0.0

Authored By: Fortinet

Certified: No

Installing the connector

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:

yum install cyops-connector-microsoft-sql-server

For the detailed procedure to install a connector, click here

Prerequisites to configuring the connector

  • You must have the name of the Microsoft SQL Server server and the name of the database to which you will connect and perform automated operations and credentials to access that server database.
  • To access the FortiSOAR™ UI, ensure that port 443 is open through the firewall for the FortiSOAR™ instance.

Configuring the connector

For the procedure to configure a connector, click here

Configuration parameters

In FortiSOAR™, on the connectors page, select the Microsoft SQL Server connector, and click Configure to configure the following parameters:

Parameter Description
Server Name Server name of the Microsoft SQL Server server.
Database Name Name of the database to connect.
Username Username to connect SQL server database.
Password Password to connect SQL server database.
Trusted Connection Determines whether to set the connection as trusted or not.

Actions supported by the connector

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
Run Query Runs a SQL Query in the connected Microsoft SQL Server. run_query
Investigation

operation: Run Query

Input parameters

Parameter Description
SQL Query SQL query which you want to run on the database.
For example, Create, Update, Delete or Insert.

Output

The output contains a non-dictionary value.

Included playbooks

The Sample - Microsoft SQL Server - 1.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.

  • Run Query

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.

About the connector

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.

Version information

Connector Version: 1.0.0

Authored By: Fortinet

Certified: No

Installing the connector

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:

yum install cyops-connector-microsoft-sql-server

For the detailed procedure to install a connector, click here

Prerequisites to configuring the connector

Configuring the connector

For the procedure to configure a connector, click here

Configuration parameters

In FortiSOAR™, on the connectors page, select the Microsoft SQL Server connector, and click Configure to configure the following parameters:

Parameter Description
Server Name Server name of the Microsoft SQL Server server.
Database Name Name of the database to connect.
Username Username to connect SQL server database.
Password Password to connect SQL server database.
Trusted Connection Determines whether to set the connection as trusted or not.

Actions supported by the connector

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
Run Query Runs a SQL Query in the connected Microsoft SQL Server. run_query
Investigation

operation: Run Query

Input parameters

Parameter Description
SQL Query SQL query which you want to run on the database.
For example, Create, Update, Delete or Insert.

Output

The output contains a non-dictionary value.

Included playbooks

The Sample - Microsoft SQL Server - 1.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.