ansible.builtin.fortios_system_resource_limits (v2.9.27) — module

Configure resource limits in Fortinet's FortiOS and FortiGate.

| "added in version" 2.9 of ansible.builtin"

Authors: Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.9.27

Description

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and resource_limits category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
   ssl_verify: "False"
  tasks:
  - name: Configure resource limits.
    fortios_system_resource_limits:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      system_resource_limits:
        custom_service: "3"
        dialup_tunnel: "4"
        firewall_address: "5"
        firewall_addrgrp: "6"
        firewall_policy: "7"
        ipsec_phase1: "8"
        ipsec_phase1_interface: "9"
        ipsec_phase2: "10"
        ipsec_phase2_interface: "11"
        log_disk_quota: "12"
        onetime_schedule: "13"
        proxy: "14"
        recurring_schedule: "15"
        service_group: "16"
        session: "17"
        sslvpn: "18"
        user: "19"
        user_group: "20"

Inputs

    
host:
    description:
    - FortiOS or FortiGate IP address.
    required: false
    type: str

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.
    type: str

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

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

username:
    description:
    - FortiOS or FortiGate username.
    required: false
    type: str

ssl_verify:
    default: true
    description:
    - Ensures FortiGate certificate must be verified by a proper CA.
    type: bool

system_resource_limits:
    default: null
    description:
    - Configure resource limits.
    suboptions:
      custom_service:
        description:
        - Maximum number of firewall custom services.
        type: int
      dialup_tunnel:
        description:
        - Maximum number of dial-up tunnels.
        type: int
      firewall_address:
        description:
        - Maximum number of firewall addresses (IPv4, IPv6, multicast).
        type: int
      firewall_addrgrp:
        description:
        - Maximum number of firewall address groups (IPv4, IPv6).
        type: int
      firewall_policy:
        description:
        - Maximum number of firewall policies (IPv4, IPv6, policy46, policy64, DoS-policy4,
          DoS-policy6, multicast).
        type: int
      ipsec_phase1:
        description:
        - Maximum number of VPN IPsec phase1 tunnels.
        type: int
      ipsec_phase1_interface:
        description:
        - Maximum number of VPN IPsec phase1 interface tunnels.
        type: int
      ipsec_phase2:
        description:
        - Maximum number of VPN IPsec phase2 tunnels.
        type: int
      ipsec_phase2_interface:
        description:
        - Maximum number of VPN IPsec phase2 interface tunnels.
        type: int
      log_disk_quota:
        description:
        - Log disk quota in MB.
        type: int
      onetime_schedule:
        description:
        - Maximum number of firewall one-time schedules.
        type: int
      proxy:
        description:
        - Maximum number of concurrent proxy users.
        type: int
      recurring_schedule:
        description:
        - Maximum number of firewall recurring schedules.
        type: int
      service_group:
        description:
        - Maximum number of firewall service groups.
        type: int
      session:
        description:
        - Maximum number of sessions.
        type: int
      sslvpn:
        description:
        - Maximum number of SSL-VPN.
        type: int
      user:
        description:
        - Maximum number of local users.
        type: int
      user_group:
        description:
        - Maximum number of user groups.
        type: int
    type: dict

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