fortinet.fortimanager.fmgr_firewall_shapingprofile – Configure shaping profiles.

Note

This plugin is part of the fortinet.fortimanager collection (version 2.1.4).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_firewall_shapingprofile.

New in version 2.10: of fortinet.fortimanager

Synopsis

  • This module is able to configure a FortiManager device.

  • Examples include all parameters and values which need to be adjusted to data sources before usage.

Parameters

Parameter

Comments

adom

string / required

the parameter (adom) in requested url

bypass_validation

boolean

only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters

Choices:

  • no ← (default)

  • yes

enable_log

boolean

Enable/Disable logging for task

Choices:

  • no ← (default)

  • yes

firewall_shapingprofile

dictionary

the top level parameters set

comment

string

Comment.

default-class-id

integer

Default class ID to handle unclassified packets (including all local traffic).

profile-name

string

Shaping profile name.

shaping-entries

list / elements=string

Shaping-Entries.

burst-in-msec

integer

Number of bytes that can be burst at maximum-bandwidth speed. Formula: burst = maximum-bandwidth*burst-in-msec.

cburst-in-msec

integer

Number of bytes that can be burst as fast as the interface can transmit. Formula: cburst = maximum-bandwidth*cburst-in…

class-id

integer

Class ID.

guaranteed-bandwidth-percentage

integer

Guaranteed bandwith in percentage.

id

integer

ID number.

limit

integer

Hard limit on the real queue size in packets.

max

integer

Average queue size in packets at which RED drop probability is maximal.

maximum-bandwidth-percentage

integer

Maximum bandwith in percentage.

min

integer

Average queue size in packets at which RED drop becomes a possibility.

priority

string

Priority.

Choices:

  • low

  • medium

  • high

  • critical

  • top

red-probability

integer

Maximum probability (in percentage) for RED marking.

type

string

Select shaping profile type: policing / queuing.

Choices:

  • policing

  • queuing

proposed_method

string

The overridden method for the underlying Json RPC request

Choices:

  • update

  • set

  • add

rc_failed

list / elements=string

the rc codes list with which the conditions to fail will be overriden

rc_succeeded

list / elements=string

the rc codes list with which the conditions to succeed will be overriden

state

string / required

the directive to create, update or delete an object

Choices:

  • present

  • absent

workspace_locking_adom

string

the adom to lock for FortiManager running in workspace mode, the value can be global and others including root

workspace_locking_timeout

integer

the maximum time in seconds to wait for other user to release the workspace lock

Default: 300

Notes

Note

  • Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.

  • To create or update an object, use state present directive.

  • To delete an object, use state absent directive.

  • Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

- name: gathering fortimanager facts
  hosts: fortimanager00
  gather_facts: no
  connection: httpapi
  collections:
    - fortinet.fortimanager
  vars:
    ansible_httpapi_use_ssl: True
    ansible_httpapi_validate_certs: False
    ansible_httpapi_port: 443
  tasks:
   - name: retrieve all the shaping profiles
     fmgr_fact:
       facts:
           selector: 'firewall_shapingprofile'
           params:
               adom: 'ansible'
               shaping-profile: ''
- hosts: fortimanager00
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Configure shaping profiles.
     fmgr_firewall_shapingprofile:
        bypass_validation: False
        adom: ansible
        state: present
        firewall_shapingprofile:
           comment: 'ansible-comment'
           profile-name: 'ansible-test'

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

request_url

string

The full url requested

Returned: always

Sample: “/sys/login/user”

response_code

integer

The status of api request

Returned: always

Sample: 0

response_message

string

The descriptive message of the api response

Returned: always

Sample: “OK.”

Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)