/ home / fortinet / fortinet.fortimanager / 2.4.0 / module / fmgr_firewall_shaper_peripshaper

fortinet.fortimanager.fmgr_firewall_shaper_peripshaper (2.4.0) — module

Configure per-IP traffic shaper.

| "added in version" 2.0.0 of fortinet.fortimanager"

Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu)

preview | supported by community

Install collection

Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0

Add to requirements.yml

  collections:
    - name: fortinet.fortimanager
      version: 2.4.0

Description

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.

Usage examples

Scanned by Steampunk Spotter

- name: Example playbook
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure per-IP traffic shaper.
      fortinet.fortimanager.fmgr_firewall_shaper_peripshaper:
        bypass_validation: false
        adom: ansible
        state: present
        firewall_shaper_peripshaper:
          bandwidth-unit: mbps # <value in [kbps, mbps, gbps]>
          diffserv-forward: enable
          diffserv-reverse: disable
          name: "ansible-test"

Scanned by Steampunk Spotter

- 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 per-IP traffic shapers
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "firewall_shaper_peripshaper"
          params:
            adom: "ansible"
            per-ip-shaper: "your_value"

Inputs

adom:
description: The parameter (adom) in requested url.
required: true
type: str

state:
choices:
- present
- absent
description: The directive to create, update or delete an object.
required: true
type: str

rc_failed:
description: The rc codes list with which the conditions to fail will be overriden.
elements: int
type: list

enable_log:
default: false
description: Enable/Disable logging for task.
type: bool

access_token:
description: The token to access FortiManager without using username and password.
type: str

rc_succeeded:
description: The rc codes list with which the conditions to succeed will be overriden.
elements: int
type: list

proposed_method:
choices:
- update
- set
- add
description: The overridden method for the underlying Json RPC request.
type: str

bypass_validation:
default: false
description: Only set to True when module schema diffs with FortiManager API structure,
module continues to execute without validating parameters.
type: bool

workspace_locking_adom:
description: The adom to lock for FortiManager running in workspace mode, the value
can be global and others including root.
type: str

forticloud_access_token:
description: Authenticate Ansible client with forticloud API access token.
type: str

workspace_locking_timeout:
default: 300
description: The maximum time in seconds to wait for other user to release the workspace
lock.
type: int

firewall_shaper_peripshaper:
description: The top level parameters set.
required: false
suboptions:
bandwidth-unit:
choices:
- kbps
- mbps
- gbps
description: Deprecated, please rename it to bandwidth_unit. Unit of measurement
for maximum bandwidth for this shaper
type: str
diffserv-forward:
choices:
- disable
- enable
description: Deprecated, please rename it to diffserv_forward. Enable/disable
changing the Forward
type: str
diffserv-reverse:
choices:
- disable
- enable
description: Deprecated, please rename it to diffserv_reverse. Enable/disable
changing the Reverse
type: str
diffservcode-forward:
description: Deprecated, please rename it to diffservcode_forward. Forward
type: str
diffservcode-rev:
description: Deprecated, please rename it to diffservcode_rev. Reverse
type: str
max-bandwidth:
description: Deprecated, please rename it to max_bandwidth. Upper bandwidth limit
enforced by this shaper
type: int
max-concurrent-session:
description: Deprecated, please rename it to max_concurrent_session. Maximum number
of concurrent sessions allowed by this shaper
type: int
max-concurrent-tcp-session:
description: Deprecated, please rename it to max_concurrent_tcp_session. Maximum
number of concurrent TCP sessions allowed by this shaper
type: int
max-concurrent-udp-session:
description: Deprecated, please rename it to max_concurrent_udp_session. Maximum
number of concurrent UDP sessions allowed by this shaper
type: int
name:
description: Traffic shaper name.
required: true
type: str
type: dict

Outputs

meta:
  contains:
    request_url:
      description: The full url requested.
      returned: always
      sample: /sys/login/user
      type: str
    response_code:
      description: The status of api request.
      returned: always
      sample: 0
      type: int
    response_data:
      description: The api response.
      returned: always
      type: list
    response_message:
      description: The descriptive message of the api response.
      returned: always
      sample: OK.
      type: str
    system_information:
      description: The information of the target system.
      returned: always
      type: dict
  description: The result of the request.
  returned: always
  type: dict
rc:
  description: The status the request.
  returned: always
  sample: 0
  type: int
version_check_warning:
  description: Warning if the parameters used in the playbook are not supported by
    the current FortiManager version.
  returned: complex
  type: list