fortios_firewall_profile_group – Configure profile groups in Fortinet’s FortiOS and FortiGate.

New in version 2.0.0.

Synopsis

  • This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and profile_group 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.15

Tips

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

FortiOS Version Compatibility

Supported Version Ranges: v6.0.0 -> 7.4.3

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
  • firewall_profile_group - Configure profile groups. type: dict more...
    • application_list - Name of an existing Application list. Source application.list.name. type: str more...
    • av_profile - Name of an existing Antivirus profile. Source antivirus.profile.name. type: str more...
    • casb_profile - Name of an existing CASB profile. Source casb.profile.name. type: str more...
    • cifs_profile - Name of an existing CIFS profile. Source cifs.profile.name. type: str more...
    • diameter_filter_profile - Name of an existing Diameter filter profile. Source diameter-filter.profile.name. type: str more...
    • dlp_profile - Name of an existing DLP profile. Source dlp.profile.name. type: str more...
    • dlp_sensor - Name of an existing DLP sensor. Source dlp.sensor.name. type: str more...
    • dnsfilter_profile - Name of an existing DNS filter profile. Source dnsfilter.profile.name. type: str more...
    • emailfilter_profile - Name of an existing email filter profile. Source emailfilter.profile.name. type: str more...
    • file_filter_profile - Name of an existing file-filter profile. Source file-filter.profile.name. type: str more...
    • icap_profile - Name of an existing ICAP profile. Source icap.profile.name. type: str more...
    • ips_sensor - Name of an existing IPS sensor. Source ips.sensor.name. type: str more...
    • ips_voip_filter - Name of an existing VoIP (ips) profile. Source voip.profile.name. type: str more...
    • mms_profile - Name of an existing MMS profile. Source firewall.mms-profile.name. type: str more...
    • name - Profile group name. type: str required: true more...
    • profile_protocol_options - Name of an existing Protocol options profile. Source firewall.profile-protocol-options.name. type: str more...
    • sctp_filter_profile - Name of an existing SCTP filter profile. Source sctp-filter.profile.name. type: str more...
    • spamfilter_profile - Name of an existing Spam filter profile. Source spamfilter.profile.name. type: str more...
    • ssh_filter_profile - Name of an existing SSH filter profile. Source ssh-filter.profile.name. type: str more...
    • ssl_ssh_profile - Name of an existing SSL SSH profile. Source firewall.ssl-ssh-profile.name. type: str more...
    • videofilter_profile - Name of an existing VideoFilter profile. Source videofilter.profile.name. type: str more...
    • virtual_patch_profile - Name of an existing virtual-patch profile. Source virtual-patch.profile.name. type: str more...
    • voip_profile - Name of an existing VoIP (voipd) profile. Source voip.profile.name. type: str more...
    • waf_profile - Name of an existing Web application firewall profile. Source waf.profile.name. type: str more...
    • webfilter_profile - Name of an existing Web filter profile. Source webfilter.profile.name. type: str more...

Notes

Note

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

Examples

- name: Configure profile groups.
  fortinet.fortios.fortios_firewall_profile_group:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      firewall_profile_group:
          application_list: "<your_own_value> (source application.list.name)"
          av_profile: "<your_own_value> (source antivirus.profile.name)"
          casb_profile: "<your_own_value> (source casb.profile.name)"
          cifs_profile: "<your_own_value> (source cifs.profile.name)"
          diameter_filter_profile: "<your_own_value> (source diameter-filter.profile.name)"
          dlp_profile: "<your_own_value> (source dlp.profile.name)"
          dlp_sensor: "<your_own_value> (source dlp.sensor.name)"
          dnsfilter_profile: "<your_own_value> (source dnsfilter.profile.name)"
          emailfilter_profile: "<your_own_value> (source emailfilter.profile.name)"
          file_filter_profile: "<your_own_value> (source file-filter.profile.name)"
          icap_profile: "<your_own_value> (source icap.profile.name)"
          ips_sensor: "<your_own_value> (source ips.sensor.name)"
          ips_voip_filter: "<your_own_value> (source voip.profile.name)"
          mms_profile: "<your_own_value> (source firewall.mms-profile.name)"
          name: "default_name_17"
          profile_protocol_options: "<your_own_value> (source firewall.profile-protocol-options.name)"
          sctp_filter_profile: "<your_own_value> (source sctp-filter.profile.name)"
          spamfilter_profile: "<your_own_value> (source spamfilter.profile.name)"
          ssh_filter_profile: "<your_own_value> (source ssh-filter.profile.name)"
          ssl_ssh_profile: "<your_own_value> (source firewall.ssl-ssh-profile.name)"
          videofilter_profile: "<your_own_value> (source videofilter.profile.name)"
          virtual_patch_profile: "<your_own_value> (source virtual-patch.profile.name)"
          voip_profile: "<your_own_value> (source voip.profile.name)"
          waf_profile: "<your_own_value> (source waf.profile.name)"
          webfilter_profile: "<your_own_value> (source webfilter.profile.name)"

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.