Fortinet Document Library

Version:

Version:

Version:


Table of Contents

Administration Guide

Download PDF
Copy Link

Control task items

Change VLANs, turn a port on or off, control port security, send a CLI command on a device.

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

Return value

Type

Description

Action

String

The control action to take

  • VLAN– VLAN Change
  • Port State – ON / OFF
  • Port Security
  • CLI

Create Time

Time

Date and time that this task was created.

Element Name

String

Element description

Element Type

String

Type of connection:

  • Wired
  • Wireless

ID

Integer

ID that uniquely identifies the network element.

DBID

Integer

ID that uniquely identifies the task.

Inactive Time

Time

Date and time that this action was undone.

IP address

String

IP address of the network element, such as “192.168.1.1”.

Status

String

Status of the task:

  • NotBlocking
  • BlockingByVLAN
  • BlockingByMacFiltering
  • BlockingByPortCLI
  • BlockingByIPCLI
  • BlockingByWireless
  • unDo
Example XML format:

<controlTaskItemResult>

<status>success</status>

<controlTaskItems>

<action>BlockByVLAN</action>

<createTime>2013-07-02T10:49:21-04:00</createTime>

<elementName>Concord-3750 Fa4/0/34</elementName>

<elementType>Wired</elementType>

<id>5</id>

<inactiveTime>2013-07-02T11:11:19-04:00</inactiveTime>

<ipAddress>192.168.10.1</ipAddress>

<networkPortId>535</networkPortId>

<status>unDo</status>

</controlTaskItems>

</controlTaskItemResult>

Control task items

Change VLANs, turn a port on or off, control port security, send a CLI command on a device.

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

Return value

Type

Description

Action

String

The control action to take

  • VLAN– VLAN Change
  • Port State – ON / OFF
  • Port Security
  • CLI

Create Time

Time

Date and time that this task was created.

Element Name

String

Element description

Element Type

String

Type of connection:

  • Wired
  • Wireless

ID

Integer

ID that uniquely identifies the network element.

DBID

Integer

ID that uniquely identifies the task.

Inactive Time

Time

Date and time that this action was undone.

IP address

String

IP address of the network element, such as “192.168.1.1”.

Status

String

Status of the task:

  • NotBlocking
  • BlockingByVLAN
  • BlockingByMacFiltering
  • BlockingByPortCLI
  • BlockingByIPCLI
  • BlockingByWireless
  • unDo
Example XML format:

<controlTaskItemResult>

<status>success</status>

<controlTaskItems>

<action>BlockByVLAN</action>

<createTime>2013-07-02T10:49:21-04:00</createTime>

<elementName>Concord-3750 Fa4/0/34</elementName>

<elementType>Wired</elementType>

<id>5</id>

<inactiveTime>2013-07-02T11:11:19-04:00</inactiveTime>

<ipAddress>192.168.10.1</ipAddress>

<networkPortId>535</networkPortId>

<status>unDo</status>

</controlTaskItems>

</controlTaskItemResult>