fortinet.fortios.fortios_system_resource_limits – Configure resource limits in Fortinet’s FortiOS and FortiGate.

Note

This plugin is part of the fortinet.fortios collection (version 2.1.3).

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

To use it in a playbook, specify: fortinet.fortios.fortios_system_resource_limits.

New in version 2.10: of fortinet.fortios

Synopsis

  • 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.0

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.9.0

Parameters

Parameter

Comments

access_token

string

Token-based authentication. Generated from GUI of Fortigate.

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • no ← (default)

  • yes

member_path

string

Member attribute path to operate on.

Delimited by a slash character if there are more than one attribute.

Parameter marked with member_path is legitimate for doing member operation.

member_state

string

Add or delete a member under specified attribute path.

When member_state is specified, the state option is ignored.

Choices:

  • present

  • absent

system_resource_limits

dictionary

Configure resource limits.

custom_service

integer

Maximum number of firewall custom services.

dialup_tunnel

integer

Maximum number of dial-up tunnels.

firewall_address

integer

Maximum number of firewall addresses (IPv4, IPv6, multicast).

firewall_addrgrp

integer

Maximum number of firewall address groups (IPv4, IPv6).

firewall_policy

integer

Maximum number of firewall policies (IPv4, IPv6, policy46, policy64, DoS-policy4, DoS-policy6, multicast).

ipsec_phase1

integer

Maximum number of VPN IPsec phase1 tunnels.

ipsec_phase1_interface

integer

Maximum number of VPN IPsec phase1 interface tunnels.

ipsec_phase2

integer

Maximum number of VPN IPsec phase2 tunnels.

ipsec_phase2_interface

integer

Maximum number of VPN IPsec phase2 interface tunnels.

log_disk_quota

integer

Log disk quota in MB.

onetime_schedule

integer

Maximum number of firewall one-time schedules.

proxy

integer

Maximum number of concurrent proxy users.

recurring_schedule

integer

Maximum number of firewall recurring schedules.

service_group

integer

Maximum number of firewall service groups.

session

integer

Maximum number of sessions.

sslvpn

integer

Maximum number of SSL-VPN.

user

integer

Maximum number of local users.

user_group

integer

Maximum number of user groups.

vdom

string

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.

Default: “root”

Notes

Note

  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- collections:
  - fortinet.fortios
  connection: httpapi
  hosts: fortigate01
  vars:
    ansible_httpapi_port: 443
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    vdom: root
  tasks:
  - name: fortios_system_resource_limits
    fortios_system_resource_limits:
      vdom: root
      system_resource_limits: {}

Return Values

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

Key

Description

build

string

Build number of the fortigate image

Returned: always

Sample: “1547”

http_method

string

Last method used to provision the content into FortiGate

Returned: always

Sample: “PUT”

http_status

string

Last result given by FortiGate on last operation applied

Returned: always

Sample: “200”

mkey

string

Master key (id) used in the last call to FortiGate

Returned: success

Sample: “id”

name

string

Name of the table used to fulfill the request

Returned: always

Sample: “urlfilter”

path

string

Path of the table used to fulfill the request

Returned: always

Sample: “webfilter”

revision

string

Internal revision number

Returned: always

Sample: “17.0.2.10658”

serial

string

Serial number of the unit

Returned: always

Sample: “FGVMEVYYQT3AB5352”

status

string

Indication of the operation’s result

Returned: always

Sample: “success”

vdom

string

Virtual domain used

Returned: always

Sample: “root”

version

string

Version of the FortiGate

Returned: always

Sample: “v5.6.3”

Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)