Fortinet firewall and FortiGate VDOM REST-based discovery
Summarize
Summary of Fortinet firewall and FortiGate VDOM REST-based discovery
The Discovery and Service Mapping Patterns application in ServiceNow enables customers to discover Fortinet firewalls and FortiGate Virtual Domains (VDOMs) using REST API calls. This REST-based discovery method supports multi-VDOM mode and is the only method to discover FortiGate VDOMs, as SNMP-based discovery does not support them. Customers must ensure they have the latest Discovery and Service Mapping Patterns application and configure API access properly to leverage this functionality.
Show less
Prerequisites and Configuration
- Application updates: Ensure Discovery and Service Mapping Patterns are updated to the latest version from the ServiceNow Store.
- API Token: Create an API token in Fortinet with sufficient permissions to access required Fortinet APIs (such as system status, firewall policies, interfaces, and VDOM properties).
- MID Server access: Verify that the MID Server can access the Fortinet APIs.
- Disable SNMP-based discovery: To avoid conflicts, disable SNMP-based Fortinet firewall discovery when using REST-based discovery.
- Credential alias and schedule: Create an alias for the API key credentials and set up a serverless discovery schedule for the REST-based discovery process.
Key Features
- REST API-based discovery: Uses Next Generation Fortinet Network Firewall - REST pattern to discover devices and VDOMs.
- VDOM Discovery extension: Specifically discovers FortiGate Virtual Domains in multi-VDOM mode.
- Comprehensive data collection: Discovers firewall devices, clusters, network adapters, IP addresses, VDOMs, firewall interfaces, network topologies, and firewall policies.
- Detailed CMDB population: Populates multiple CMDB tables with essential fields such as hostname, serial number, IP address, firmware version, and policy details.
- Relationship mapping: Automatically creates relationships between CIs to represent clusters, interfaces, VDOMs, policies, and network topology.
Data and CMDB Impact
The discovery populates the CMDB with detailed configuration items (CIs) relevant to Fortinet firewalls and FortiGate VDOMs:
- Firewall devices and clusters: Includes hostname, serial number, model, firmware, and operational status.
- Network adapters and IP addresses: Captures IPs, MAC addresses, netmasks, and user-assigned aliases.
- Virtual Domains (VDOMs): Discovers VDOM indexes, names, descriptions, and their relationships to interfaces and policies.
- Firewall interfaces and policies: Identifies interfaces with IPs, MAC addresses, access types, and firewall policies with source/destination details and managed services.
- Network topology: Maps VLAN IDs and associates them with firewall interfaces.
Benefits for ServiceNow Customers
- Enables accurate and automated discovery of Fortinet firewall infrastructure and virtual domains, improving visibility in the CMDB.
- Supports effective configuration management and security policy tracking by maintaining up-to-date firewall and VDOM data.
- Helps maintain compliance and operational readiness by ensuring detailed relationships and configurations are captured and maintained.
- Facilitates integration with other ITOM processes such as event management, change management, and service mapping through comprehensive CI data.
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 may 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.
Request apps on the Store
Visit the ServiceNow Store website 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.
To learn about Fortinet Firewalls and their versions that you can discover, refer to Detailed information on products discovered by ITOM Visibility.
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 on creating an API Token, go to the Fortinet Document Library and 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.
- Disable SNMP-based Fortinet firewall discovery
- For more information, see Disable SNMP-based Fortinet firewall discovery.
- 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.
- Create a serverless discovery schedule
- For more information, see Create a serverless schedule for Fortinet firewall REST-based discovery.
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. |
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. |
| 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. |
| Field | Description |
|---|---|
| Name [name] |
Virtual LAN (VLAN) ID associated with the interface, if applicable. The format is: VLAN-{Vlan ID}. For example: VLAN-310. |
| 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
Discovery creates these relationships to support the Fortinet firewall discovery.
| 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] |
| Network Adapter [cmdb_ci_network_adapter] | References | Fortinet Firewall Device [cmdb_ci_firewall_device_fortinet] |
| Router Interface [dscy_router_interface] | References | Fortinet Firewall Device [cmdb_ci_firewall_device_fortinet] |
| Serial Number [cmdb_serial_number] | References | Fortinet Firewall Device [cmdb_ci_firewall_device_fortinet] |
Discovery creates these relationships to support the FortiGate VDOM discovery.
| CI | Relationship | CI |
|---|---|---|
| Fortinet Firewall Interface [cmdb_ci_fortinet_firewall_interface] | Extends from | Network Interface [cmdb_ci_ni_interface] |
| Fortinet Firewall Policy [cmdb_ci_fortinet_firewall_policy] | Extends from | Firewall Security Policy [cmdb_ci_firewall_sec_policy] |
| 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] | Extends from | IP Firewall [cmdb_ci_ip_firewall] |
| Fortinet Virtual Domain [cmdb_ci_fortinet_vdom] | Hosted on::Hosts | Fortinet Firewall Device [cmdb_ci_firewall_device_fortinet] |
| Network Topology [cmdb_ci_network_topology] | Members::Member of | Fortinet Firewall Interface [cmdb_ci_fortinet_firewall_interface] |