Managing scan templates

View as Markdown

A scan template is a predefined set of scan options and settings. If you use a scan configuration often, save it as a scan template, and the next time you create a scan, choose the template instead of configuring the settings by hand. Every update you make to the template applies automatically to new and recurring scans based on it, and to any queued scans that were set up from it but haven’t started yet. Templates save you time and make a misconfigured scan less likely.

When you create a scan from a template, you can’t edit the fields the template sets. You can still configure the site, scan name, discovery scope, Explorer, and scan schedule, because the template doesn’t define those.

Each time a scan runs with values from a template, runZero saves the scan task with a copy of those parameters, so the task lists the values it used even if the template changes after the scan completes.

Creating a scan template

You can create a scan template in a few ways:

  • From Tasks > Task library
  • From an existing scan task
  • From an existing scan template

Creating a scan template from scratch

  1. Go to Tasks > Task library to open the task library.
  2. From the Task library, click Add template.
  3. In the scan configuration form, enter a name for the template. You’ll use this name to find the template and assign it to a new scan.
  4. Configure the scan as you normally would, using these tabs:
    • Standard holds the name, description, and scan rate for the template.
    • Advanced covers excluded hosts, included ports, tags, host rates, group size, UDP probe max attempts, max TTL for all scan probe packets, ToS, screenshots, and subnet sampling.
    • Probes and SNMP enables SNMP and additional probes and takes their credentials. With the SNMP probe enabled, the scan uses the port and credentials you provide to find anything with SNMP enabled.
    • Credentials enables any preconfigured credentials you want the scan to use; see Scanning with credentials. The scan uses a credential when its defined CIDR scope matches the scan target.
  5. Save the template.

To use the template, open the Templates tab when you configure a scan or create a Template scan from the scan menu on the inventory or tasks pages.

Creating a scan template from a scan task

  1. Go to Tasks to open the Tasks overview page.
  2. Find the scan task you want to base the template on and click its name to view the task details.
  3. From the task details, click the Copy dropdown menu and choose Copy for new template.
  4. In the scan configuration form, enter a name for the template. You’ll use this name to find the template and assign it to a new scan.
  5. Configure the scan as you normally would, using these tabs:
    • Standard holds the name, description, and scan rate for the template.
    • Advanced covers excluded hosts, included ports, tags, host rates, group size, UDP probe max attempts, max TTL for all scan probe packets, ToS, screenshots, and subnet sampling.
    • Probes and SNMP enables SNMP and additional probes and takes their credentials. With the SNMP probe enabled, the scan uses the port and credentials you provide to find anything with SNMP enabled.
    • Credentials enables any preconfigured credentials you want the scan to use; see Scanning with credentials. The scan uses a credential when its defined CIDR scope matches the scan target.
  6. Save the template.

To use the template, open the Templates tab when you configure a scan or create a Template scan from the scan menu on the inventory or tasks pages.

Creating a scan template based on a template

  1. Go to Tasks > Task library to open the task library.
  2. From the Task library, find the template you want to base the new one on and click its name to open it.
  3. On the scan template configuration page, click Copy. runZero duplicates it as a new scan template.
  4. In the scan configuration form, enter a name for the template. You’ll use this name to find the template and assign it to a new scan.
  5. Configure the scan as you normally would, using these tabs:
    • Standard holds the name, description, and scan rate for the template.
    • Advanced covers excluded hosts, included ports, tags, host rates, group size, UDP probe max attempts, max TTL for all scan probe packets, ToS, screenshots, and subnet sampling.
    • Probes and SNMP enables SNMP and additional probes and takes their credentials. With the SNMP probe enabled, the scan uses the port and credentials you provide to find anything with SNMP enabled.
    • Credentials enables any preconfigured credentials you want the scan to use; see Scanning with credentials. The scan uses a credential when its defined CIDR scope matches the scan target.
  6. Save the template.

To use the template, open the Templates tab when you configure a scan or create a Template scan from the scan menu on the inventory or tasks pages.

Applying a scan template to a scan

When you configure a scan, the Templates tab lists every template available for it. Pick one instead of configuring the scan by hand.

You can also open the Task library page and choose Create a scan based on this template from the template’s actions.

Editing a scan template

Every update to a scan template affects every scan that uses it. After you change a template, the next scan picks up the new settings automatically, and so does any scan queued to run.

Editing a scan that uses a scan template

To change the settings of a scan that uses a template, edit the template; the change reaches every scan that uses it. Otherwise, delete the scan and create a new scan configuration with your changes.

When you create a scan from a template, you can’t edit the fields the template sets. You can still configure the standard fields, such as the site, scan name, discovery scope, Explorer, and scan schedule, because the template doesn’t define those.

Deleting a scan template

Deleting a template removes it from runZero permanently, along with all of its configuration. To delete one, go to the Task library, find the template, and click Delete. A dialog asks you to confirm, because the deletion can’t be undone.

Updated