Update descriptions of the defaults in the cyhy_commander role

Make sure to mention that all three variables are only used in the "production" section of the generated configuration file. Co-authored-by: dav3r <[email protected]>
cisagov · Aug 25, 2023 · 2efa82e · 2efa82e
1 parent 01f352b
commit 2efa82e
Showing 1 changed file with 8 additions and 2 deletions.
diff --git a/ansible/roles/cyhy_commander/defaults/main.yml b/ansible/roles/cyhy_commander/defaults/main.yml
@@ -1,10 +1,14 @@
 ---
 # defaults file for cyhy_commander
 
-# The maximum number of jobs to assign to each nessus host (vulnscanner)
+# The maximum number of jobs to assign to each nessus host (vulnscanner).
+# This value is used in the "production" section of the cyhy-commander
+# configuration file this role generates.
 jobs_per_nessus_host: 16
 
-# The maximum number of jobs to assign to each nmap host (portscanner)
+# The maximum number of jobs to assign to each nmap host (portscanner).
+# This value is used in the "production" section of the cyhy-commander
+# configuration file this role generates.
 jobs_per_nmap_host: 8
 
 # The maximum number of hosts that are scheduled to have scanning restarted
@@ -13,4 +17,6 @@ jobs_per_nmap_host: 8
 # number of hosts that are transitioned is double the provided value. Hosts
 # that are "up" are transitioned to PORTSCAN and hosts that are "down" are
 # transitioned to NETSCAN1.
+# This value is used in the "production" section of the cyhy-commander
+# configuration file this role generates.
 next_scan_limit: 8192