---
title: Fortinet firewall and FortiGate VDOM REST-based discovery
description: The Discovery and Service Mapping Patterns application uses the Next Generation Fortinet Network Firewall - REST pattern to find Fortinet firewalls through REST API calls. Additionally, the pattern extension VDOM Discovery finds FortiGate Virtual Domains \(VDOMs\). Discovering some of these resources might require updating to the latest version of the Discovery and Service Mapping Patterns application from the ServiceNow Store.
locale: en-US
canonical_url: https://www.servicenow.com/docs/r/australia/it-operations-management/discovery-and-service-mapping-patterns/fortinet-fw-vdoms-rest-discovery.html
release: australia
product: Discovery and Service Mapping Patterns
classification: discovery-and-service-mapping-patterns
topic_type: reference
last_updated: "2026-03-12"
reading_time_minutes: 6
breadcrumb: [Available on-premise discovery patterns, Discovery patterns used by ITOM Visibility, ITOM Visibility, IT Operations Management]
---

# Fortinet firewall and FortiGate VDOM REST-based discovery

The Discovery and Service Mapping Patterns application uses the Next Generation Fortinet Network Firewall - REST pattern to find Fortinet firewalls through REST API calls. Additionally, the pattern extension VDOM Discovery finds FortiGate Virtual Domains \(VDOMs\). Discovering some of these resources might require updating to the latest version of the Discovery and Service Mapping Patterns application from the ServiceNow Store.

The Next Generation Fortinet Network Firewall - REST pattern uses a set of REST API calls to find the Fortinet firewalls. For FortiGate VDOM discovery, only multi-VDOM mode is supported.

**Note:** Only the REST-based Fortinet firewall discovery method finds FortiGate VDOMs. The SNMP-based Fortinet firewall discovery method doesn't discover them. For information about the default SNMP-based Fortinet firewall discovery, see [Next-Generation Fortinet Network Firewall SNMP-based discovery](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/it-operations-management/discovery-and-service-mapping-patterns/fortinet-fw-discovery.md).

## Request apps on the Store

