fortinet.fortios.fortios_application_list – Configure application control lists in Fortinet’s FortiOS and FortiGate.

Note

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

To install it use: ansible-galaxy collection install fortinet.fortios.

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

New in version 2.8: of fortinet.fortios

Synopsis

• This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify application feature and list 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				Choices/Defaults	Comments
access_token string					Token-based authentication. Generated from GUI of Fortigate.
application_list dictionary					Configure application control lists.
	app_replacemsg string			Choices: disable enable	Enable/disable replacement messages for blocked applications.
	comment string				comments
	deep_app_inspection string			Choices: disable enable	Enable/disable deep application inspection.
	entries list / elements=string				Application list entries.
		action string		Choices: pass block reset	Pass or block traffic, or reset connection for traffic from this application.
		application list / elements=string			ID of allowed applications.
			id integer / required		Application IDs.
		behavior string			Application behavior filter.
		category list / elements=string			Category ID list.
			id integer / required		Application category ID.
		id integer / required			Entry ID.
		log string		Choices: disable enable	Enable/disable logging for this application list.
		log_packet string		Choices: disable enable	Enable/disable packet logging.
		parameters list / elements=string			Application parameters.
			id integer / required		Parameter ID.
			value string		Parameter value.
		per_ip_shaper string			Per-IP traffic shaper. Source firewall.shaper.per-ip-shaper.name.
		popularity string		Choices: 1 2 3 4 5	Application popularity filter (1 - 5, from least to most popular).
		protocols string			Application protocol filter.
		quarantine string		Choices: none attacker	Quarantine method.
		quarantine_expiry string			Duration of quarantine. (Format
		quarantine_log string		Choices: disable enable	Enable/disable quarantine logging.
		rate_count integer			Count of the rate.
		rate_duration integer			Duration (sec) of the rate.
		rate_mode string		Choices: periodical continuous	Rate limit mode.
		rate_track string		Choices: none src-ip dest-ip dhcp-client-mac dns-domain	Track the packet protocol field.
		risk list / elements=string			Risk, or impact, of allowing traffic from this application to occur (1 - 5; Low, Elevated, Medium, High, and Critical).
			level integer / required		Risk, or impact, of allowing traffic from this application to occur (1 - 5; Low, Elevated, Medium, High, and Critical).
		session_ttl integer			Session TTL (0 = default).
		shaper string			Traffic shaper. Source firewall.shaper.traffic-shaper.name.
		shaper_reverse string			Reverse traffic shaper. Source firewall.shaper.traffic-shaper.name.
		sub_category list / elements=string			Application Sub-category ID list.
			id integer / required		Application sub-category ID.
		technology string			Application technology filter.
		vendor string			Application vendor filter.
	extended_log string			Choices: enable disable	Enable/disable extended logging.
	name string / required				List name.
	options string			Choices: allow-dns allow-icmp allow-http allow-ssl allow-quic	Basic application protocol signatures allowed by default.
	other_application_action string			Choices: pass block	Action for other applications.
	other_application_log string			Choices: disable enable	Enable/disable logging for other applications.
	p2p_black_list string			Choices: skype edonkey bittorrent	P2P applications to be black listed.
	replacemsg_group string				Replacement message group. Source system.replacemsg-group.name.
	state string			Choices: present absent	Deprecated Starting with Ansible 2.9 we recommend using the top-level 'state' parameter. Indicates whether to create or remove the object.
	unknown_application_action string			Choices: pass block	Pass or block traffic from unknown applications.
	unknown_application_log string			Choices: disable enable	Enable/disable logging for unknown applications.
state string added in 2.9 of fortinet.fortios				Choices: present absent	Indicates whether to create or remove the object. This attribute was present already in previous version in a deeper level. It has been moved out to this outer level.
vdom string				Default: "root"	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.

Notes

Note

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

Examples

- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Configure application control lists.
    fortios_application_list:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      application_list:
        app_replacemsg: "disable"
        comment: "comments"
        deep_app_inspection: "disable"
        entries:
         -
            action: "pass"
            application:
             -
                id:  "9"
            behavior: "<your_own_value>"
            category:
             -
                id:  "12"
            id:  "13"
            log: "disable"
            log_packet: "disable"
            parameters:
             -
                id:  "17"
                value: "<your_own_value>"
            per_ip_shaper: "<your_own_value> (source firewall.shaper.per-ip-shaper.name)"
            popularity: "1"
            protocols: "<your_own_value>"
            quarantine: "none"
            quarantine_expiry: "<your_own_value>"
            quarantine_log: "disable"
            rate_count: "25"
            rate_duration: "26"
            rate_mode: "periodical"
            rate_track: "none"
            risk:
             -
                level: "30"
            session_ttl: "31"
            shaper: "<your_own_value> (source firewall.shaper.traffic-shaper.name)"
            shaper_reverse: "<your_own_value> (source firewall.shaper.traffic-shaper.name)"
            sub_category:
             -
                id:  "35"
            technology: "<your_own_value>"
            vendor: "<your_own_value>"
        extended_log: "enable"
        name: "default_name_39"
        options: "allow-dns"
        other_application_action: "pass"
        other_application_log: "disable"
        p2p_black_list: "skype"
        replacemsg_group: "<your_own_value> (source system.replacemsg-group.name)"
        unknown_application_action: "pass"
        unknown_application_log: "disable"

Return Values

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

Key	Returned	Description
build string	always	Build number of the fortigate image Sample: 1547
http_method string	always	Last method used to provision the content into FortiGate Sample: PUT
http_status string	always	Last result given by FortiGate on last operation applied Sample: 200
mkey string	success	Master key (id) used in the last call to FortiGate Sample: id
name string	always	Name of the table used to fulfill the request Sample: urlfilter
path string	always	Path of the table used to fulfill the request Sample: webfilter
revision string	always	Internal revision number Sample: 17.0.2.10658
serial string	always	Serial number of the unit Sample: FGVMEVYYQT3AB5352
status string	always	Indication of the operation's result Sample: success
vdom string	always	Virtual domain used Sample: root
version string	always	Version of the FortiGate 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)