Fortinet Document Library

Version:


Table of Contents

1.0.0
Copy Link

About the connector

A DNS server is a type of name server that manages, maintains, and processes Internet domain names and their associated records.

This document provides information about the DNS connector, which facilitates automated interactions with DNS using FortiSOAR™ playbooks. Add the DNS connector as a step in FortiSOAR™ playbooks and perform automated operations, such as providing DNS lookups of both FQDN/Domain or IP addresses.

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

For the detailed procedure to install a connector, click here

Prerequisites to configuring the connector

  • You must have the URL of DNS server to which you will connect and perform automated operations.
  • 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 DNS connector, and click Configure to configure the following parameters:

Parameter Description
DNS Server IP Provide the DNS server to perform a lookup on FQDNs/Domains, or IP addresses.

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
Lookup FQDN/Domain Fetches a list of IP addresses associated with the given FQDN/Domain from DNS. lookup_domain
Investigation
Lookup IP Fetches the domains associated with the given IP address from DNS. lookup_ip
Investigation

operation: Lookup FQDN/Domain

Input parameters

Parameter Description
FQDN/Domain FQDN/Domain name that you want to lookup in DNS.
DNS Record Type Record type of the FQDN/Domain that you want to lookup in DNS.

Output

The output contains the following populated JSON schema:
{
     "response_message": "string",
     "ip_addresses": {}
}

operation: Lookup IP

Input parameters

Parameter Description
IP Address IP Address to reverse lookup in DNS.

Output

The output contains the following populated JSON schema:
{
     "response_message": "string",
     "hostnames": {}
}

Included playbooks

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

  • Lookup FQDN/Domain
  • Lookup IP

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

A DNS server is a type of name server that manages, maintains, and processes Internet domain names and their associated records.

This document provides information about the DNS connector, which facilitates automated interactions with DNS using FortiSOAR™ playbooks. Add the DNS connector as a step in FortiSOAR™ playbooks and perform automated operations, such as providing DNS lookups of both FQDN/Domain or IP addresses.

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

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

Parameter Description
DNS Server IP Provide the DNS server to perform a lookup on FQDNs/Domains, or IP addresses.

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
Lookup FQDN/Domain Fetches a list of IP addresses associated with the given FQDN/Domain from DNS. lookup_domain
Investigation
Lookup IP Fetches the domains associated with the given IP address from DNS. lookup_ip
Investigation

operation: Lookup FQDN/Domain

Input parameters

Parameter Description
FQDN/Domain FQDN/Domain name that you want to lookup in DNS.
DNS Record Type Record type of the FQDN/Domain that you want to lookup in DNS.

Output

The output contains the following populated JSON schema:
{
     "response_message": "string",
     "ip_addresses": {}
}

operation: Lookup IP

Input parameters

Parameter Description
IP Address IP Address to reverse lookup in DNS.

Output

The output contains the following populated JSON schema:
{
     "response_message": "string",
     "hostnames": {}
}

Included playbooks

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