fortinet.fortimanager.fmgr_firewall_shapingprofile_shapingentries module – Define shaping entries of this shaping profile.

Note

This module is part of the fortinet.fortimanager collection (version 2.8.0).

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_shapingentries.

New in fortinet.fortimanager 2.0.0

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
access_token string	The token to access FortiManager without using username and password.
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: false ← (default) true
enable_log boolean	Enable/Disable logging for task. Choices: false ← (default) true
firewall_shapingprofile_shapingentries dictionary	The top level parameters set.
burst_in_msec integer	Number of bytes that can be burst at maximum-bandwidth speed.
cburst_in_msec integer	Number of bytes that can be burst as fast as the interface can transmit.
class_id any	(int or str) Class ID.
guaranteed_bandwidth_percentage integer	Guaranteed bandwith in percentage.
id integer / required	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
forticloud_access_token string	Authenticate Ansible client with forticloud API access token.
proposed_method string	The overridden method for the underlying Json RPC request. Choices: "update" "set" "add"
rc_failed list / elements=integer	The rc codes list with which the conditions to fail will be overriden.
rc_succeeded list / elements=integer	The rc codes list with which the conditions to succeed will be overriden.
shaping-profile string	Deprecated, please use “shaping_profile”
shaping_profile string	The parameter (shaping-profile) in requested url.
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

• Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.

• 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: Example playbook
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Define shaping entries of this shaping profile.
      fortinet.fortimanager.fmgr_firewall_shapingprofile_shapingentries:
        bypass_validation: false
        adom: ansible
        shaping-profile: "ansible-test" # profile-name
        state: present
        firewall_shapingprofile_shapingentries:
          guaranteed-bandwidth-percentage: 50
          id: 1
          maximum-bandwidth-percentage: 70
          priority: medium # <value in [low, medium, high]>

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the shaping entries of this shaping profile
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "firewall_shapingprofile_shapingentries"
          params:
            adom: "ansible"
            shaping-profile: "ansible-test" # profile-name
            shaping-entries: "your_value"

Return Values

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

Key	Description
meta dictionary	The result of the request. Returned: always
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_data list / elements=string	The api response. Returned: always
response_message string	The descriptive message of the api response. Returned: always Sample: "OK."
system_information dictionary	The information of the target system. Returned: always
rc integer	The status the request. Returned: always Sample: 0
version_check_warning list / elements=string	Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex

Authors

• Xinwei Du (@dux-fortinet)

• Xing Li (@lix-fortinet)

• Jie Xue (@JieX19)

• Link Zheng (@chillancezen)

• Frank Shen (@fshen01)

• Hongbin Lu (@fgtdev-hblu)

Collection links

• Issue Tracker
• Homepage
• Repository (Sources)