Fortinet black 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 diffserv [enable|disable]
        set diffservcode {user}
        set dscp-marking-method [multi-stage|static]
        set exceed-bandwidth {integer}
        set exceed-class-id {integer}
        set exceed-dscp {user}
        set guaranteed-bandwidth {integer}
        set maximum-bandwidth {integer}
        set maximum-dscp {user}
        set overhead {integer}
        set per-policy [disable|enable]
        set priority [low|medium|...]
    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.

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 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-dscp

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

user

Not Specified

guaranteed-bandwidth

Amount of bandwidth guaranteed for this shaper. 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 means no limit. Units depend on the bandwidth-unit setting.

integer

Minimum value: 0 Maximum value: 80000000 **

0

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.

** Values may differ between models.

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 diffserv [enable|disable]
        set diffservcode {user}
        set dscp-marking-method [multi-stage|static]
        set exceed-bandwidth {integer}
        set exceed-class-id {integer}
        set exceed-dscp {user}
        set guaranteed-bandwidth {integer}
        set maximum-bandwidth {integer}
        set maximum-dscp {user}
        set overhead {integer}
        set per-policy [disable|enable]
        set priority [low|medium|...]
    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.

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 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-dscp

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

user

Not Specified

guaranteed-bandwidth

Amount of bandwidth guaranteed for this shaper. 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 means no limit. Units depend on the bandwidth-unit setting.

integer

Minimum value: 0 Maximum value: 80000000 **

0

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.

** Values may differ between models.