Try SpotterConfigure application control lists.
| "added in version" 1.0.0 of drmofu.fortimanager"
Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu)
preview | supported by community
Install with ansible-galaxy collection install drmofu.fortimanager:==2.2.2
collections:
- name: drmofu.fortimanager
version: 2.2.2This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
- 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'
adom:
description: the parameter (adom) in requested url
required: true
type: str
state:
choices:
- present
- absent
description: The directive to create, update or delete an object.
required: true
type: str
rc_failed:
description: The rc codes list with which the conditions to fail will be overriden.
elements: int
required: false
type: list
enable_log:
default: false
description: Enable/Disable logging for task.
required: false
type: bool
access_token:
description: The token to access FortiManager without using username and password.
required: false
type: str
rc_succeeded:
description: The rc codes list with which the conditions to succeed will be overriden.
elements: int
required: false
type: list
proposed_method:
choices:
- update
- set
- add
description: The overridden method for the underlying Json RPC request.
required: false
type: str
application_list:
description: the top level parameters set
required: false
suboptions:
app-replacemsg:
choices:
- disable
- enable
description: Enable/disable replacement messages for blocked applications.
type: str
comment:
description: comments
type: str
control-default-network-services:
choices:
- disable
- enable
description: Enable/disable enforcement of protocols over selected ports.
type: str
deep-app-inspection:
choices:
- disable
- enable
description: Enable/disable deep application inspection.
type: str
default-network-services:
description: Default-Network-Services.
elements: dict
suboptions:
id:
description: Entry ID.
type: int
port:
description: Port number.
type: int
services:
choices:
- http
- ssh
- telnet
- ftp
- dns
- smtp
- pop3
- imap
- snmp
- nntp
- https
description: Network protocols.
elements: str
type: list
violation-action:
choices:
- block
- monitor
- pass
description: Action for protocols not white listed under selected port.
type: str
type: list
enforce-default-app-port:
choices:
- disable
- enable
description: Enable/disable default application port enforcement for allowed applications.
type: str
entries:
description: Entries.
elements: dict
suboptions:
action:
choices:
- pass
- block
- reset
description: Pass or block traffic, or reset connection for traffic from this
application.
type: str
application:
description: ID of allowed applications.
type: int
behavior:
description: Application behavior filter.
type: str
category:
description: Category ID list.
type: str
exclusion:
description: ID of excluded applications.
type: int
id:
description: Entry ID.
type: int
log:
choices:
- disable
- enable
description: Enable/disable logging for this application list.
type: str
log-packet:
choices:
- disable
- enable
description: Enable/disable packet logging.
type: str
parameters:
description: Parameters.
elements: dict
suboptions:
id:
description: Parameter ID.
type: int
members:
description: Members.
elements: dict
suboptions:
id:
description: Parameter.
type: int
name:
description: Parameter name.
type: str
value:
description: Parameter value.
type: str
type: list
value:
description: Parameter value.
type: str
type: list
per-ip-shaper:
description: Per-IP traffic shaper.
type: str
popularity:
choices:
- '1'
- '2'
- '3'
- '4'
- '5'
description: Application popularity filter
elements: str
type: list
protocols:
description: Application protocol filter.
type: str
quarantine:
choices:
- none
- attacker
description: Quarantine method.
type: str
quarantine-expiry:
description: Duration of quarantine.
type: str
quarantine-log:
choices:
- disable
- enable
description: Enable/disable quarantine logging.
type: str
rate-count:
description: Count of the rate.
type: int
rate-duration:
description: Duration
type: int
rate-mode:
choices:
- periodical
- continuous
description: Rate limit mode.
type: str
rate-track:
choices:
- none
- src-ip
- dest-ip
- dhcp-client-mac
- dns-domain
description: Track the packet protocol field.
type: str
risk:
description: Risk, or impact, of allowing traffic from this application to
occur
type: int
session-ttl:
description: Session TTL
type: int
shaper:
description: Traffic shaper.
type: str
shaper-reverse:
description: Reverse traffic shaper.
type: str
sub-category:
description: Application Sub-category ID list.
type: int
tags:
description: Tag filter.
type: str
technology:
description: Application technology filter.
type: str
vendor:
description: Application vendor filter.
type: str
type: list
extended-log:
choices:
- disable
- enable
description: Enable/disable extended logging.
type: str
force-inclusion-ssl-di-sigs:
choices:
- disable
- enable
description: Enable/disable forced inclusion of SSL deep inspection signatures.
type: str
name:
description: List name.
type: str
options:
choices:
- allow-dns
- allow-icmp
- allow-http
- allow-ssl
- allow-quic
description: Basic application protocol signatures allowed by default.
elements: str
type: list
other-application-action:
choices:
- pass
- block
description: Action for other applications.
type: str
other-application-log:
choices:
- disable
- enable
description: Enable/disable logging for other applications.
type: str
p2p-black-list:
choices:
- skype
- edonkey
- bittorrent
description: P2P applications to be black listed.
elements: str
type: list
p2p-block-list:
choices:
- skype
- edonkey
- bittorrent
description: P2P applications to be blocklisted.
elements: str
type: list
replacemsg-group:
description: Replacement message group.
type: str
unknown-application-action:
choices:
- pass
- block
description: Pass or block traffic from unknown applications.
type: str
unknown-application-log:
choices:
- disable
- enable
description: Enable/disable logging for unknown applications.
type: str
type: dict
bypass_validation:
default: false
description: Only set to True when module schema diffs with FortiManager API structure,
module continues to execute without validating parameters.
required: false
type: bool
workspace_locking_adom:
description: The adom to lock for FortiManager running in workspace mode, the value
can be global and others including root.
required: false
type: str
forticloud_access_token:
description: Authenticate Ansible client with forticloud API access token.
required: false
type: str
workspace_locking_timeout:
default: 300
description: The maximum time in seconds to wait for other user to release the workspace
lock.
required: false
type: int
meta:
contains:
request_url:
description: The full url requested.
returned: always
sample: /sys/login/user
type: str
response_code:
description: The status of api request.
returned: always
sample: 0
type: int
response_data:
description: The api response.
returned: always
type: list
response_message:
description: The descriptive message of the api response.
returned: always
sample: OK.
type: str
system_information:
description: The information of the target system.
returned: always
type: dict
description: The result of the request.
returned: always
type: dict
rc:
description: The status the request.
returned: always
sample: 0
type: int
version_check_warning:
description: Warning if the parameters used in the playbook are not supported by
the current FortiManager version.
returned: complex
type: list