Fortinet Document Library

Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:


Table of Contents

Get CMDB Device Info

This API enables you to get CMDB information in Enterprise and Service Provider deployments. The APIs for Service Provider deployments differ from the Enterprise deployments in that you must specify an organization for the input URL and credentials.

Get Short Description of All Devices

Methodology REST API based: Caller makes an HTTP(S) request with an input XML. An output XML is returned.
Input URL
  • Enterprise deployments:
    https://<<FortiSIEM_Supervisor_IP>/phoenix/rest/cmdbDeviceInfo/devices
  • Service Provider deployments:
    https://<FortiSIEM_Supervisor_ IP>/phoenix/rest/cmdbDeviceInfo/devices&organization=ACME
Input Credentials
  • Enterprise deployments: User name and password of any FortiSIEM account. Make sure that the account has the appropriate access.
  • Service Provider deployments: User name and password of any FortiSIEM account for the ACME organization. Make sure that the account has the appropriate access.
Output An XML that contains a short set of attributes for each device, including:
    • Host Name
    • Access IP
    • Creation Method
    • Description
    • Vendor, Model, version
    • Contact info
    • Location
    • Uptime
    • Hardware Model
    • Serial Number
    • Business Service Groups to which the device belongs

Get Short Description of All Devices in an Address Range

Methodology REST API based: Caller makes an HTTP(S) request with an input XML. An output XML is returned.
Input URL
  • Enterprise deployments:
    https://<FortiSIEM_Supervisor_IP>/phoenix/rest/ cmdbDeviceInfo/devices?includeIps= <includeIpSet>&excludeIps=<excludeIpSet>
  • Service Provider deployments:
    https://<FortiSIEM_Supervisor_IP>/phoenix/rest/cmdbDeviceInfo/ devices?includeIps=<includeIpSet>&excludeIps= <excludeIpSet>&organization=ACME
Input Credentials
  • Enterprise deployments: User name and password of any FortiSIEM account. Make sure that the account has the appropriate access.
  • Service Provider deployments: User name and password of any FortiSIEM account for the ACME organization. Make sure that the account has the appropriate access.
Output An XML that contains short description of devices with access IPs in the specified address range.

Formatting for the <IncludeIPset> and <ExcludeIPset> Attributes

Both <includeIpSet> and <excludeIpSet> can take any of these forms:

  • IPaddress
  • IPaddress1,IPaddress2
  • IPaddress1-IPaddress2
  • IPaddress1,IPaddress2-IPaddress3,IPaddress4,IPaddress5-IPaddress6
Examples
  • If you want all devices in the range 192.168.20.1-192.168.20.100, then issue the API:
    https://<FortiSIEM_Supervisor_IP>/phoenix/rest/cmdbDeviceInfo/devices?includeIps=192.168.20.1-192.168.20.100
  • If you want all devices in the range 192.168.20.1-192.168.20.100, but want to exclude 192.168.20.20, 192.168.20.25, then issue the API:
    https://<FortiSIEM_Supervisor_IP>/phoenix/rest/cmdbDeviceInfo/devices?includeIps=192.168.20.1-192.168.20.100&excludeIps=192.168.20.20,192.168.20.25
  • If you want all devices in the range 192.168.20.1-192.168.20.100, but want to exclude 192.168.20.20-192.168.20.25, then issue the API:
    https://<FortiSIEM_Supervisor_IP>/phoenix/rest/cmdbDeviceInfo/devices?includeIps=192.168.20.1-192.168.20.100&excludeIps=192.168.20.20-192.168.20.25

Get Full information about One Device

Methodology REST API based: Caller makes an HTTP(S) request with an input XML (optional). An output XML is returned. 
Input URL
  • Enterprise deployments:
    https://<FortiSIEM_Supervisor_IP>/phoenix/rest/cmdbDeviceInfo/device?ip= <deviceIp>&loadDepend=true
  • Service Provider deployments:
    https://<FortiSIEM_Supervisor_IP>/phoenix/rest/cmdbDeviceInfo/ device?ip=<deviceIp>&loadDepend=true&organization=ACME
Input Credentials
  • Enterprise deployments:  User name and password of any FortiSIEM account. Make sure that the account has the appropriate access.
  • Service Provider deployments: User name and password of any FortiSIEM account for the ACME organization. Make sure that the account has the appropriate access.
Output An XML that contains full information FortiSIEM has discovered about a device.

Get a Section of Information (Applications, Interfaces, Processors, Storage) about One Device

Methodology REST API based: Caller makes an HTTP(S) request with an input XML (optional). An output XML is returned. 
Input URL
  • Enterprise deployments:
    https://<FortiSIEM_Supervisor_IP>/phoenix/rest/cmdbDeviceInfo/device?ip= <deviceIp>&loadDepend=true&fields=<sectionName>
  • Service Provider deployments:
    https://<FortiSIEM_Supervisor_IP>/phoenix/rest/cmdbDeviceInfo/ device?ip=<deviceIp>&loadDepend=true&fields= <sectionName>&organization=ACME
Input Credentials
  • Enterprise deployments:  User name and password of any FortiSIEM account. Make sure that the account has the appropriate access.
  • Service Provider deployments: User name and password of any FortiSIEM account for the ACME organization. Make sure that the account has the appropriate access.
Output An XML that contains the specified section discovered for the device.

Options for <sectionName>: applications, interfaces, processors or storages

