About the connector
NMAP (Network Mapper) is a free and open-source security scanner used to discover hosts and services on a computer network, thus building a "map" of the network.
This document provides information about the NMAP Scanner connector, which facilitates automated interactions with NMAP Scanner using FortiSOAR™ playbooks. Add the NMAP Scanner connector as a step in FortiSOAR™ playbooks and perform automated operations, such as executing an NMAP scan for a specified host or IP address.
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-nmap-scanner
For the detailed procedure to install a connector, click here
Prerequisites to configuring the connector
- 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
You do not need to configure any parameters for the NMAP Scanner connector.
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 |
| Scan Network |
Executes an NMAP scan for the specified host or IP address. |
scan_network
Investigation |
operation: Scan Network
Input parameters
| Parameter |
Description |
| Hostname/FQDN/IP Address |
Provide hostname or FQDN or IP Address on which NMAP query needs to execute. |
| Port |
Port number of host to run NMAP query. e.g. 22,80,443,1000-1024 |
| Command Arguments |
Provide various NMAP command arguments. e.g. -n -sP -PE -PA21 |
Output
The output contains a non-dictionary value.
Included playbooks
The Sample - NMAP Scanner - 1.0.0 playbook collection comes bundled with the NMAP Scanner 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 NMAP Scanner 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.
