Fortinet white logo
Fortinet white logo

Administration Guide

Create or edit a traffic shaper

Create or edit a traffic shaper

Select Create New to open the New Shaping Profile window. To edit a traffic shaper, select the traffic shaper and then click Edit.

Configure the following settings in the New Shaping Profile window or the Edit Shaping Profile window and then click OK:

Name

Enter a name for the new traffic shaper. You cannot change the name after you create the traffic shaper.

Default Class

Select the class that the traffic shaper will use by default. The default class must be equal to the Class ID for one of the classes in the traffic shaper.

Comments

Enter any additional information that might be needed by administrators, as a reminder of the traffic shaperʼs purpose and scope. This setting is optional.

Classes

Classes that can be used in the traffic shaper.

Create New

Select to create a class. See Create or edit a class.

Edit

Select to modify a class.

Delete

Select to remove a class from the list.

Search

Enter a search term to find in the classes list.

Name

Class name.

Class ID

Class identifier.

Priority

The priority is top, critical, high, medium, or low.

Guaranteed Bandwidth

The guaranteed bandwidth ensures that a consistent reserved bandwidth is available for a given service or user. Ensure that you set the bandwidth to a value that is significantly less than the bandwidth capacity of the interface. Otherwise, little to no traffic will pass through the interface and potentially cause unwanted latency.

Enter the percentage, from 0 to 100.

Maximum Bandwidth

The maximum bandwidth instructs the security policy what the largest percentage of traffic allowed.

Enter the percentage, from 1 to 100. The Maximum Bandwidth must be equal or greater than the Guaranteed Bandwidth.

API Preview

The API Preview allows you to view all REST API requests being used by the page. You can make changes on the page that are reflected in the API request preview. This feature is not available if the user is logged in as an administrator that has read-only GUI permissions.

To use the API Preview:
  1. Click API Preview. The API Preview pane opens, and the values for the fields are visible (data). If a new object is being created, the POST request is shown.

  2. Enable Show modified changes only to show the modified changes instead of the full configuration in the preview.

  3. Click Copy to Clipboard to copy the JSON code shown on the preview screen to the clipboard.

  4. Click Close to leave the preview.

To create a traffic shaper and class in the CLI:

config firewall shaping-profile

edit <traffic_shaper_name>

config classes

edit <ID_value>

set class-id <2-31>

set priority <top | critical | high | medium | low}

set guaranteed-bandwidth <0-100 percent>

set maximum-bandwidth <1-100 percent>

next

set default-class <2-31, must be equal to class-id value>

end

next

end

For example:

config firewall shaping-profile

edit TrafficShaper1

config classes

edit 1

set class-id 3

set priority low

set guaranteed-bandwidth 50

set maximum-bandwidth 75

next

set default-class 3

end

next

end

Create or edit a traffic shaper

Create or edit a traffic shaper

Select Create New to open the New Shaping Profile window. To edit a traffic shaper, select the traffic shaper and then click Edit.

Configure the following settings in the New Shaping Profile window or the Edit Shaping Profile window and then click OK:

Name

Enter a name for the new traffic shaper. You cannot change the name after you create the traffic shaper.

Default Class

Select the class that the traffic shaper will use by default. The default class must be equal to the Class ID for one of the classes in the traffic shaper.

Comments

Enter any additional information that might be needed by administrators, as a reminder of the traffic shaperʼs purpose and scope. This setting is optional.

Classes

Classes that can be used in the traffic shaper.

Create New

Select to create a class. See Create or edit a class.

Edit

Select to modify a class.

Delete

Select to remove a class from the list.

Search

Enter a search term to find in the classes list.

Name

Class name.

Class ID

Class identifier.

Priority

The priority is top, critical, high, medium, or low.

Guaranteed Bandwidth

The guaranteed bandwidth ensures that a consistent reserved bandwidth is available for a given service or user. Ensure that you set the bandwidth to a value that is significantly less than the bandwidth capacity of the interface. Otherwise, little to no traffic will pass through the interface and potentially cause unwanted latency.

Enter the percentage, from 0 to 100.

Maximum Bandwidth

The maximum bandwidth instructs the security policy what the largest percentage of traffic allowed.

Enter the percentage, from 1 to 100. The Maximum Bandwidth must be equal or greater than the Guaranteed Bandwidth.

API Preview

The API Preview allows you to view all REST API requests being used by the page. You can make changes on the page that are reflected in the API request preview. This feature is not available if the user is logged in as an administrator that has read-only GUI permissions.

To use the API Preview:
  1. Click API Preview. The API Preview pane opens, and the values for the fields are visible (data). If a new object is being created, the POST request is shown.

  2. Enable Show modified changes only to show the modified changes instead of the full configuration in the preview.

  3. Click Copy to Clipboard to copy the JSON code shown on the preview screen to the clipboard.

  4. Click Close to leave the preview.

To create a traffic shaper and class in the CLI:

config firewall shaping-profile

edit <traffic_shaper_name>

config classes

edit <ID_value>

set class-id <2-31>

set priority <top | critical | high | medium | low}

set guaranteed-bandwidth <0-100 percent>

set maximum-bandwidth <1-100 percent>

next

set default-class <2-31, must be equal to class-id value>

end

next

end

For example:

config firewall shaping-profile

edit TrafficShaper1

config classes

edit 1

set class-id 3

set priority low

set guaranteed-bandwidth 50

set maximum-bandwidth 75

next

set default-class 3

end

next

end