Command Line Interface

Command Line Execution

The scan related functions can all be executed via direct command line parameter calls. The scan2reports binaries all include an option to display the 'help' file by calling the -h parameter. The general order of the command line execution parameters is:

usage: scans2reports.exe [-i] [-fd] [-g] [-hd] [-l] [--mitigation-statements {blank,poam,ckl,both}] [--predisposing-conditions PREDISPOSING_CONDITIONS] [-s] [--test-results {add,convert,close}] [-t THREADS] [-x EXCLUDE_PLUGINS] [-c COMMAND] [-e EMAIL] [-n NAME] [-p PHONE] [-h] [input_folder]

required arguments:

**input_folder** - The folder to collect scans from.

optional arguments:

* **-i, --skip-info** - Skip Informational Findings
* **-fd, --finding-details** - Whether or not to include the finding details in the POAM/RAR Comments
* **-g, --gui** - Use the GUI instead of the console
* **-hd, --host-details** - Show affected devices as hostname [SCAN_TYPE - Ver: #, Rel/Feed: # ] on the POAM/RAR tabs
* **-l, --lower-risk** - Automatically Lower Risk on POAM
* **--mitigation-statements** _{blank,poam,ckl,both}_ - Import Mitigation Methods (blank, poam, ckl, both)
* **--predisposing-conditions** _"PREDISPOSING_CONDITIONS"_ - Enter default Predisposing Conditions
* **-s, --scd** - Prefill Estimated SCD to POAM
* **--test-results** _{add, convert, close}_ - Add, Close or Convert CCI Mismatches
* **-t** _THREADS_, **--threads** _THREADS_- How intensive should the generator run (1-3).  Defaults to 2.
* -**x** _AGE_, **--exclude-plugins** _AGE_ - Exclude plugins newer than this number of days.  Defaults to 30
* **-c** _"COMMAND"_, **--command** _"COMMAND"_ - Add Responsible Command/Organization Caption to POAM
* **-e** _"EMAIL"_, **--email** _"EMAIL"_  - Add POC Email Address to POAM
* **-n** _"NAME"_, **--name** _"NAME"_ - Add POC Name to POAM
* **-p** _"PHONE"_, **--phone** _"PHONE"_ - Add POC Phone Number to POAM
* **-h, --help** - Show this help message and exit