fortinet.fortimanager.fmgr_application_list_entries module – Application list entries.

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_entries.

New in fortinet.fortimanager 2.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
access_token string	The token to access FortiManager without using username and password.
adom string / required	The parameter (adom) in requested url.
application_list_entries dictionary	The top level parameters set.
action string	Pass or block traffic, or reset connection for traffic from this application. Choices: `"pass"` `"block"` `"reset"`
application any	(list) ID of allowed applications.
behavior any	(list) Application behavior filter.
category any	(list or str) Category ID list.
exclusion any	(list) ID of excluded applications.
id integer / required	Entry ID.
log string	Enable/disable logging for this application list. Choices: `"disable"` `"enable"`
log-packet string	Deprecated, please rename it to log_packet. Enable/disable packet logging. Choices: `"disable"` `"enable"`
parameters list / elements=dictionary	Parameters.
id integer	Parameter ID.
members list / elements=dictionary	Members.
id integer	Parameter.
name string	Parameter name.
value string	Parameter value.
value string	Parameter value.
per-ip-shaper string	Deprecated, please rename it to per_ip_shaper. Per-IP traffic shaper.
popularity list / elements=string	Application popularity filter Choices: `"1"` `"2"` `"3"` `"4"` `"5"`
protocols any	(list) Application protocol filter.
quarantine string	Quarantine method. Choices: `"none"` `"attacker"`
quarantine-expiry string	Deprecated, please rename it to quarantine_expiry. Duration of quarantine.
quarantine-log string	Deprecated, please rename it to quarantine_log. Enable/disable quarantine logging. Choices: `"disable"` `"enable"`
rate-count integer	Deprecated, please rename it to rate_count. Count of the rate.
rate-duration integer	Deprecated, please rename it to rate_duration. Duration
rate-mode string	Deprecated, please rename it to rate_mode. Rate limit mode. Choices: `"periodical"` `"continuous"`
rate-track string	Deprecated, please rename it to rate_track. Track the packet protocol field. Choices: `"none"` `"src-ip"` `"dest-ip"` `"dhcp-client-mac"` `"dns-domain"`
risk any	(list) Risk, or impact, of allowing traffic from this application to occur
session-ttl integer	Deprecated, please rename it to session_ttl. Session TTL
shaper string	Traffic shaper.
shaper-reverse string	Deprecated, please rename it to shaper_reverse. Reverse traffic shaper.
sub-category any	(list) Deprecated, please rename it to sub_category. Application Sub-category ID list.
tags string	Tag filter.
technology any	(list) Application technology filter.
vendor any	(list) Application vendor filter.
bypass_validation boolean	Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices: `false` ← (default) `true`
enable_log boolean	Enable/Disable logging for task. Choices: `false` ← (default) `true`
forticloud_access_token string	Authenticate Ansible client with forticloud API access token.
list string / required	The parameter (list) in requested url.
proposed_method string	The overridden method for the underlying Json RPC request. Choices: `"update"` `"set"` `"add"`
rc_failed list / elements=integer	The rc codes list with which the conditions to fail will be overriden.
rc_succeeded list / elements=integer	The rc codes list with which the conditions to succeed will be overriden.
state string / required	The directive to create, update or delete an object. Choices: `"present"` `"absent"`
workspace_locking_adom string	The adom to lock for FortiManager running in workspace mode, the value can be global and others including root.
workspace_locking_timeout integer	The maximum time in seconds to wait for other user to release the workspace lock. Default: `300`

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: Application list entries.
      fortinet.fortimanager.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: 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 entries in application list
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "application_list_entries"
          params:
            adom: "ansible"
            list: "ansible-test" # name
            entries: "your_value"

Return Values 

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

Key	Description
meta dictionary	The result of the request. Returned: always
request_url string	The full url requested. Returned: always Sample: `"/sys/login/user"`
response_code integer	The status of api request. Returned: always Sample: `0`
response_data list / elements=string	The api response. Returned: always
response_message string	The descriptive message of the api response. Returned: always Sample: `"OK."`
system_information dictionary	The information of the target system. Returned: always
rc integer	The status the request. Returned: always Sample: `0`
version_check_warning list / elements=string	Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex

Authors

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

fortinet.fortimanager.fmgr_application_list_entries module – Application list entries.

Synopsis

Parameters

Notes

Examples

Return Values