Version:

Version:

Version:

Version:

Version:

Version:

Version:

Version:


Table of Contents

Get Short Description of All Devices in an Address Range

Release Added

5.1

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 Short Description of All Devices in an Address Range

Release Added

5.1

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