Note
This plugin is part of the fortinet.fortios collection (version 2.1.2).
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.fortios
.
To use it in a playbook, specify: fortinet.fortios.fortios_file_filter_profile
.
New in version 2.10: of fortinet.fortios
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments | |||
---|---|---|---|---|---|
access_token string | Token-based authentication. Generated from GUI of Fortigate. | ||||
enable_log boolean |
| Enable/Disable logging for task. | |||
file_filter_profile dictionary | Configure file-filter profiles. | ||||
comment string | Comment. | ||||
extended_log string |
| Enable/disable file-filter extended logging. | |||
feature_set string |
| Flow/proxy feature set. | |||
log string |
| Enable/disable file-filter logging. | |||
name string / required | Profile name. | ||||
replacemsg_group string | Replacement message group Source system.replacemsg-group.name. | ||||
rules list / elements=string | File filter rules. | ||||
action string |
| Action taken for matched file. | |||
comment string | Comment. | ||||
direction string |
| Traffic direction. (HTTP, FTP, SSH, CIFS only) | |||
file_type list / elements=string | Select file type. | ||||
name string / required | File type name. Source antivirus.filetype.name. | ||||
name string / required | File-filter rule name. | ||||
password_protected string |
| Match password-protected files. | |||
protocol list / elements=string |
| Protocols to apply rule to. | |||
scan_archive_contents string |
| Enable/disable archive contents scan. (Not for CIFS) | |||
state string / required |
| Indicates whether to create or remove the object. | |||
vdom string | Default: "root" | Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. |
Note
- hosts: fortigates collections: - fortinet.fortios connection: httpapi vars: vdom: "root" ansible_httpapi_use_ssl: yes ansible_httpapi_validate_certs: no ansible_httpapi_port: 443 tasks: - name: Configure file-filter profiles. fortios_file_filter_profile: vdom: "{{ vdom }}" state: "present" access_token: "<your_own_value>" file_filter_profile: comment: "Comment." extended_log: "disable" feature_set: "flow" log: "disable" name: "default_name_7" replacemsg_group: "<your_own_value> (source system.replacemsg-group.name)" rules: - action: "log-only" comment: "Comment." direction: "incoming" file_type: - name: "default_name_14 (source antivirus.filetype.name)" name: "default_name_15" password_protected: "yes" protocol: "http" scan_archive_contents: "disable"
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
build string | always | Build number of the fortigate image Sample: 1547 |
http_method string | always | Last method used to provision the content into FortiGate Sample: PUT |
http_status string | always | Last result given by FortiGate on last operation applied Sample: 200 |
mkey string | success | Master key (id) used in the last call to FortiGate Sample: id |
name string | always | Name of the table used to fulfill the request Sample: urlfilter |
path string | always | Path of the table used to fulfill the request Sample: webfilter |
revision string | always | Internal revision number Sample: 17.0.2.10658 |
serial string | always | Serial number of the unit Sample: FGVMEVYYQT3AB5352 |
status string | always | Indication of the operation's result Sample: success |
vdom string | always | Virtual domain used Sample: root |
version string | always | Version of the FortiGate Sample: v5.6.3 |
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_file_filter_profile_module.html