Skip to content

Latest commit

 

History

History
454 lines (410 loc) · 19.9 KB

fortios_file_filter_profile.rst

File metadata and controls

454 lines (410 loc) · 19.9 KB
Raw
source:fortios_file_filter_profile.py
orphan:

fortios_file_filter_profile -- Configure file-filter profiles in Fortinet's FortiOS and FortiGate.

.. versionadded:: 2.0.0

Synopsis

  • This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify file_filter feature and profile category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.14

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility


Supported Version Ranges
fortios_file_filter_profile v6.4.0 -> latest

Parameters

  • access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • vdom - 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. type: str default: root
  • member_path - Member attribute path to operate on. type: str
  • member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
  • state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
  • file_filter_profile - Configure file-filter profiles. type: dict more...
    Supported Version Ranges
    file_filter_profile v6.4.0 -> latest
    • comment - Comment. type: str more...
      Supported Version Ranges
      comment v6.4.0 -> latest
    • extended_log - Enable/disable file-filter extended logging. type: str choices: disable, enable more...
      Supported Version Ranges
      extended_log v6.4.0 -> v6.4.0 v6.4.4 -> latest
      [disable] v6.0.0 -> latest
      [enable] v6.0.0 -> latest
    • feature_set - Flow/proxy feature set. type: str choices: flow, proxy more...
      Supported Version Ranges
      feature_set v6.4.0 -> latest
      [flow] v6.0.0 -> latest
      [proxy] v6.0.0 -> latest
    • log - Enable/disable file-filter logging. type: str choices: disable, enable more...
      Supported Version Ranges
      log v6.4.0 -> latest
      [disable] v6.0.0 -> latest
      [enable] v6.0.0 -> latest
    • name - Profile name. type: str required: true more...
      Supported Version Ranges
      name v6.4.0 -> latest
    • replacemsg_group - Replacement message group. Source system.replacemsg-group.name. type: str more...
      Supported Version Ranges
      replacemsg_group v6.4.0 -> latest
    • rules - File filter rules. type: list member_path: rules:name more...
      Supported Version Ranges
      rules v6.4.0 -> latest
      • action - Action taken for matched file. type: str choices: log-only, block more...
        Supported Version Ranges
        action v6.4.0 -> latest
        [log-only] v6.0.0 -> latest
        [block] v6.0.0 -> latest
      • comment - Comment. type: str more...
        Supported Version Ranges
        comment v6.4.0 -> latest
      • direction - Traffic direction (HTTP, FTP, SSH, CIFS only). type: str choices: incoming, outgoing, any more...
        Supported Version Ranges
        direction v6.4.0 -> latest
        [incoming] v6.0.0 -> latest
        [outgoing] v6.0.0 -> latest
        [any] v6.0.0 -> latest
      • file_type - Select file type. type: list member_path: rules:name/file_type:name more...
        Supported Version Ranges
        file_type v6.4.0 -> latest
        • name - File type name. Source antivirus.filetype.name. type: str required: true more...
          Supported Version Ranges
          name v6.4.0 -> latest
      • name - File-filter rule name. type: str required: true more...
        Supported Version Ranges
        name v6.4.0 -> latest
      • password_protected - Match password-protected files. type: str choices: yes, any more...
        Supported Version Ranges
        password_protected v6.4.0 -> latest
        [yes] v6.0.0 -> latest
        [any] v6.0.0 -> latest
      • protocol - Protocols to apply rule to. type: list choices: http, ftp, smtp, imap, pop3, mapi, cifs, ssh more...
        Supported Version Ranges
        protocol v6.4.0 -> latest
        [http] v6.0.0 -> latest
        [ftp] v6.0.0 -> latest
        [smtp] v6.0.0 -> latest
        [imap] v6.0.0 -> latest
        [pop3] v6.0.0 -> latest
        [mapi] v6.0.0 -> latest
        [cifs] v6.0.0 -> latest
        [ssh] v6.0.0 -> latest
    • scan_archive_contents - Enable/disable archive contents scan. type: str choices: disable, enable more...
      Supported Version Ranges
      scan_archive_contents v6.4.0 -> latest
      [disable] v6.0.0 -> latest
      [enable] v6.0.0 -> latest

Notes

Note

  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- name: Configure file-filter profiles.
  fortinet.fortios.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"

Return Values

Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

  • build - Build number of the fortigate image returned: always type: str sample: 1547
  • http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
  • http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
  • mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
  • name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
  • path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
  • revision - Internal revision number returned: always type: str sample: 17.0.2.10658
  • serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
  • status - Indication of the operation's result returned: always type: str sample: success
  • vdom - Virtual domain used returned: always type: str sample: root
  • version - Version of the FortiGate returned: always type: str sample: v5.6.3

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@frankshen01)
  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.