Fortinet Document Library

Version:

Version:

Version:


Table of Contents

Administration Guide

Download PDF
Copy Link

Specific network device

Display a specific network device.

URL = https://<servername>:8443/api/host/{dbid}/device

URL = https://<servername>:8443/api/network/device/{dbid}

URL = https://<servername>:8443/api/network/domain/{dbid}/devices

Return value

Type

Description

Description

String

System description of the device.

Direction

 

 

Hardware Type

String

Type of network device:

Switch

Wswitch

Printer

server

ID

Integer

ID that uniquely identifies the network device.

IP address

String

IP address of the network device, such as "192.168.1.1".

Name

String

System name of the device

Orderby

 

 

SysOID

String

OID of the device, such as 1.3.6.1.4.1.14823.1.1.32.

Example XML format:

<networkDeviceResult>

<status>success</status>

<networkDevices>

<description>Summit300-24 - Version 7.6e.1 (Build 4) by Release_Master 03/13/06 11:53:13</description>

<hardwareType>switch</hardwareType>

<id>943</id>

<ipAddress>192.168.5.100</ipAddress>

<name>Stk Master</name>

<sysOid>1.3.6.1.4.1.1916.2.67</sysOid>

</networkDevices>

</networkDeviceResult>

Specific network device

Display a specific network device.

URL = https://<servername>:8443/api/host/{dbid}/device

URL = https://<servername>:8443/api/network/device/{dbid}

URL = https://<servername>:8443/api/network/domain/{dbid}/devices

Return value

Type

Description

Description

String

System description of the device.

Direction

 

 

Hardware Type

String

Type of network device:

Switch

Wswitch

Printer

server

ID

Integer

ID that uniquely identifies the network device.

IP address

String

IP address of the network device, such as "192.168.1.1".

Name

String

System name of the device

Orderby

 

 

SysOID

String

OID of the device, such as 1.3.6.1.4.1.14823.1.1.32.

Example XML format:

<networkDeviceResult>

<status>success</status>

<networkDevices>

<description>Summit300-24 - Version 7.6e.1 (Build 4) by Release_Master 03/13/06 11:53:13</description>

<hardwareType>switch</hardwareType>

<id>943</id>

<ipAddress>192.168.5.100</ipAddress>

<name>Stk Master</name>

<sysOid>1.3.6.1.4.1.1916.2.67</sysOid>

</networkDevices>

</networkDeviceResult>