Fortinet black logo

Administration Guide

Specific network port

Copy Link
Copy Doc ID 8bec453a-b242-11e9-a989-00505692583a:209956
Download PDF

Display a specific network port.

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

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

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

Return value

Type

Description

Description

String

Port Description

Device ID

Integer

ID that uniquely identifies the network device.

Hosts Connected

Boolean

True = Host is connected.

ID

Integer

ID that uniquely identifies the port.

MAC address

String

MAC address of the port.

Name

String

Port name

Example XML format:

<networkPortResult>

<status>success</status>

<networkPorts>

<description>Stk Master 1/7</description>

<deviceId>943</deviceId>

<hostsConnected>true</hostsConnected>

<id>944</id>

<macAddress>00:04:96:1F:89:C4</macAddress>

<name>1007</name>

</networkPorts>

</networkPortResult>

Display a specific network port.

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

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

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

Return value

Type

Description

Description

String

Port Description

Device ID

Integer

ID that uniquely identifies the network device.

Hosts Connected

Boolean

True = Host is connected.

ID

Integer

ID that uniquely identifies the port.

MAC address

String

MAC address of the port.

Name

String

Port name

Example XML format:

<networkPortResult>

<status>success</status>

<networkPorts>

<description>Stk Master 1/7</description>

<deviceId>943</deviceId>

<hostsConnected>true</hostsConnected>

<id>944</id>

<macAddress>00:04:96:1F:89:C4</macAddress>

<name>1007</name>

</networkPorts>

</networkPortResult>