fmgr_application_list – Configure application control lists.¶
New in version 1.0.0.
Synopsis¶
- This module is able to configure a FortiManager device.
- Examples include all parameters and values need to be adjusted to data sources before usage.
- Tested with FortiManager v6.x and v7.x.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
FortiManager Version Compatibility¶
6.0.0 |
||||||||||||
| True | ||||||||||||
6.2.0 |
6.2.1 |
6.2.2 |
6.2.3 |
6.2.5 |
6.2.6 |
6.2.7 |
6.2.8 |
6.2.9 |
6.2.10 |
6.2.11 |
||
| True | True | True | True | True | True | True | True | True | True | True | ||
6.4.0 |
6.4.1 |
6.4.2 |
6.4.3 |
6.4.4 |
6.4.5 |
6.4.6 |
6.4.7 |
6.4.8 |
6.4.9 |
6.4.10 |
6.4.11 |
6.4.12 |
| True | True | True | True | True | True | True | True | True | True | True | True | True |
7.0.0 |
7.0.1 |
7.0.2 |
7.0.3 |
7.0.4 |
7.0.5 |
7.0.6 |
7.0.7 |
7.0.8 |
||||
| True | True | True | True | True | True | True | True | True | ||||
7.2.0 |
7.2.1 |
7.2.2 |
7.2.3 |
|||||||||
| True | True | True | True | |||||||||
7.4.0 |
||||||||||||
| True |
Parameters¶
- access_token -The token to access FortiManager without using username and password. type: str required: false
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
- proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
- state - The directive to create, update or delete an object type: str required: true choices: present, absent
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
- adom - The parameter in requested url type: str required: true
- application_list - Configure application control lists. type: dict
- app-replacemsg - Enable/disable replacement messages for blocked applications. type: str choices: [disable, enable] more...
- comment - comments type: str more...
- deep-app-inspection - Enable/disable deep application inspection. type: str choices: [disable, enable] more...
- entries - Entries. type: array
more...
- action - Pass or block traffic, or reset connection for traffic from this application. type: str choices: [pass, block, reset] more...
- application - ID of allowed applications. type: int more...
- behavior - Application behavior filter. type: str more...
- category - Category ID list. type: str more...
- id - Entry ID. type: int more...
- log - Enable/disable logging for this application list. type: str choices: [disable, enable] more...
- log-packet - Enable/disable packet logging. type: str choices: [disable, enable] more...
- parameters - Parameters. type: array more...
- per-ip-shaper - Per-IP traffic shaper. type: str more...
- popularity - Application popularity filter (1 - 5, from least to most popular). type: array choices: [1, 2, 3, 4, 5] more...
- protocols - Application protocol filter. type: str more...
- quarantine - Quarantine method. type: str choices: [none, attacker] more...
- quarantine-expiry - Duration of quarantine. type: str more...
- quarantine-log - Enable/disable quarantine logging. type: str choices: [disable, enable] more...
- rate-count - Count of the rate. type: int more...
- rate-duration - Duration (sec) of the rate. type: int more...
- rate-mode - Rate limit mode. type: str choices: [periodical, continuous] more...
- rate-track - Track the packet protocol field. type: str choices: [none, src-ip, dest-ip, dhcp-client-mac, dns-domain] more...
- risk - Risk, or impact, of allowing traffic from this application to occur (1 - 5; Low, Elevated, Medium, High, and Critical). type: int more...
- session-ttl - Session TTL (0 = default). type: int more...
- shaper - Traffic shaper. type: str more...
- shaper-reverse - Reverse traffic shaper. type: str more...
- sub-category - Application Sub-category ID list. type: int more...
- technology - Application technology filter. type: str more...
- vendor - Application vendor filter. type: str more...
- tags - Tag filter. type: str more...
- exclusion - ID of excluded applications. type: int more...
- extended-log - Enable/disable extended logging. type: str choices: [disable, enable] more...
- name - List name. type: str more...
- options - Basic application protocol signatures allowed by default. type: array choices: [allow-dns, allow-icmp, allow-http, allow-ssl, allow-quic] more...
- other-application-action - Action for other applications. type: str choices: [pass, block] more...
- other-application-log - Enable/disable logging for other applications. type: str choices: [disable, enable] more...
- p2p-black-list - P2P applications to be black listed. type: array choices: [skype, edonkey, bittorrent] more...
- replacemsg-group - Replacement message group. type: str more...
- unknown-application-action - Pass or block traffic from unknown applications. type: str choices: [pass, block] more...
- unknown-application-log - Enable/disable logging for unknown applications. type: str choices: [disable, enable] more...
- control-default-network-services - Enable/disable enforcement of protocols over selected ports. type: str choices: [disable, enable] more...
- default-network-services - Default-Network-Services. type: array
more...
- id - Entry ID. type: int more...
- port - Port number. type: int more...
- services - Network protocols. type: array choices: [http, ssh, telnet, ftp, dns, smtp, pop3, imap, snmp, nntp, https] more...
- violation-action - Action for protocols not white listed under selected port. type: str choices: [block, monitor, pass] more...
- enforce-default-app-port - Enable/disable default application port enforcement for allowed applications. type: str choices: [disable, enable] more...
- force-inclusion-ssl-di-sigs - Enable/disable forced inclusion of SSL deep inspection signatures. type: str choices: [disable, enable] more...
- p2p-block-list - P2P applications to be blocklisted. type: array choices: [skype, edonkey, bittorrent] more...
Notes¶
Note
- 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¶
- hosts: fortimanager00
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Configure application control lists.
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: fortimanager00
gather_facts: no
connection: httpapi
collections:
- fortinet.fortimanager
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: retrieve all the application list
fmgr_fact:
facts:
selector: 'application_list'
params:
adom: 'ansible'
list: 'your_value'
Return Values¶
Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- meta - The result of the request.returned: always type: dict
- request_url - The full url requested. returned: always type: str sample: /sys/login/user
- response_code - The status of api request. returned: always type: int sample: 0
- response_data - The data body of the api response. returned: optional type: list or dict
- response_message - The descriptive message of the api response. returned: always type: str sample: OK
- system_information - The information of the target system. returned: always type: dict
- rc - The status the request. returned: always type: int 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least on parameter mpt supported by the current FortiManager version type: list 0