About the connector
Oracle Database is an object-relational database management system used for running online transaction processing (OLTP), data warehousing (DW), and mixed (OLTP & DW) database workloads.
This document provides information about the Oracle Database Connector, which facilitates automated interactions, with an Oracle database server using FortiSOAR™ playbooks. Add the Oracle Database connector as a step in FortiSOAR™ playbooks and use it to connect to the Oracle database and then query the database to retrieve data.
Note: This connector supports Oracle v12c and onwards.
Version information
Connector Version: 1.0.1
Authored By: Fortinet CSE
Contributor: Vincent
Certified: No
Release Notes for version 1.0.1
The following enhancements have been made to the Oracle Database connector in version 1.0.1:
- Resolve the decimal datatype parsing issue by updating the latest version of 'sqlalchemy' in the Oracle Database connector and adding the external 'simplejson' library to the Oracle Database connector.
Installing the connector
Use the Content Hub to install the connector. For the detailed procedure to install a connector, click here.
You can also use the following yum command as a root user to install connectors from an SSH session:
yum install cyops-connector-oracle-db
Prerequisites to configuring the connector
- You must have the URL of the Oracle Database server to which you will connect and perform automated operations and credentials to access that server.
- The FortiSOAR™ server should have outbound connectivity to port 443 on the Oracle Database server.
- You must install the 'Oracle Instant Client' in the FortiSOAR instance in which you want to use the Oracle Database Connector.
To download and install the required package, i.e., 'Oracle Instant Client' use the following command on your RHEL, CentOS, or Rocky Linux system:
yum install https://download.oracle.com/otn_software/linux/instantclient/218000/oracle-instantclient-basic-21.8.0.0.0-1.el8.x86_64.rpm
Minimum Permissions Required
Configuring the connector
For the procedure to configure a connector, click here.
Configuration parameters
In FortiSOAR™, on the Content Hub page, click the Manage tab, and then click the Oracle Database connector card. On the connector popup, click the Configurations tab to enter the required configuration details:
| Parameter |
Description |
| Host |
Specify the Hostname of the database server to which you will connect and perform the automated operations. |
| Port |
Specify the Database Listener Port number used for connecting to the database server. By default, this is set as 1521. |
| Database name |
Specify the name of the database to which you will connect and perform automated operations. |
| Username |
Specify the username to access the database to which you will connect and perform automated operations. |
| Password |
Specify the password to access the database to which you will connect and perform automated operations. |
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™:
| Function |
Description |
Annotation and Category |
| Query DB |
Performs a query on the configured database based on the query string you have specified. |
db_query
Investigation |
operation: Query DB
Input parameters
| Parameter |
Description |
| Query String |
Specify the query that you want to run on the configured database from which you want to retrieve the required data. |
Output
The output contains a non-dictionary value.
Included playbooks
The Sample - Oracle Database - 1.0.1 playbook collection comes bundled with the Oracle 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 Oracle 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 overwritten during the connector upgrade and gets deleted during connector uninstall.
