fortinet.fortimanager.fmgr_application_list – Configure application control lists.

Note

This plugin is part of the fortinet.fortimanager collection (version 2.1.4).

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

dictionary

the top level parameters set

app-replacemsg

string

Enable/disable replacement messages for blocked applications.

Choices:

  • disable

  • enable

comment

string

comments

control-default-network-services

string

Enable/disable enforcement of protocols over selected ports.

Choices:

  • disable

  • enable

deep-app-inspection

string

Enable/disable deep application inspection.

Choices:

  • disable

  • enable

default-network-services

list / elements=string

Default-Network-Services.

id

integer

Entry ID.

port

integer

Port number.

services

list / elements=string

Network protocols.

Choices:

  • http

  • ssh

  • telnet

  • ftp

  • dns

  • smtp

  • pop3

  • imap

  • snmp

  • nntp

  • https

violation-action

string

Action for protocols not white listed under selected port.

Choices:

  • block

  • monitor

  • pass

enforce-default-app-port

string

Enable/disable default application port enforcement for allowed applications.

Choices:

  • disable

  • enable

entries

list / elements=string

Entries.

action

string

Pass or block traffic, or reset connection for traffic from this application.

Choices:

  • pass

  • block

  • reset

application

integer

ID of allowed applications.

behavior

string

Application behavior filter.

category

string

Category ID list.

exclusion

integer

ID of excluded applications.

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

Parameters.

id

integer

Parameter ID.

members

list / elements=string

Members.

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

Application popularity filter (1 - 5, from least to most popular).

Choices:

  • 1

  • 2

  • 3

  • 4

  • 5

protocols

string

Application protocol filter.

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 …

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

Risk, or impact, of allowing traffic from this application to occur (1 - 5; Low, Elevated, Medium, High, and Critical).

session-ttl

integer

Session TTL (0 = default).

shaper

string

Traffic shaper.

shaper-reverse

string

Reverse traffic shaper.

sub-category

integer

Application Sub-category ID list.

technology

string

Application technology filter.

vendor

string

Application vendor filter.

extended-log

string

Enable/disable extended logging.

Choices:

  • disable

  • enable

force-inclusion-ssl-di-sigs

string

Enable/disable forced inclusion of SSL deep inspection signatures.

Choices:

  • disable

  • enable

name

string

List name.

options

list / elements=string

Basic application protocol signatures allowed by default.

Choices:

  • allow-dns

  • allow-icmp

  • allow-http

  • allow-ssl

  • allow-quic

other-application-action

string

Action for other applications.

Choices:

  • pass

  • block

other-application-log

string

Enable/disable logging for other applications.

Choices:

  • disable

  • enable

p2p-black-list

list / elements=string

P2P applications to be black listed.

Choices:

  • skype

  • edonkey

  • bittorrent

p2p-block-list

list / elements=string

P2P applications to be blocklisted.

Choices:

  • skype

  • edonkey

  • bittorrent

replacemsg-group

string

Replacement message group.

unknown-application-action

string

Pass or block traffic from unknown applications.

Choices:

  • pass

  • block

unknown-application-log

string

Enable/disable logging for unknown applications.

Choices:

  • disable

  • enable

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

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

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)