---
title: "Managing scan templates"
---

A ((scan template)) is a predefined set of scan options and settings. If you have a scan configuration you use often, you can create a scan template to save those settings. The next time you create a scan, you can choose a template instead of manually configuring your settings. Each update you make to the scan template is automatically applied to new and recurring scans based on the template, as well as any queued scans which were set up using the template but have not started yet. With scan templates, you can save time and reduce the likelihood of misconfiguring a scan.

When you create a scan based on a scan template, you will not be able to edit the fields set by the template. However, you can configure the site, scan name, discovery scope, Explorer, and scan schedule, since these are not defined in the template.

Each time a scan runs using values from a template, the scan task is saved with a copy of the parameters. This means the task will list the values used for the scan, even if the template is modified after the scan completes.

<iframe src="https://demo.arcade.software/TMnnmC8KiIGWfVRrJhRs?embed" loading="lazy" allowfullscreen title="Walkthrough - Creating and Using Scan Templates"></iframe>

## Creating a scan template

Scan templates can be created in a few ways in runZero:

- By going to **Tasks > Task library**
- From an existing scan task
- Based on an existing scan template

### Creating a scan template from scratch

1. Go to **Tasks > Task library** to view the [task library](https://console.runzero.com/tasks/library).
2. From the **Task library**, click **Add template**.
3. When the scan configuration form appears, enter a name for the template.  Use this name to search and assign the template to a new scan.
4. [Configure the scan](discovering-assets.md) as you normally would. The following tabs are available for you to access and configure settings:
   * **Standard** - Provide a name, description, and scan rate for the template.
   * **Advanced** - Configure 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** - Enable SNMP and additional probes, and provide credentials. When you enable the SNMP probe, the scan will identify devices that are using the SNMP protocol, using the port and credentials provided to find anything with SNMP enabled.
   * **Credentials** - Enable any preconfigured [Scanning with credentials](scanning-credentials.md) you want to use for the scan. The scan uses the credentials if the defined CIDR scope matches the specific scan target.
5. Save the template.

To use this template, go to the _Templates_ tab when you [configure a scan](https://console.runzero.com/scan/) or [create a Template scan](https://console.runzero.com/tasks/templatesNewScan) from the scan menu on the [inventory](https://console.runzero.com/inventory) or [tasks](https://console.runzero.com/tasks) pages.

### Creating a scan template from a scan task

1. Go to **Tasks** to open the [Tasks overview page](https://console.runzero.com/tasks/).
2. Find the scan task you want to use as the basis for your scan template and click the name to view the task details.
3. From the task details, click the **Copy** dropdown menu and choose **Copy for new template**.
4. When the scan configuration form appears, enter a name for the template.  Use this name to search and assign the template to a new scan.
5. [Configure the scan](discovering-assets.md) as you normally would. The following tabs are available for you to access and configure settings:
   * **Standard** - Provide a name, description, and scan rate for the template.
   * **Advanced** - Configure 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** - Enable SNMP and additional probes, and provide credentials. When you enable the SNMP probe, the scan will identify devices that are using the SNMP protocol, using the port and credentials provided to find anything with SNMP enabled.
   * **Credentials** - Enable any preconfigured [Scanning with credentials](scanning-credentials.md) you want to use for the scan. The scan uses the credentials if the defined CIDR scope matches the specific scan target.
6. Save the template.

To use this template, go to the _Templates_ tab when you [configure a scan](https://console.runzero.com/scan/) or [create a Template scan](https://console.runzero.com/tasks/templatesNewScan) from the scan menu on the [inventory](https://console.runzero.com/inventory) or [tasks](https://console.runzero.com/tasks) pages.

### Creating a scan template based on a template

1. Go to the **Tasks > Task library** to view the [task library](https://console.runzero.com/tasks/library).
2. From the **Task library**, find the template you want to use as the basis for a new template and click the name to open it.
3. From the scan template configuration page, click **Copy**. runZero will duplicate and create a new scan template.
3. When the scan configuration form appears, enter a name for the template.  Use this name to search and assign the template to a new scan.
4. [Configure the scan](discovering-assets.md) as you normally would. The following tabs are available for you to access and configure settings:
   * **Standard** - Provide a name, description, and scan rate for the template.
   * **Advanced** - Configure 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** - Enable SNMP and additional probes, and provide credentials. When you enable the SNMP probe, the scan will identify devices that are using the SNMP protocol, using the port and credentials provided to find anything with SNMP enabled.
   * **Credentials** - Enable any preconfigured [Scanning with credentials](scanning-credentials.md) you want to use for the scan. The scan uses the credentials if the defined CIDR scope matches the specific scan target.
5. Save the template.

To use this template, go to the _Templates_ tab when you [configure a scan](https://console.runzero.com/scan/) or [create a Template scan](https://console.runzero.com/tasks/templatesNewScan) from the scan menu on the [inventory](https://console.runzero.com/inventory) or [tasks](https://console.runzero.com/tasks) pages.

## Applying a scan template to a scan

Instead of manually configuring a scan, you can choose to use a template instead. You can find all templates available for a scan on the **Templates** tab in your scan configuration.

You can also go to the **Task library** page and choose to **Create a scan based on this template** from the template's actions.

## Editing a scan template

All updates to a scan template affect every scan that uses it. After you make a change to a template, the next scan will automatically update to use the new settings. Any scan queued to run will use the new settings.

### Editing a scan that uses a scan template

Any changes to a template will affect all scans that use them. If a scan uses a template, you will need to edit the template in order modify the scan settings. Otherwise, you will need to delete the scan and create a new scan configuration with your modifications.

When you create a scan based on a scan template, you will not be able to edit the fields set by the template. However, you can configure the standard fields, such as the site, scan name, discovery scope, Explorer, and scan schedule, since these are not defined in the template.

## Deleting a scan template

Deleting a template will remove it permanently from runZero. All configurations will no longer be accessible. To delete a scan template, go to [the Task library](https://console.runzero.com/tasks/library), find the template you want to delete, and click **Delete**. A dialog will prompt you to confirm that you want to delete the template, and the action will be irreversible.