fortinet.fortimanager.fmgr_filefilter_profile – Configure file-filter profiles.

Note

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

To install it use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_filefilter_profile.

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 Choices/Defaults Comments
adom
string / required
the parameter (adom) in requested url
bypass_validation
boolean
    Choices:
  • no ←
  • yes
only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters
enable_log
boolean
    Choices:
  • no ←
  • yes
Enable/Disable logging for task
filefilter_profile
dictionary
the top level parameters set
comment
string
Comment.
extended-log
string
    Choices:
  • disable
  • enable
Enable/disable file-filter extended logging.
feature-set
string
    Choices:
  • proxy
  • flow
Flow/proxy feature set.
log
string
    Choices:
  • disable
  • enable
Enable/disable file-filter logging.
name
string
Profile name.
replacemsg-group
string
Replacement message group
rules
list / elements=string
no description
action
string
    Choices:
  • log-only
  • block
Action taken for matched file.
comment
string
Comment.
direction
string
    Choices:
  • any
  • incoming
  • outgoing
Traffic direction. (HTTP, FTP, SSH, CIFS only)
file-type
string
no description
name
string
File-filter rule name.
password-protected
string
    Choices:
  • any
  • yes
Match password-protected files.
protocol
list / elements=string
    Choices:
  • imap
  • smtp
  • pop3
  • http
  • ftp
  • mapi
  • cifs
  • ssh
no description
scan-archive-contents
string
    Choices:
  • disable
  • enable
Enable/disable archive contents scan. (Not for CIFS)
proposed_method
string
    Choices:
  • update
  • set
  • add
The overridden method for the underlying Json RPC request
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
    Choices:
  • present
  • absent
the directive to create, update or delete an object
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
Default:
300
the maximum time in seconds to wait for other user to release the workspace lock

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: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Configure file-filter profiles.
     fmgr_filefilter_profile:
        bypass_validation: False
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        rc_succeeded: [0, -2, -3, ...]
        rc_failed: [-2, -3, ...]
        adom: <your own value>
        state: <value in [present, absent]>
        filefilter_profile:
           comment: <value of string>
           extended-log: <value in [disable, enable]>
           feature-set: <value in [proxy, flow]>
           log: <value in [disable, enable]>
           name: <value of string>
           replacemsg-group: <value of string>
           rules:
             -
                 action: <value in [log-only, block]>
                 comment: <value of string>
                 direction: <value in [any, incoming, outgoing]>
                 file-type: <value of string>
                 name: <value of string>
                 password-protected: <value in [any, yes]>
                 protocol:
                   - imap
                   - smtp
                   - pop3
                   - http
                   - ftp
                   - mapi
                   - cifs
                   - ssh
           scan-archive-contents: <value in [disable, enable]>

Return Values

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

Key Returned Description
request_url
string
always
The full url requested

Sample:
/sys/login/user
response_code
integer
always
The status of api request

response_message
string
always
The descriptive message of the api response

Sample:
OK.


Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)