Visit the [ServiceNow Store](https://store.servicenow.com/sn_appstore_store.do#!/store/home) to view all the available apps, and for information about submitting requests to the store. For cumulative release notes information for all released apps, see the [ServiceNow Store version history release notes](https://www.servicenow.com/docs/r/store-release-notes/sn-store-release-notes.html).

To learn about Fortinet Firewalls and their versions that you can discover, refer to [Detailed information on products discovered by ITOM Visibility](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/it-operations-management/itom-visibility/r_SupportedApplications.md).

## Fortinet firewall and FortiGate VDOM data model

The Next Generation Fortinet Network Firewall - REST pattern and VDOM Discovery extension introduce the following CI classes that extend existing CMDB classes.

|CI class|Extends from|
|--------|------------|
|Fortinet Firewall Cluster \[cmdb\_ci\_firewall\_cluster\_fortinet\]|Firewall Cluster \[cmdb\_ci\_firewall\_cluster\]|
|Fortinet Firewall Device \[cmdb\_ci\_firewall\_device\_fortinet\]|Firewall Device \[cmdb\_ci\_firewall\_device\]|
|Fortinet Firewall Interface \[cmdb\_ci\_fortinet\_firewall\_interface\]|Network Interface \[cmdb\_ci\_ni\_interface\]|
|Fortinet Firewall Policy \[cmdb\_ci\_fortinet\_firewall\_policy\]|Firewall Security Policy \[cmdb\_ci\_firewall\_sec\_policy\]|
|Fortinet Virtual Domain \[cmdb\_ci\_fortinet\_vdom\]|IP Firewall \[cmdb\_ci\_ip\_firewall\]|

## Prerequisites

-   **Verify that the applications are up to date**
    -   Discovery and Service Mapping Patterns
    -   CMDB CI Class Models
-   **Create API Token**

    Create an API Token in Fortinet. For instructions, go to the [Fortinet Document Library](https://docs.fortinet.com/). Search for the "Connect FortiGate device via API Token - Online Help" article under the FortiConverter Tool product family.

-   **Verify API access and permissions**

    -   Verify that the MID Server can access the Fortinet APIs.
    -   Verify that the API Token has sufficient permissions to retrieve the required information from the Fortinet devices.
    Required Fortinet APIs:

    -   `v2/cmdb/system/global`
    -   `api/v2/monitor/system/status`
    -   `api/v2/cmdb/system/ha`
    -   `api/v2/cmdb/router/static`
    -   `/api/v2/cmdb/firewall/policy`
    -   `api/v2/cmdb/system/vdom-property`
    -   `api/v2/cmdb/system/interface`
    -   `/api/v2/monitor/system/interface/select`
-   **Disable SNMP-based Fortinet firewall discovery**

    For more information, see [Disable SNMP-based Fortinet firewall discovery](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/it-operations-management/discovery-and-service-mapping-patterns/disable-snmp-fortinet-fw-discovery.md).

-   **Create an alias for the API Key Credentials**

    For more information, see [Create an alias for the API key credential for Fortinet firewall REST-based discovery](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/it-operations-management/discovery-and-service-mapping-patterns/create-alias-api-key-cred-fortinet.md).

-   **Create a serverless discovery schedule**

    For more information, see [Create a serverless schedule for Fortinet firewall REST-based discovery](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/it-operations-management/discovery-and-service-mapping-patterns/create-serverless-schedule-fortinet.md).


## Data collected by Discovery during horizontal discovery

Discovery populates the data in the CMDB when running the Next Generation Fortinet Network Firewall - REST pattern.

|Field|Description|
|-----|-----------|
|Name \[name\]|**Hostname** field of the Fortinet device.|
|Serial number \[serial\_number\]|Serial number of the Fortinet device.|
|Fully qualified domain name \[fqdn\]|Fully qualified domain name of the Fortinet device.|
|Operational status \[operational\_status\]|Indicates whether the Fortinet device is in active state.|
|IP Address \[ip\_address\]|IP address of the Fortinet device.|
|Manufacturer \[manufacturer\]|Fortinet device manufacturer.|
|Description \[short\_description\]|Short description of the Fortinet device.|
|Model Number \[model\_number\]|Fortinet device model number.|
|Firmware version \[firmware\_version\]|Fortinet device firmware version.|
|Hardware OS \[hardware\_os\]|OS running on the hardware.|
|Hardware OS Version \[hardware\_os\_version\]|OS version running on the hardware.|

|Field|Description|
|-----|-----------|
|Name \[name\]|**Hostname** field of the Fortinet firewall cluster.|
|Fully qualified domain name \[fqdn\]|Fully qualified domain name of the firewall cluster.|
|IP address \[ip\_address\]|IP address of the firewall cluster.|
|Manufacturer \[manufacturer\]|Device manufacturer.|
|Description \[short\_description\]|Short description of the firewall cluster.|
|Model Number \[model\_number\]|Device model number.|
|Hardware OS \[hardware\_os\]|OS running on the hardware.|
|Hardware OS Version \[hardware\_os\_version\]|OS version running on the hardware.|

|Field|Description|
|-----|-----------|
|IP Address \[ip\_address\]|IP address of the network adapter.|
|Netmask \[netmask\]|Netmask of the network adapter.|
|Alias \[alias\]|User-assigned name for the network adapter.|
|MAC Address \[mac\_address\]|MAC address of the network adapter.|
|Name \[name\]|Name of the network adapter.|
|Configuration Item \[cmdb\_ci\]|References the Fortinet Firewall Device \[cmdb\_ci\_firewall\_device\_fortinet\] table.|

|Field|Description|
|-----|-----------|
|IP Address \[ip\_address\]|IP address of the Fortinet firewall.|
|Netmask \[netmask\]|Netmask of the Fortinet firewall.|
|Nic \[nic\]|References the Network Adapter \[cmdb\_ci\_network\_adapter\] table.|

Discovery populates the data in the CMDB when running the Next Generation Fortinet Network Firewall - REST pattern extension VDOM Discovery.

|Field|Description|
|-----|-----------|
|Vdom Index \[vdom\_index\]|Index of the VDOM in the list.|
|Name \[name\]|Name of the VDOM.|
|Description \[short\_description\]|Description of the VDOM property that provides additional context or information about the purpose of the property.|
|IP Address \[ip\_address\]|IP address of the Fortinet device associated with this VDOM.|

|Field|Description|
|-----|-----------|
|ID \[id\]|Unique identifier for the interface. For example: port1.|
|Name \[name\]|Name of the interface. For example: LAN.|
|IP Address \[ip\_address\]|IP address assigned to the interface.|
|Description \[short\_description\]|Description of the interface, often used for documentation or identification purposes. For example: Main LAN interface.|
|MAC Address \[mac\_address\]|MAC address of the interface.|
|Access Type \[access\_type\]|Type of interface. For example: physical, VLAN, or aggregate.|

<table id="table_u1l_b4r_5cc"><thead><tr><th>

Field

</th><th>

Description

</th></tr></thead><tbody><tr><td>

Name \[name\]

</td><td>

Virtual LAN \(VLAN\) ID associated with the interface, if applicable.

 The format is: `VLAN-{Vlan ID}`. For example: VLAN-310.

</td></tr></tbody>
</table>|Field|Description|
|-----|-----------|
|Policy ID \[policy\_id\]|Unique ID assigned to the policy in VDOM or device level.|
|UUID \[uuid\]|Global unique identifier \(GUID\) for the firewall policy.|
|Name \[name\]|Name of the policy.|
|Source interface \[source\_interface\]|Network interface from which the traffic originates.|
|Destination interface \[destination\_interface\]|Network interface to which the traffic is directed.|
|Source address \[source\_address\]|Source address or address group from which traffic originates.|
|Destination address \[destination\_address\]|Destination address or address group to which traffic is directed.|
|Internet Service \[internet\_service\]|Service or application being managed by the policy, often represented by a service group or name.|

## CI relationships

The Next Generation Fortinet Network Firewall - REST pattern creates the following relationships and references to support Fortinet firewall discovery. References link to records in other tables and don't appear in the CI Relationship \[cmdb\_rel\_ci\] table.

|CI|Relationship|CI|
|---|------------|---|
|Fortinet Firewall Cluster \[cmdb\_ci\_firewall\_cluster\_fortinet\]|Hosted on::Hosts|Fortinet Firewall Device \[cmdb\_ci\_firewall\_device\_fortinet\]|
|Fortinet Firewall Device \[cmdb\_ci\_firewall\_device\_fortinet\]|Owns::Owned by|IP Address \[cmdb\_ci\_ip\_address\]|
|Fortinet Firewall Device \[cmdb\_ci\_firewall\_device\_fortinet\]|Owns::Owned by|Network Adapter \[cmdb\_ci\_network\_adapter\]|
|Fortinet Firewall Device \[cmdb\_ci\_firewall\_device\_fortinet\]|Uses::Used by|Router Interface \[dscy\_router\_interface\]|
|Network Adapter \[cmdb\_ci\_network\_adapter\]|Owns::Owned by|IP Address \[cmdb\_ci\_ip\_address\]|

|CI|Field|Referenced CI|
|---|-----|-------------|
|Serial Number \[cmdb\_serial\_number\]|Configuration item \[configuration\_item\]|Fortinet Firewall Device \[cmdb\_ci\_firewall\_device\_fortinet\]|
|Network Adapter \[cmdb\_ci\_network\_adapter\]|Configuration Item \[cmdb\_ci\]|Fortinet Firewall Device \[cmdb\_ci\_firewall\_device\_fortinet\]|
|Router Interface \[dscy\_router\_interface\]|Configuration Item \[cmdb\_ci\]|Fortinet Firewall Device \[cmdb\_ci\_firewall\_device\_fortinet\]|
|IP Address \[cmdb\_ci\_ip\_address\]|Nic \[nic\]|Network Adapter \[cmdb\_ci\_network\_adapter\]|

The VDOM Discovery extension creates the following relationships to support FortiGate VDOM discovery.

|CI|Relationship|CI|
|---|------------|---|
|Fortinet Virtual Domain \[cmdb\_ci\_fortinet\_vdom\]|Contains::Contained by|Fortinet Firewall Interface \[cmdb\_ci\_fortinet\_firewall\_interface\]|
|Fortinet Virtual Domain \[cmdb\_ci\_fortinet\_vdom\]|Contains::Contained by|Fortinet Firewall Policy \[cmdb\_ci\_fortinet\_firewall\_policy\]|
|Fortinet Virtual Domain \[cmdb\_ci\_fortinet\_vdom\]|Hosted on::Hosts|Fortinet Firewall Device \[cmdb\_ci\_firewall\_device\_fortinet\]|
|Fortinet Firewall Interface \[cmdb\_ci\_fortinet\_firewall\_interface\]|Members::Member of|Network Topology \[cmdb\_ci\_network\_topology\]|