Fortinet white logo
Fortinet white logo

CLI Reference

config firewall shaper traffic-shaper

config firewall shaper traffic-shaper

Configure shared traffic shaper.

config firewall shaper traffic-shaper
    Description: Configure shared traffic shaper.
    edit <name>
        set bandwidth-unit [kbps|mbps|...]
        set cos {user}
        set cos-marking [enable|disable]
        set cos-marking-method [multi-stage|static]
        set diffserv [enable|disable]
        set diffservcode {user}
        set dscp-marking-method [multi-stage|static]
        set exceed-bandwidth {integer}
        set exceed-class-id {integer}
        set exceed-cos {user}
        set exceed-dscp {user}
        set fabric-force-sync [enable|disable]
        set fabric-object [enable|disable]
        set fabric-object-source [member|local|...]
        set guaranteed-bandwidth {integer}
        set maximum-bandwidth {integer}
        set maximum-cos {user}
        set maximum-dscp {user}
        set overhead {integer}
        set per-policy [disable|enable]
        set priority [low|medium|...]
        set uuid {uuid}
    next
end

config firewall shaper traffic-shaper

Parameter

Description

Type

Size

Default

bandwidth-unit

Unit of measurement for guaranteed and maximum bandwidth for this shaper (Kbps, Mbps or Gbps).

option

-

kbps

Option

Description

kbps

Kilobits per second.

mbps

Megabits per second.

gbps

Gigabits per second.

cos

VLAN CoS mark.

user

Not Specified

cos-marking

Enable/disable VLAN CoS marking.

option

-

disable

Option

Description

enable

Enable VLAN CoS marking.

disable

Disable VLAN CoS marking.

cos-marking-method

Select VLAN CoS marking method.

option

-

static

Option

Description

multi-stage

Multi stage marking.

static

Static marking.

diffserv

Enable/disable changing the DiffServ setting applied to traffic accepted by this shaper.

option

-

disable

Option

Description

enable

Enable setting traffic DiffServ.

disable

Disable setting traffic DiffServ.

diffservcode

DiffServ setting to be applied to traffic accepted by this shaper.

user

Not Specified

dscp-marking-method

Select DSCP marking method.

option

-

static

Option

Description

multi-stage

Multistage marking.

static

Static marking.

exceed-bandwidth

Exceed bandwidth used for DSCP/VLAN CoS multi-stage marking. Units depend on the bandwidth-unit setting.

integer

Minimum value: 0 Maximum value: 80000000 **

0

exceed-class-id

Class ID for traffic in guaranteed-bandwidth and maximum-bandwidth.

integer

Minimum value: 0 Maximum value: 4294967295

0

exceed-cos

VLAN CoS mark for traffic in [guaranteed-bandwidth, exceed-bandwidth].

user

Not Specified

exceed-dscp

DSCP mark for traffic in guaranteed-bandwidth and exceed-bandwidth.

user

Not Specified

fabric-force-sync *

Enable/disable forced synchronization of configuration objects from the root FortiGate unit to the downstream devices. Configuration conflict check is skipped.

option

-

disable

Option

Description

enable

Enable forced synchronization of configuration objects from the root FortiGate unit to the downstream devices.

disable

Disable forced synchronization of configuration objects from the root FortiGate unit to the downstream devices.

fabric-object *

Security Fabric global object setting.

option

-

disable

Option

Description

enable

Object is set as a security fabric-wide global object.

disable

Object is local to this security fabric member.

fabric-object-source *

Source of truth for fabric object.

option

-

root

Option

Description

member

Source of truth for this object is a non-root member of fabric.

local

Source of truth for this object is this security fabric member.

root

Source of truth for this object is the root of the fabric.

guaranteed-bandwidth

Amount of bandwidth guaranteed for this shaper (0 - 80000000). Units depend on the bandwidth-unit setting.

integer

Minimum value: 0 Maximum value: 80000000 **

0

maximum-bandwidth

Upper bandwidth limit enforced by this shaper (0 - 80000000). 0 means no limit. Units depend on the bandwidth-unit setting.

integer

Minimum value: 0 Maximum value: 80000000 **

0

maximum-cos

VLAN CoS mark for traffic in [exceed-bandwidth, maximum-bandwidth].

user

Not Specified

maximum-dscp

DSCP mark for traffic in exceed-bandwidth and maximum-bandwidth.

user

Not Specified

name

Traffic shaper name.

string

Maximum length: 35

overhead

Per-packet size overhead used in rate computations.

integer

Minimum value: 0 Maximum value: 100

0

per-policy

Enable/disable applying a separate shaper for each policy. For example, if enabled the guaranteed bandwidth is applied separately for each policy.

option

-

disable

Option

Description

disable

All referring policies share one traffic shaper.

enable

Each referring policy has its own traffic shaper.

priority

Higher priority traffic is more likely to be forwarded without delays and without compromising the guaranteed bandwidth.

option

-

high

Option

Description

low

Low priority.

medium

Medium priority.

high

High priority.

uuid *

Universally Unique Identifier (UUID; automatically assigned but can be manually reset).

uuid

Not Specified

00000000-0000-0000-0000-000000000000

* This parameter may not exist in some models.

