Fortinet Document Library

Version:


Table of Contents

1.0.0
Copy Link

About the connector

PostgreSQL, often simply Postgres, is an object-relational database management system with an emphasis on extensibility and standards compliance.

This document provides information about the PostgreSQL connector, which facilitates automated interactions with PostgreSQL using FortiSOAR™ playbooks. Add the PostgreSQL connector as a step in FortiSOAR™ playbooks and perform automated operations, such as retrieving host details and reports from PostgreSQL.

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-postgresql

For the detailed procedure to install a connector, click here

Prerequisites to configuring the connector

  • You must have the hostname and port number of PostgreSQL server to which you will connect and perform automated operations and credentials to access that server.
  • 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 PostgreSQL connector and click Configure to configure the following parameters:

Parameter Description
Host Name Hostname to access PostgreSQL server
Port Number Port number to connect PostgreSQL server
Username Username to access PostgreSQL service
Password Password to access PostgreSQL service
Default DB Name Database name on which to run a query.
Note: If the database name is not provided in the function parameter, then this database name is taken as default.
Verify SSL Specifies whether the SSL certificate for the server is to be verified or not.
By default, this option is set as True.

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 Run Query in PostgreSQL. run_query
Investigation

operation: Run Query

Input parameters

Parameter Description
DB Name Database name on which to run the query.
Query Query to run on the specified database

Output

The output contains a non-dictionary value.

Included playbooks

The Sample - PostgreSQL - 1.0.0 playbook collection comes bundled with the PostgreSQL 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 PostgreSQL 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

PostgreSQL, often simply Postgres, is an object-relational database management system with an emphasis on extensibility and standards compliance.

This document provides information about the PostgreSQL connector, which facilitates automated interactions with PostgreSQL using FortiSOAR™ playbooks. Add the PostgreSQL connector as a step in FortiSOAR™ playbooks and perform automated operations, such as retrieving host details and reports from PostgreSQL.

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-postgresql

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 PostgreSQL connector and click Configure to configure the following parameters:

Parameter Description
Host Name Hostname to access PostgreSQL server
Port Number Port number to connect PostgreSQL server
Username Username to access PostgreSQL service
Password Password to access PostgreSQL service
Default DB Name Database name on which to run a query.
Note: If the database name is not provided in the function parameter, then this database name is taken as default.
Verify SSL Specifies whether the SSL certificate for the server is to be verified or not.
By default, this option is set as True.

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 Run Query in PostgreSQL. run_query
Investigation

operation: Run Query

Input parameters

Parameter Description
DB Name Database name on which to run the query.
Query Query to run on the specified database

Output

The output contains a non-dictionary value.

Included playbooks

The Sample - PostgreSQL - 1.0.0 playbook collection comes bundled with the PostgreSQL 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 PostgreSQL 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.