Fortinet black logo

CLI Reference

firewall shaper traffic-shaper

Configure shared traffic shaper.

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

config firewall shaper traffic-shaper

Parameter Name Description Type Size
guaranteed-bandwidth Amount of bandwidth guaranteed for this shaper (0 - 16776000). Units depend on the bandwidth-unit setting. integer Minimum value: 0 Maximum value: 16776000
maximum-bandwidth Upper bandwidth limit enforced by this shaper (0 - 16776000). 0 means no limit. Units depend on the bandwidth-unit setting. integer Minimum value: 0 Maximum value: 16776000
bandwidth-unit Unit of measurement for guaranteed and maximum bandwidth for this shaper (Kbps, Mbps or Gbps).
kbps: Kilobits per second.
mbps: Megabits per second.
gbps: Gigabits per second.
option -
priority Higher priority traffic is more likely to be forwarded without delays and without compromising the guaranteed bandwidth.
low: Low priority.
medium: Medium priority.
high: High priority.
option -
per-policy Enable/disable applying a separate shaper for each policy. For example, if enabled the guaranteed bandwidth is applied separately for each policy.
disable: All referring policies share one traffic shaper.
enable: Each referring policy has its own traffic shaper.
option -
diffserv Enable/disable changing the DiffServ setting applied to traffic accepted by this shaper.
enable: Enable setting traffic DiffServ.
disable: Disable setting traffic DiffServ.
option -
diffservcode DiffServ setting to be applied to traffic accepted by this shaper. user Not Specified
dscp-marking-method Select DSCP marking method.
multi-stage: Multistage marking.
static: Static marking.
option -
exceed-bandwidth Exceed bandwidth used for DSCP multi-stage marking. Units depend on the bandwidth-unit setting. integer Minimum value: 0 Maximum value: 16776000
exceed-dscp DSCP mark for traffic in [guaranteed-bandwidth, exceed-bandwidth]. user Not Specified
maximum-dscp DSCP mark for traffic in [exceed-bandwidth, maximum-bandwidth]. user Not Specified
overhead Per-packet size overhead used in rate computations. integer Minimum value: 0 Maximum value: 100
exceed-class-id Class ID for traffic in [guaranteed-bandwidth, maximum-bandwidth]. integer Minimum value: 2 Maximum value: 31

Configure shared traffic shaper.

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

config firewall shaper traffic-shaper

Parameter Name Description Type Size
guaranteed-bandwidth Amount of bandwidth guaranteed for this shaper (0 - 16776000). Units depend on the bandwidth-unit setting. integer Minimum value: 0 Maximum value: 16776000
maximum-bandwidth Upper bandwidth limit enforced by this shaper (0 - 16776000). 0 means no limit. Units depend on the bandwidth-unit setting. integer Minimum value: 0 Maximum value: 16776000
bandwidth-unit Unit of measurement for guaranteed and maximum bandwidth for this shaper (Kbps, Mbps or Gbps).
kbps: Kilobits per second.
mbps: Megabits per second.
gbps: Gigabits per second.
option -
priority Higher priority traffic is more likely to be forwarded without delays and without compromising the guaranteed bandwidth.
low: Low priority.
medium: Medium priority.
high: High priority.
option -
per-policy Enable/disable applying a separate shaper for each policy. For example, if enabled the guaranteed bandwidth is applied separately for each policy.
disable: All referring policies share one traffic shaper.
enable: Each referring policy has its own traffic shaper.
option -
diffserv Enable/disable changing the DiffServ setting applied to traffic accepted by this shaper.
enable: Enable setting traffic DiffServ.
disable: Disable setting traffic DiffServ.
option -
diffservcode DiffServ setting to be applied to traffic accepted by this shaper. user Not Specified
dscp-marking-method Select DSCP marking method.
multi-stage: Multistage marking.
static: Static marking.
option -
exceed-bandwidth Exceed bandwidth used for DSCP multi-stage marking. Units depend on the bandwidth-unit setting. integer Minimum value: 0 Maximum value: 16776000
exceed-dscp DSCP mark for traffic in [guaranteed-bandwidth, exceed-bandwidth]. user Not Specified
maximum-dscp DSCP mark for traffic in [exceed-bandwidth, maximum-bandwidth]. user Not Specified
overhead Per-packet size overhead used in rate computations. integer Minimum value: 0 Maximum value: 100
exceed-class-id Class ID for traffic in [guaranteed-bandwidth, maximum-bandwidth]. integer Minimum value: 2 Maximum value: 31