fortinet.fortimanager.fmgr_application_list_entries module – Application list entries.

Note

This module is part of the fortinet.fortimanager collection (version 2.1.5).

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 version 2.10: of fortinet.fortimanager

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

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

integer

no description

behavior

string

no description

category

string

Category ID list.

exclusion

integer

no description

id

integer

Entry ID.

log

string

Enable/disable logging for this application list.

Choices:

  • disable

  • enable

log-packet

string

Enable/disable packet logging.

Choices:

  • disable

  • enable

parameters

list / elements=string

no description

id

integer

Parameter ID.

members

list / elements=string

no description

id

integer

Parameter.

name

string

Parameter name.

value

string

Parameter value.

value

string

Parameter value.

per-ip-shaper

string

Per-IP traffic shaper.

popularity

list / elements=string

no description

Choices:

  • 1

  • 2

  • 3

  • 4

  • 5

protocols

string

no description

quarantine

string

Quarantine method.

Choices:

  • none

  • attacker

quarantine-expiry

string

Duration of quarantine. (Format ###d##h##m, minimum 1m, maximum 364d23h59m, default = 5m). Requires quarantine set to attacker.

quarantine-log

string

Enable/disable quarantine logging.

Choices:

  • disable

  • enable

rate-count

integer

Count of the rate.

rate-duration

integer

Duration (sec) of the rate.

rate-mode

string

Rate limit mode.

Choices:

  • periodical

  • continuous

rate-track

string

Track the packet protocol field.

Choices:

  • none

  • src-ip

  • dest-ip

  • dhcp-client-mac

  • dns-domain

risk

integer

no description

session-ttl

integer

Session TTL (0 = default).

shaper

string

Traffic shaper.

shaper-reverse

string

Reverse traffic shaper.

sub-category

integer

no description

technology

string

no description

vendor

string

no description

bypass_validation

boolean

only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters

Choices:

  • no ← (default)

  • yes

enable_log

boolean

Enable/Disable logging for task

Choices:

  • no ← (default)

  • yes

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=string

the rc codes list with which the conditions to fail will be overriden

rc_succeeded

list / elements=string

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

  • 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: ''

Return Values

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

Key

Description

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_message

string

The descriptive message of the api response

Returned: always

Sample: “OK.”

Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)