Fortinet Document Library

Version:

Version:

Version:


Table of Contents

Administration Guide

Download PDF
Copy Link

Control tasks

Perform tasks that modify port state or host network access.

URL = https://<servername>:8443/api/control

URL = https://<servername>:8443/api/control/{taskid}

URL = https://<servername>:8443/api/control/host/{hostid}

URL = https://<servername>:8443/api/control/ipaddress/{ip}

URL = https://<servername>:8443/api/control/macaddress/{mac}

URL = https://<servername>:8443/api/control/active

URL = https://<servername>:8443/api/control/active/ipaddress/{ip}

URL = https://<servername>:8443/api/control/active/host/{hostid}

URL = https://<servername>:8443/api/control/inactive

URL = https://<servername>:8443/api/control/inactive/ipaddress/{ip}

URL = https://<servername>:8443/api/control/inactive/host/{hostid}

Return value

Type

Description

action

String

The control action to take

  • Port – Port State
  • Access – Host Denied

createTime

Time

Date and time that this task was created.

duration

Integer

Time in seconds to perform the task. 0 indicates an unlimited duration, and requires manual intervention to undo.

endpointId

Integer

ID that uniquely identifies the host.

id

Integer

ID that uniquely identifies the task.

Inactive Time

Time

Date and time that this task was made inactive.

ipaddress

String

IP address of the host, such as “192.168.1.1”.

status

String

Status of the task:

  • active -Task is accepted.
  • undo - Undo the task.
  • noHost - No host found.
  • invalidAction - Action is not recognized by FortiNAC.
  • systemError - FortiNAC cannot process the task.
  • taskExists - The same task has already been sent.
Example request

curl -k -u '<username>:<password>' -H "accept: application/xml" -X POST -d 'ip=192.168.10.182' -d'action=atrisk' -d'duration=60' https://<servername>:8443/api/control/ipaddress

Example XML format:

<controlTaskResult>

<status>success</status>

<controlTasks>

<id>24</id>

<action>atrisk</action>

<createTime>2017-01-26T11:42:19-05:00</createTime>

<duration>60</duration>

<endpointId>1274</endpointId>

<status>active</status>

</controlTasks>

</controlTaskResult>

Control tasks

Perform tasks that modify port state or host network access.

URL = https://<servername>:8443/api/control

URL = https://<servername>:8443/api/control/{taskid}

URL = https://<servername>:8443/api/control/host/{hostid}

URL = https://<servername>:8443/api/control/ipaddress/{ip}

URL = https://<servername>:8443/api/control/macaddress/{mac}

URL = https://<servername>:8443/api/control/active

URL = https://<servername>:8443/api/control/active/ipaddress/{ip}

URL = https://<servername>:8443/api/control/active/host/{hostid}

URL = https://<servername>:8443/api/control/inactive

URL = https://<servername>:8443/api/control/inactive/ipaddress/{ip}

URL = https://<servername>:8443/api/control/inactive/host/{hostid}

Return value

Type

Description

action

String

The control action to take

  • Port – Port State
  • Access – Host Denied

createTime

Time

Date and time that this task was created.

duration

Integer

Time in seconds to perform the task. 0 indicates an unlimited duration, and requires manual intervention to undo.

endpointId

Integer

ID that uniquely identifies the host.

id

Integer

ID that uniquely identifies the task.

Inactive Time

Time

Date and time that this task was made inactive.

ipaddress

String

IP address of the host, such as “192.168.1.1”.

status

String

Status of the task:

  • active -Task is accepted.
  • undo - Undo the task.
  • noHost - No host found.
  • invalidAction - Action is not recognized by FortiNAC.
  • systemError - FortiNAC cannot process the task.
  • taskExists - The same task has already been sent.
Example request

curl -k -u '<username>:<password>' -H "accept: application/xml" -X POST -d 'ip=192.168.10.182' -d'action=atrisk' -d'duration=60' https://<servername>:8443/api/control/ipaddress

Example XML format:

<controlTaskResult>

<status>success</status>

<controlTasks>

<id>24</id>

<action>atrisk</action>

<createTime>2017-01-26T11:42:19-05:00</createTime>

<duration>60</duration>

<endpointId>1274</endpointId>

<status>active</status>

</controlTasks>

</controlTaskResult>