fortinet.fortimanager.fmgr_application_list module – Configure application control lists.
Note
This module is part of the fortinet.fortimanager collection (version 2.7.0).
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.fortimanager
.
To use it in a playbook, specify: fortinet.fortimanager.fmgr_application_list
.
New in fortinet.fortimanager 1.0.0
Synopsis
This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
Parameter |
Comments |
---|---|
The token to access FortiManager without using username and password. |
|
The parameter (adom) in requested url. |
|
The top level parameters set. |
|
Deprecated, please rename it to app_replacemsg. Enable/disable replacement messages for blocked applications. Choices:
|
|
Comments |
|
Deprecated, please rename it to control_default_network_services. Enable/disable enforcement of protocols over selected ports. Choices:
|
|
Deprecated, please rename it to deep_app_inspection. Enable/disable deep application inspection. Choices:
|
|
Deprecated, please rename it to default_network_services. Default network services. |
|
Entry ID. |
|
Port number. |
|
Network protocols. Choices:
|
|
Deprecated, please rename it to violation_action. Action for protocols not white listed under selected port. Choices:
|
|
Deprecated, please rename it to enforce_default_app_port. Enable/disable default application port enforcement for allowed … Choices:
|
|
Entries. |
|
Pass or block traffic, or reset connection for traffic from this application. Choices:
|
|
(list) ID of allowed applications. |
|
(list) Application behavior filter. |
|
(list or str) Category ID list. |
|
(list) ID of excluded applications. |
|
Entry ID. |
|
Enable/disable logging for this application list. Choices:
|
|
Deprecated, please rename it to log_packet. Enable/disable packet logging. Choices:
|
|
Parameters. |
|
Parameter ID. |
|
Members. |
|
Parameter. |
|
Parameter name. |
|
Parameter value. |
|
Parameter value. |
|
Deprecated, please rename it to per_ip_shaper. Per-IP traffic shaper. |
|
Application popularity filter Choices:
|
|
(list) Application protocol filter. |
|
Quarantine method. Choices:
|
|
Deprecated, please rename it to quarantine_expiry. Duration of quarantine. |
|
Deprecated, please rename it to quarantine_log. Enable/disable quarantine logging. Choices:
|
|
Deprecated, please rename it to rate_count. Count of the rate. |
|
Deprecated, please rename it to rate_duration. Duration |
|
Deprecated, please rename it to rate_mode. Rate limit mode. Choices:
|
|
Deprecated, please rename it to rate_track. Track the packet protocol field. Choices:
|
|
(list) Risk, or impact, of allowing traffic from this application to occur |
|
Deprecated, please rename it to session_ttl. Session TTL |
|
Traffic shaper. |
|
Deprecated, please rename it to shaper_reverse. Reverse traffic shaper. |
|
(list) Deprecated, please rename it to sub_category. Application Sub-category ID list. |
|
Tag filter. |
|
(list) Application technology filter. |
|
(list) Application vendor filter. |
|
Deprecated, please rename it to extended_log. Enable/disable extended logging. Choices:
|
|
Deprecated, please rename it to force_inclusion_ssl_di_sigs. Enable/disable forced inclusion of SSL deep inspection signat… Choices:
|
|
List name. |
|
Basic application protocol signatures allowed by default. Choices:
|
|
Deprecated, please rename it to other_application_action. Action for other applications. Choices:
|
|
Deprecated, please rename it to other_application_log. Enable/disable logging for other applications. Choices:
|
|
Deprecated, please rename it to p2p_black_list. P2P applications to be black listed. Choices:
|
|
Deprecated, please rename it to p2p_block_list. P2P applications to be blocklisted. Choices:
|
|
Deprecated, please rename it to replacemsg_group. Replacement message group. |
|
Deprecated, please rename it to unknown_application_action. Pass or block traffic from unknown applications. Choices:
|
|
Deprecated, please rename it to unknown_application_log. Enable/disable logging for unknown applications. Choices:
|
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
Authenticate Ansible client with forticloud API access token. |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The directive to create, update or delete an object. Choices:
|
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
Notes
Note
Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.
Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
To create or update an object, use state present directive.
To delete an object, use state absent directive.
Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded
Examples
- name: Example playbook
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure application control lists.
fortinet.fortimanager.fmgr_application_list:
adom: ansible
state: present
application_list:
app-replacemsg: enable
comment: "ansible-test-comment"
deep-app-inspection: enable
extended-log: disable
name: "ansible-test"
other-application-action: pass
other-application-log: disable
unknown-application-action: pass
unknown-application-log: disable
- name: Gathering fortimanager facts
hosts: fortimanagers
gather_facts: false
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Retrieve all the application list
fortinet.fortimanager.fmgr_fact:
facts:
selector: "application_list"
params:
adom: "ansible"
list: "your_value"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |