fmgr_application_list_entries – Application list entries.¶
New in version 2.10.
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.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
FortiManager Version Compatibility¶
6.0.0 |
6.2.1 |
6.2.3 |
6.2.5 |
6.4.0 |
6.4.2 |
6.4.5 |
7.0.0 |
7.2.0 |
|
| application_list_entries | yes | yes | yes | yes | yes | yes | yes | yes | yes |
Parameters¶
- 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
- 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
- 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
- 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
- adom - The parameter in requested url type: str required: true
- list - The parameter in requested url type: str required: true
- application_list_entries - no description type: dict
- action - Pass or block traffic, or reset connection for traffic from this application. type: str choices: [pass, block, reset] more...
- application - No description for the parameter type: int more...
- behavior - No description for the parameter 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 - No description for the parameter type: array more...
- per-ip-shaper - Per-IP traffic shaper. type: str more...
- popularity - No description for the parameter type: array choices: [1, 2, 3, 4, 5] more...
- protocols - No description for the parameter 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 - No description for the parameter 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 - No description for the parameter type: int more...
- technology - No description for the parameter type: str more...
- vendor - No description for the parameter type: str more...
- exclusion - No description for the parameter type: int 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: Application list entries.
fmgr_application_list_entries:
adom: ansible
list: 'ansible-test' # name
state: present
application_list_entries:
action: pass
behavior: 'all'
category: '2'
id: 1
log: enable
log-packet: enable
protocols: 'all'
- 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 entries in application list
fmgr_fact:
facts:
selector: 'application_list_entries'
params:
adom: 'ansible'
list: 'ansible-test' # name
entries: '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:
- 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_message - The descriptive message of the api response returned: always type: str sample: OK
- response_data - The data body of the api response returned: optional type: list or dict