** Values may differ between models.

config firewall shaper traffic-shaper

config firewall shaper traffic-shaper

Configure shared traffic shaper.

config firewall shaper traffic-shaper
    Description: Configure shared traffic shaper.
    edit <name>
        set bandwidth-unit [kbps|mbps|...]
        set cos {user}
        set cos-marking [enable|disable]
        set cos-marking-method [multi-stage|static]
        set diffserv [enable|disable]
        set diffservcode {user}
        set dscp-marking-method [multi-stage|static]
        set exceed-bandwidth {integer}
        set exceed-class-id {integer}
        set exceed-cos {user}
        set exceed-dscp {user}
        set fabric-force-sync [enable|disable]
        set fabric-object [enable|disable]
        set fabric-object-source [member|local|...]
        set guaranteed-bandwidth {integer}
        set maximum-bandwidth {integer}
        set maximum-cos {user}
        set maximum-dscp {user}
        set overhead {integer}
        set per-policy [disable|enable]
        set priority [low|medium|...]
        set uuid {uuid}
    next
end

config firewall shaper traffic-shaper

Parameter

Description

Type

Size

Default

bandwidth-unit

Unit of measurement for guaranteed and maximum bandwidth for this shaper (Kbps, Mbps or Gbps).

option

-

kbps

Option

Description

kbps

Kilobits per second.

mbps

Megabits per second.

gbps

Gigabits per second.

cos

VLAN CoS mark.

user

Not Specified

cos-marking

Enable/disable VLAN CoS marking.

option

-

disable

Option

Description

enable

Enable VLAN CoS marking.

disable

Disable VLAN CoS marking.

cos-marking-method

Select VLAN CoS marking method.

option

-

static

Option

Description

multi-stage

Multi stage marking.

static

Static marking.

diffserv

Enable/disable changing the DiffServ setting applied to traffic accepted by this shaper.

option

-

disable

Option

Description

enable

Enable setting traffic DiffServ.

disable

Disable setting traffic DiffServ.

diffservcode

DiffServ setting to be applied to traffic accepted by this shaper.

user

Not Specified

dscp-marking-method

Select DSCP marking method.

option

-

static

Option

Description

multi-stage

Multistage marking.

static

Static marking.

exceed-bandwidth

Exceed bandwidth used for DSCP/VLAN CoS multi-stage marking. Units depend on the bandwidth-unit setting.

integer

Minimum value: 0 Maximum value: 80000000 **

0

exceed-class-id

Class ID for traffic in guaranteed-bandwidth and maximum-bandwidth.

integer

Minimum value: 0 Maximum value: 4294967295

0

exceed-cos

VLAN CoS mark for traffic in [guaranteed-bandwidth, exceed-bandwidth].

user

Not Specified

exceed-dscp

DSCP mark for traffic in guaranteed-bandwidth and exceed-bandwidth.

user

Not Specified

fabric-force-sync *

Enable/disable forced synchronization of configuration objects from the root FortiGate unit to the downstream devices. Configuration conflict check is skipped.

option

-

disable

Option

Description

enable

Enable forced synchronization of configuration objects from the root FortiGate unit to the downstream devices.

disable

Disable forced synchronization of configuration objects from the root FortiGate unit to the downstream devices.

fabric-object *

Security Fabric global object setting.

option

-

disable

Option

Description

enable

Object is set as a security fabric-wide global object.

disable

Object is local to this security fabric member.

fabric-object-source *

Source of truth for fabric object.

option

-

root

Option

Description

member

Source of truth for this object is a non-root member of fabric.

local

Source of truth for this object is this security fabric member.

root

Source of truth for this object is the root of the fabric.

guaranteed-bandwidth

Amount of bandwidth guaranteed for this shaper (0 - 80000000). Units depend on the bandwidth-unit setting.

integer

Minimum value: 0 Maximum value: 80000000 **

0

maximum-bandwidth

Upper bandwidth limit enforced by this shaper (0 - 80000000). 0 means no limit. Units depend on the bandwidth-unit setting.

integer

Minimum value: 0 Maximum value: 80000000 **

0

maximum-cos

VLAN CoS mark for traffic in [exceed-bandwidth, maximum-bandwidth].

user

Not Specified

maximum-dscp

DSCP mark for traffic in exceed-bandwidth and maximum-bandwidth.

user

Not Specified

name

Traffic shaper name.

string

Maximum length: 35

overhead

Per-packet size overhead used in rate computations.

integer

Minimum value: 0 Maximum value: 100

0

per-policy

Enable/disable applying a separate shaper for each policy. For example, if enabled the guaranteed bandwidth is applied separately for each policy.

option

-

disable

Option

Description

disable

All referring policies share one traffic shaper.

enable

Each referring policy has its own traffic shaper.

priority

Higher priority traffic is more likely to be forwarded without delays and without compromising the guaranteed bandwidth.

option

-

high

Option

Description

low

Low priority.

medium

Medium priority.

high

High priority.

uuid *

Universally Unique Identifier (UUID; automatically assigned but can be manually reset).

uuid

Not Specified

00000000-0000-0000-0000-000000000000

* This parameter may not exist in some models.

** Values may differ between models.