Refer to Example Usage to get CMDB device info.

Get CMDB Device Info

This API enables you to get CMDB information in Enterprise and Service Provider deployments. The APIs for Service Provider deployments differ from the Enterprise deployments in that you must specify an organization for the input URL and credentials.

Get Short Description of All Devices

Methodology REST API based: Caller makes an HTTP(S) request with an input XML. An output XML is returned.
Input URL
  • Enterprise deployments:
    https://<<FortiSIEM_Supervisor_IP>/phoenix/rest/cmdbDeviceInfo/devices
  • Service Provider deployments:
    https://<FortiSIEM_Supervisor_ IP>/phoenix/rest/cmdbDeviceInfo/devices&organization=ACME
Input Credentials
  • Enterprise deployments: User name and password of any FortiSIEM account. Make sure that the account has the appropriate access.
  • Service Provider deployments: User name and password of any FortiSIEM account for the ACME organization. Make sure that the account has the appropriate access.
Output An XML that contains a short set of attributes for each device, including:
    • Host Name
    • Access IP
    • Creation Method
    • Description
    • Vendor, Model, version
    • Contact info
    • Location
    • Uptime
    • Hardware Model
    • Serial Number
    • Business Service Groups to which the device belongs

Get Short Description of All Devices in an Address Range

Methodology REST API based: Caller makes an HTTP(S) request with an input XML. An output XML is returned.
Input URL
  • Enterprise deployments:
    https://<FortiSIEM_Supervisor_IP>/phoenix/rest/ cmdbDeviceInfo/devices?includeIps= <includeIpSet>&excludeIps=<excludeIpSet>
  • Service Provider deployments:
    https://<FortiSIEM_Supervisor_IP>/phoenix/rest/cmdbDeviceInfo/ devices?includeIps=<includeIpSet>&excludeIps= <excludeIpSet>&organization=ACME
Input Credentials
  • Enterprise deployments: User name and password of any FortiSIEM account. Make sure that the account has the appropriate access.
  • Service Provider deployments: User name and password of any FortiSIEM account for the ACME organization. Make sure that the account has the appropriate access.
Output An XML that contains short description of devices with access IPs in the specified address range.

Formatting for the <IncludeIPset> and <ExcludeIPset> Attributes

Both <includeIpSet> and <excludeIpSet> can take any of these forms:

  • IPaddress
  • IPaddress1,IPaddress2
  • IPaddress1-IPaddress2
  • IPaddress1,IPaddress2-IPaddress3,IPaddress4,IPaddress5-IPaddress6
Examples
  • If you want all devices in the range 192.168.20.1-192.168.20.100, then issue the API:
    https://<FortiSIEM_Supervisor_IP>/phoenix/rest/cmdbDeviceInfo/devices?includeIps=192.168.20.1-192.168.20.100
  • If you want all devices in the range 192.168.20.1-192.168.20.100, but want to exclude 192.168.20.20, 192.168.20.25, then issue the API:
    https://<FortiSIEM_Supervisor_IP>/phoenix/rest/cmdbDeviceInfo/devices?includeIps=192.168.20.1-192.168.20.100&excludeIps=192.168.20.20,192.168.20.25
  • If you want all devices in the range 192.168.20.1-192.168.20.100, but want to exclude 192.168.20.20-192.168.20.25, then issue the API:
    https://<FortiSIEM_Supervisor_IP>/phoenix/rest/cmdbDeviceInfo/devices?includeIps=192.168.20.1-192.168.20.100&excludeIps=192.168.20.20-192.168.20.25

Get Full information about One Device

Methodology REST API based: Caller makes an HTTP(S) request with an input XML (optional). An output XML is returned. 
Input URL
  • Enterprise deployments:
    https://<FortiSIEM_Supervisor_IP>/phoenix/rest/cmdbDeviceInfo/device?ip= <deviceIp>&loadDepend=true
  • Service Provider deployments:
    https://<FortiSIEM_Supervisor_IP>/phoenix/rest/cmdbDeviceInfo/ device?ip=<deviceIp>&loadDepend=true&organization=ACME
Input Credentials
  • Enterprise deployments:  User name and password of any FortiSIEM account. Make sure that the account has the appropriate access.
  • Service Provider deployments: User name and password of any FortiSIEM account for the ACME organization. Make sure that the account has the appropriate access.
Output An XML that contains full information FortiSIEM has discovered about a device.

Get a Section of Information (Applications, Interfaces, Processors, Storage) about One Device

Methodology REST API based: Caller makes an HTTP(S) request with an input XML (optional). An output XML is returned. 
Input URL
  • Enterprise deployments:
    https://<FortiSIEM_Supervisor_IP>/phoenix/rest/cmdbDeviceInfo/device?ip= <deviceIp>&loadDepend=true&fields=<sectionName>
  • Service Provider deployments:
    https://<FortiSIEM_Supervisor_IP>/phoenix/rest/cmdbDeviceInfo/ device?ip=<deviceIp>&loadDepend=true&fields= <sectionName>&organization=ACME
Input Credentials
  • Enterprise deployments:  User name and password of any FortiSIEM account. Make sure that the account has the appropriate access.
  • Service Provider deployments: User name and password of any FortiSIEM account for the ACME organization. Make sure that the account has the appropriate access.
Output An XML that contains the specified section discovered for the device.

Options for <sectionName>: applications, interfaces, processors or storages

Refer to Example Usage to get CMDB device info.