Skip to content

Banner Home Installation and Requirements Quick Usage and Examples Commands and Options Docs Changelog License

nmapUnleashed Docs

🧰 Commands and Options

nmapUnleashed provides a set of options which are briefly described down below, these extend the normal option set of Nmap. For the official Nmap parameters, that nmapUnleashed inheritates, please checkout the official Nmap docs. For permanent changes the config file can be edited. For detailed information please visit the docs.

(Only -v, -oN, -oX, -oS, -oG and -oA are not available as these functions are handeld through nmapUnleashed.)

After nmapUnleashed finishes, a dashboard.txt file is generated containing a complete overview of all performed scans, results, and statuses.

Usage

Usage: nmapUnleashed [OPTIONS] [TARGETS]...

Arguments

[TARGETS]... — Specify one or more targets for the scan.

Targets can be:

  • Single IP addresses (e.g., 192.168.1.1 or fd12:3456:789a::)
  • CIDR ranges (e.g., 10.0.0.0/24 or fd12:3456:789a::/28)
  • Hostnames / DNS names (e.g., scanme.nmap.org)
  • Files containing one target per line (e.g., targets.txt)

You can also assign custom Nmap parameters per target using the syntax: "<target>=<nmapParameter>"

Scan Options

Option Value Type Default Value Description
-th /
--threads		 \<number> 4 Number of threads (max parallel scans).
-ps /
--parameter-set		 \<id> None Apply a predefined parameter set / preset (nmap and unleashed parameter) from config, merged with parameters given at runtime.
-kt /
--kill-threshold		 \<minutes> None Automatically abort a scan if it reaches the specified runtime.
-ex /
--exclude		 \<target> None Exclude passed target(s) (IP, CIDR, DNS, File) from target list.

Dashboard Options

Option Value Type Default Value Description
-nwr /
--network-warning-receive		 \<integerInKBp> 0 Warn if incoming network traffic reaches defined KBps (0 to disable).
-nwt /
--network-warning-transmit		 \<integerInKBp> 0 Warn if outgoing network traffic reaches defined KBps (0 to disable).
-fs /
--fixed-size		 N/A False Keep the dashboard size fixed.

Output Options

Option Value Type Default Value Description
-ko /
--keep-offline		 N/A False Preserve scan files for non-online targets; they are always listed in dashboard.txt.
-rf /
--remove-files		 \<listOfFileTypes> None Delete specified scan files after completion (e.g., "xml" or "xml;gnmap").
-nf /
--no-folder		 N/A False Store all scan files in the current directory instead of creating a subfolder per scan.
-op /
--output-pattern		 \<outputPattern> {target} Set the naming pattern for scan files and folders (e.g., {target}_{parameter});{target} is mandatory.
-nd /
--no-dashboard		 N/A False Do not create the dashboard.txt file (holding an overview over performed scans and their states).

Misc Options

Option Value Type Default Value Description
-c /
--config		 "\<configKey>:\<value>;..." None Temporarily adjust configuration settings for this run (adjust config file for permanent changes).
-qm /
--quiet-mode		 N/A False Enable quiet mode (no banner or version info).
-sm /
--silence-mode		 N/A False Enable silent mode (suppress all terminal output).
-v /
--version		 N/A N/A Display nmapUnleashed version.
-h /
--help		 N/A N/A Display help message.