ansible.builtin.fortios_firewall_shaper_per_ip_shaper (v2.8.20) — module

Install Ansible via pip

Install with pip install ansible==2.8.20

Description

This module is able to configure a FortiGate or FortiOS by allowing the user to configure firewall_shaper feature and per_ip_shaper category. Examples includes all options and need to be adjusted to datasources before usage. Tested with FOS v6.0.2

Requirements

• fortiosapi>=0.9.8

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
  tasks:
  - name: Configure per-IP traffic shaper.
    fortios_firewall_shaper_per_ip_shaper:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      firewall_shaper_per_ip_shaper:
        state: "present"
        bandwidth-unit: "kbps"
        diffserv-forward: "enable"
        diffserv-reverse: "enable"
        diffservcode-forward: "<your_own_value>"
        diffservcode-rev: "<your_own_value>"
        max-bandwidth: "8"
        max-concurrent-session: "9"
        name: "default_name_10"

Inputs

    
host:
    description:
    - FortiOS or FortiGate ip adress.
    required: true

vdom:
    default: root
    description:
    - Virtual domain, among those defined previously. A vdom is a virtual instance of
      the FortiGate that can be configured and used as a different unit.

https:
    default: true
    description:
    - Indicates if the requests towards FortiGate must use HTTPS protocol
    type: bool

password:
    default: ''
    description:
    - FortiOS or FortiGate password.

username:
    description:
    - FortiOS or FortiGate username.
    required: true

firewall_shaper_per_ip_shaper:
    default: null
    description:
    - Configure per-IP traffic shaper.
    suboptions:
      bandwidth-unit:
        choices:
        - kbps
        - mbps
        - gbps
        description:
        - Unit of measurement for maximum bandwidth for this shaper (Kbps, Mbps or Gbps).
      diffserv-forward:
        choices:
        - enable
        - disable
        description:
        - Enable/disable changing the Forward (original) DiffServ setting applied to traffic
          accepted by this shaper.
      diffserv-reverse:
        choices:
        - enable
        - disable
        description:
        - Enable/disable changing the Reverse (reply) DiffServ setting applied to traffic
          accepted by this shaper.
      diffservcode-forward:
        description:
        - Forward (original) DiffServ setting to be applied to traffic accepted by this
          shaper.
      diffservcode-rev:
        description:
        - Reverse (reply) DiffServ setting to be applied to traffic accepted by this shaper.
      max-bandwidth:
        description:
        - Upper bandwidth limit enforced by this shaper (0 - 16776000). 0 means no limit.
          Units depend on the bandwidth-unit setting.
      max-concurrent-session:
        description:
        - Maximum number of concurrent sessions allowed by this shaper (0 - 2097000).
          0 means no limit.
      name:
        description:
        - Traffic shaper name.
        required: true
      state:
        choices:
        - present
        - absent
        description:
        - Indicates whether to create or remove the object

Outputs

build:
  description: Build number of the fortigate image
  returned: always
  sample: '1547'
  type: str
http_method:
  description: Last method used to provision the content into FortiGate
  returned: always
  sample: PUT
  type: str
http_status:
  description: Last result given by FortiGate on last operation applied
  returned: always
  sample: '200'
  type: str
mkey:
  description: Master key (id) used in the last call to FortiGate
  returned: success
  sample: id
  type: str
name:
  description: Name of the table used to fulfill the request
  returned: always
  sample: urlfilter
  type: str
path:
  description: Path of the table used to fulfill the request
  returned: always
  sample: webfilter
  type: str
revision:
  description: Internal revision number
  returned: always
  sample: 17.0.2.10658
  type: str
serial:
  description: Serial number of the unit
  returned: always
  sample: FGVMEVYYQT3AB5352
  type: str
status:
  description: Indication of the operation's result
  returned: always
  sample: success
  type: str
vdom:
  description: Virtual domain used
  returned: always
  sample: root
  type: str
version:
  description: Version of the FortiGate
  returned: always
  sample: v5.6.3
  type: str