fortinet.fortios.fortios_application_list module – Configure application control lists in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.8).
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
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: fortinet.fortios.fortios_application_list
.
New in fortinet.fortios 2.0.0
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.15
Parameters
Parameter |
Comments |
---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Configure application control lists. |
|
Enable/disable replacement messages for blocked applications. Choices:
|
|
Comments. |
|
Enable/disable enforcement of protocols over selected ports. Choices:
|
|
Enable/disable deep application inspection. Choices:
|
|
Default network service entries. |
|
Entry ID. see <a href=’#notes’>Notes</a>. |
|
Port number. |
|
Network protocols. Choices:
|
|
Action for protocols not in the allowlist for selected port. Choices:
|
|
Enable/disable default application port enforcement for allowed applications. Choices:
|
|
Application list entries. |
|
Pass or block traffic, or reset connection for traffic from this application. Choices:
|
|
ID of allowed applications. |
|
Application IDs. see <a href=’#notes’>Notes</a>. |
|
Application behavior filter. |
|
Category ID list. |
|
Application category ID. see <a href=’#notes’>Notes</a>. |
|
ID of excluded applications. |
|
Excluded application IDs. see <a href=’#notes’>Notes</a>. |
|
Entry ID. see <a href=’#notes’>Notes</a>. |
|
Enable/disable logging for this application list. Choices:
|
|
Enable/disable packet logging. Choices:
|
|
Application parameters. |
|
Parameter tuple ID. see <a href=’#notes’>Notes</a>. |
|
Parameter tuple members. |
|
Parameter. see <a href=’#notes’>Notes</a>. |
|
Parameter name. |
|
Parameter value. |
|
Parameter value. |
|
Per-IP traffic shaper. Source firewall.shaper.per-ip-shaper.name. |
|
Application popularity filter (1 - 5, from least to most popular). Choices:
|
|
Application protocol filter. |
|
Quarantine method. Choices:
|
|
Duration of quarantine. (Format |
|
Enable/disable quarantine logging. Choices:
|
|
Count of the rate. |
|
Duration (sec) of the rate. |
|
Rate limit mode. Choices:
|
|
Track the packet protocol field. Choices:
|
|
Risk, or impact, of allowing traffic from this application to occur (1 - 5; Low, Elevated, Medium, High, and Critical). |
|
Risk, or impact, of allowing traffic from this application to occur (1 - 5; Low, Elevated, Medium, High, and Critical). see <a href=’#notes’>Notes</a>. |
|
Session TTL (0 = default). |
|
Traffic shaper. Source firewall.shaper.traffic-shaper.name. |
|
Reverse traffic shaper. Source firewall.shaper.traffic-shaper.name. |
|
Application Sub-category ID list. |
|
Application sub-category ID. see <a href=’#notes’>Notes</a>. |
|
Application technology filter. |
|
Application vendor filter. |
|
Enable/disable extended logging. Choices:
|
|
Enable/disable forced inclusion of SSL deep inspection signatures. Choices:
|
|
List name. |
|
Basic application protocol signatures allowed by default. Choices:
|
|
Action for other applications. Choices:
|
|
Enable/disable logging for other applications. Choices:
|
|
P2P applications to be black listed. Choices:
|
|
P2P applications to be block listed. Choices:
|
|
Replacement message group. Source system.replacemsg-group.name. |
|
Pass or block traffic from unknown applications. Choices:
|
|
Enable/disable logging for unknown applications. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
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. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
Indicates whether to create or remove the object. Choices:
|
|
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: |
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
The module supports check_mode.
Examples
- name: Configure application control lists.
fortinet.fortios.fortios_application_list:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
application_list:
app_replacemsg: "disable"
comment: "Comments."
control_default_network_services: "disable"
deep_app_inspection: "disable"
default_network_services:
-
id: "8"
port: "0"
services: "http"
violation_action: "pass"
enforce_default_app_port: "disable"
entries:
-
action: "pass"
application:
-
id: "16"
behavior: "<your_own_value>"
category:
-
id: "19"
exclusion:
-
id: "21"
id: "22"
log: "disable"
log_packet: "disable"
parameters:
-
id: "26"
members:
-
id: "28"
name: "default_name_29"
value: "<your_own_value>"
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: "0"
rate_duration: "60"
rate_mode: "periodical"
rate_track: "none"
risk:
-
level: "<you_own_value>"
session_ttl: "0"
shaper: "<your_own_value> (source firewall.shaper.traffic-shaper.name)"
shaper_reverse: "<your_own_value> (source firewall.shaper.traffic-shaper.name)"
sub_category:
-
id: "48"
technology: "<your_own_value>"
vendor: "<your_own_value>"
extended_log: "enable"
force_inclusion_ssl_di_sigs: "disable"
name: "default_name_53"
options: "allow-dns"
other_application_action: "pass"
other_application_log: "disable"
p2p_black_list: "skype"
p2p_block_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 |
Description |
---|---|
Build number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |